List a merchant’s payout instruments
Returns a merchant’s payout instruments, newest first; the result is a small bounded set and is not paginated. Requires merchant:financing.bank_details:read on the merchant; an organization-scoped role can grant that same permission across every merchant it manages. An impersonated caller sees the account number and account holder name masked.
Authorization
oauth2 Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.
In: header
Path Parameters
Canonical sales-app merchant id, shared with Core. Legacy ids remain readable.
1 <= length <= 255Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/financing/merchants/01JZQ5W7M5Y83M6F1D6E0A2K8N/bank-details"[ { "type": "PAY_BILL", "paybill_number": "247247", "account_number": "INV-2026-0001", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_verified": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }]{ "code": "INVALID_PARAMS", "description": "user_id must be a UUID", "identifier": "string", "invalid_params": [ { "path": "user_id", "reason": "must be a UUID", "sub_code": "string" } ]}{ "code": "INVALID_PARAMS", "description": "user_id must be a UUID", "identifier": "string", "invalid_params": [ { "path": "user_id", "reason": "must be a UUID", "sub_code": "string" } ]}{ "code": "INVALID_PARAMS", "description": "user_id must be a UUID", "identifier": "string", "invalid_params": [ { "path": "user_id", "reason": "must be a UUID", "sub_code": "string" } ]}{ "code": "INVALID_PARAMS", "description": "user_id must be a UUID", "identifier": "string", "invalid_params": [ { "path": "user_id", "reason": "must be a UUID", "sub_code": "string" } ]}{ "code": "INVALID_PARAMS", "description": "user_id must be a UUID", "identifier": "string", "invalid_params": [ { "path": "user_id", "reason": "must be a UUID", "sub_code": "string" } ]}{ "code": "INVALID_PARAMS", "description": "user_id must be a UUID", "identifier": "string", "invalid_params": [ { "path": "user_id", "reason": "must be a UUID", "sub_code": "string" } ]}Create a supplier merchant in sales-app POST
Deprecated: use POST /v1/merchants with business_name, email and phone_number. Creates public.merchants with a database-generated id. Requires org:merchants:write on the caller’s organization. Organization scope comes only from the bearer token. Reuse idempotency_key with identical details to recover the same id after a timeout or a downstream failure. A changed payload returns 409. Core must mirror the returned id before payout registration and invitation; this operation does not create a Core merchant or a WorkOS grant.
Register a merchant payout instrument POST
Creates an unverified payout instrument. Requires the dedicated merchant:financing.bank_details:write permission, distinct from invoice/document writes.