Create a Payout Request
Submit a payout request from a person when you know their phone number or user id. Once the payout request is approved, they will be sent a Payout Link to onboard and recieve funds.
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
The amount in cents to pay the user.
x > 0
The user's id. user_id
or payee
is required.
The payee's phone number. user_id
or payee
is required.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Add a memo to payout request
Response
The payout-request
id.
ID of the payout-request
.
Date that the payout-request
was created.
Amount in cents of the payout-request
.
Status of the payout-request
.
created
, approved
, rejected
The payout-link
that was sent when the payout-request
was approved.
The user
that requested the payout.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.