POST
/
v2
/
payout-requests
Authorization
Body
curl --request POST \
  --url https://api.senddotssandbox.com/api/v2/payout-requests \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 0
}'
{
  "amount": "number",
  "created": "string",
  "id": "string",
  "memo": "string",
  "metadata": [
    "string",
    "object",
    "null"
  ],
  "payee": {
    "country_code": "string",
    "phone_number": "string"
  },
  "payout-link": {
    "amount": "number",
    "claimed_user_id": "string",
    "created": "string",
    "delivery": {
      "country_code": "string",
      "email": "string",
      "method": "link",
      "phone_number": "string"
    },
    "flow_id": "string",
    "id": "string",
    "link": "string",
    "metadata": [
      "string",
      "object",
      "null"
    ],
    "payee": {
      "country_code": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string"
    },
    "status": "sent",
    "tax_exempt": "boolean"
  },
  "status": "created",
  "user": {
    "compliance": {
      "1099_collected": "boolean",
      "address_collected": "boolean",
      "date_of_birth_collected": "boolean",
      "flagged": "boolean",
      "id_verified": "boolean",
      "must_collect_1099": "boolean",
      "tax_id_collected": "boolean",
      "w8_ben_collected": "boolean"
    },
    "email": "string",
    "first_name": "string",
    "id": "string",
    "last_name": "string",
    "metadata": [
      "string",
      "object",
      "null"
    ],
    "phone_number": {
      "country_code": "string",
      "phone_number": "string"
    },
    "wallet": {
      "amount": "integer",
      "credit_balance": "integer",
      "withdrawable_amount": "integer"
    }
  }
}

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
amountrequired
integer

The amount in cents to pay the user.

memo
string

Add a memo to payout request

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.

payee
object

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

user_id
string

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

Response

201 - application/json
amount
number

Amount in cents of the payout-request.

created
string

Date that the payout-request was created.

id
string

ID of the payout-request.

memo
string
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.

payee
object
payout-link
object

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

status
enum<string>

Status of the payout-request.

Available options:
created,
approved,
rejected
user
object

The user that requested the payout.