Sign in

v1

latestOpenAPI 3.1.0MIT-LICENSE2026-07-24113190543.3 KB
Payout Orders

Create payout order

Create a new payout order.

post/payout_orders

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

Request body

allowed_payout_methodsstring[] required

The payout methods that are allowed for the payout order.

amountinteger required

The amount of the payout order.

currencystring required

The currency in which the payout order is made.

expires_atinteger required

The expiration time of the payout order in Unix timestamp.

metadataobject

The metadata of the payout order.

reasonstring required

The reason for the payout order.

Example request

{
  "allowed_payout_methods": [
    "cashout"
  ],
  "amount": 100,
  "currency": "MXN",
  "customer_info": {
    "customer_id": "cus_23874283647"
  },
  "expires_at": 1700000000,
  "metadata": {
    "custom_client_id": "12345"
  },
  "payout": {
    "payout_method": {
      "type": "cashout"
    }
  },
  "reason": "Payout order for the customer"
}

Response

successful operation