Skip to main content
POST
/
vendor
/
payout-account
/
onboarding
Create Onboarding
curl --request POST \
  --url https://api.example.com/vendor/payout-account/onboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "context": {}
}'
{
  "payout_account": {
    "id": "<string>",
    "status": "pending",
    "reference_id": "<string>",
    "data": {},
    "context": {},
    "onboarding": {
      "id": "<string>",
      "data": {},
      "context": {},
      "payout_account": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "payouts": [
      {
        "id": "<string>",
        "currency_code": "<string>",
        "amount": 123,
        "data": {},
        "payout_account": "<unknown>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
context
object

Additional data needed by the payment provider to create onboarding.

Response

200 - application/json

OK

​
payout_account
Payout Account · object

A payout account object with its properties