Authorizations

Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
amount
integer
required

The amount in cents to pay the user.

Required range: x > 0
user_id
string

The user's id. user_id or payee is required.

payee
object

The payee's phone number. user_id or payee is required.

metadata

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.

memo
string

Add a memo to payout request

Response

201 - application/json

The payout-request id.

id
string

ID of the payout-request.

created
string

Date that the payout-request was created.

amount
number

Amount in cents of the payout-request.

status
enum<string>

Status of the payout-request.

Available options:
created,
approved,
rejected
payee
object
payout-link
object

The payout-link that was sent when the payout-request was approved.

user
object

The user that requested the payout.

metadata

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.

memo
string