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",
"taxCollectionMode": "collect_immediately"
}
]
}
'{
"data": {
"success": true,
"recipients": [
{
"taxCollectionMode": "collect_immediately",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"nickname": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"onboardingUrl": "<string>",
"profile": {
"firstName": "Jordan",
"lastName": "Lee",
"fullName": "Jordan Lee",
"businessName": "Jordan Lee Media LLC",
"businessType": "entity",
"dba": "Jordan Lee Media",
"permanentAddress": {
"line1": "123 Main St",
"line2": "Suite 400",
"city": "Los Angeles",
"state": "CA",
"postalCode": "90001",
"country": "US"
},
"mailingAddress": null
},
"status": "created",
"earnings": {
"paid": 125000,
"pending": 15000,
"held": 5000
},
"paymentMethod": {
"method": "ACH",
"currency": "USD"
}
}
]
}
}{
"error": {
"message": "amount: amount must be positive"
}
}{
"error": {
"message": "Invalid api key"
}
}Add recipients
Creates or re-adds recipients in your organization by normalized email. Each recipient receives an onboarding URL. Set taxCollectionMode to collect_immediately, collect_at_600, or do_not_collect. When no tax collection settings are supplied, collect_immediately is saved. Re-adding applies the same creation defaults. Include the desired mode when re-adding a recipient to retain it. The entire array is validated before any recipient writes.
POST
/
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",
"taxCollectionMode": "collect_immediately"
}
]
}
'{
"data": {
"success": true,
"recipients": [
{
"taxCollectionMode": "collect_immediately",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"nickname": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"onboardingUrl": "<string>",
"profile": {
"firstName": "Jordan",
"lastName": "Lee",
"fullName": "Jordan Lee",
"businessName": "Jordan Lee Media LLC",
"businessType": "entity",
"dba": "Jordan Lee Media",
"permanentAddress": {
"line1": "123 Main St",
"line2": "Suite 400",
"city": "Los Angeles",
"state": "CA",
"postalCode": "90001",
"country": "US"
},
"mailingAddress": null
},
"status": "created",
"earnings": {
"paid": 125000,
"pending": 15000,
"held": 5000
},
"paymentMethod": {
"method": "ACH",
"currency": "USD"
}
}
]
}
}{
"error": {
"message": "amount: amount must be positive"
}
}{
"error": {
"message": "Invalid api key"
}
}