Skip to main content
POST
/
payout
/
recipients
Create a beneficiary
curl --request POST \
  --url http://localhost:4000/v1/payout/recipients \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Amazon",
  "account_owner_type": "business",
  "address": {
    "street_line_1": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "US"
  },
  "email": "payments@amazon.com"
}
'

Body

application/json
​
name
string
required

Beneficiary name (person or company)

Example:

"Amazon"

​
account_owner_type
enum<string>
required

Account owner type

Available options:
individual,
business
Example:

"business"

​
address
object
required

Beneficiary address

​
email
string

Beneficiary email

Example:

"payments@amazon.com"

Response

201

Beneficiary created