Create a recipient (merchant-scoped)

Create a recipient (payee) for a merchant.

Don't send merchant_id or tenant_id in the body. They are always set from your credentials, and any values you send are ignored.

Merchant users work on their own merchant's recipients. Tenant owners and admins can work on any merchant in their tenant by passing ?merchantId=. A merchant in another tenant returns 404. Other roles are refused.

Authenticate with a dashboard session token, or a merchant-pinned secret key in X-API-Key. A secret key acts only for its own merchant: anything it creates belongs to that merchant and records the key as the actor, and another merchant's recipients return 404. Publishable, payout_write and agent_onboarding keys are refused.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

Tenant admin/owner override — target merchant within the caller's tenant (UUID). Required for tenant_admin/tenant_owner; ignored for role merchant (scope comes from JWT).

Body Params
string
required
length between 1 and 255
string | null
string | null
string | null

ISO 3166-1 alpha-2 (e.g. US).

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json