Payouts
Send a payout
POST
/
api
/
v2
/
payouts
/
send_payout
Authorization
Body
{
"amount": 0,
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"payee": {
"country_code": "string",
"phone_number": "string"
},
"delivery": {
"message": "string"
},
"notes": null,
"force_collect_compliance_information": true
}
Authorizations
Authorizationheaderrequired
string
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
application/json
Option 1
Option 2
amountrequired
number
delivery
object
force_collect_compliance_information
boolean
Require the recipient to fill out compliance information (i.e. form 1099) when below the payout limit.
notes
any
Custom data that will be attached to the transaction when the recipient claims the link.
payee
object
user_idrequired
string
Response
200
{
"amount": 0,
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"payee": {
"country_code": "string",
"phone_number": "string"
},
"delivery": {
"message": "string"
},
"notes": null,
"force_collect_compliance_information": true
}