Skip to main content
POST
/
recipients
Add recipients
curl --request POST \
  --url https://payouts.api.trykarat.com/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipients": [
    {
      "firstName": "Jordan",
      "lastName": "Lee",
      "email": "jordan@example.com",
      "nickname": "Jordan (design)",
      "shouldCollectTaxInfo": true
    }
  ]
}
'
{
  "data": {
    "success": true,
    "recipients": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com",
        "nickname": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "onboardingUrl": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Pass your API key as a bearer token: Authorization: Bearer <API_KEY>.

Body

application/json
recipients
object[]
required
Minimum array length: 1

Response

The recipients were created.

data
object