COconekta
Payout Orders

Create payout order

Create a new payout order.

post/payout_orders

Request

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

allowed_payout_methodsstring[] required

The payout methods that are allowed for the payout order.

amountinteger required

The amount of the payout order.

created_atinteger required

The creation date of the payout order.

currencystring required

The currency in which the payout order is made.

expires_atinteger required

The expiration date of the payout order.

idstring required

The id of the payout order.

livemodeboolean required

The live mode of the payout order.

objectstring required

The object of the payout order.

metadataobject

The metadata of the payout order.

reasonstring required

The reason for the payout order.

statusstring required

The status of the payout order.

updated_atinteger required

The update date of the payout order.

Example response

{
  "allowed_payout_methods": [
    "cashout"
  ],
  "amount": 100,
  "created_at": 1677626837,
  "currency": "MXN",
  "customer_info": {
    "id": "cus_23874283647",
    "customer_custom_reference": "custom_reference",
    "name": "DevTest",
    "email": "test@conekta.com",
    "phone": "5522997233",
    "object": "customer_info"
  },
  "expires_at": 1677626837,
  "id": "f2654d66-d740-457a-9a8c-f96b5196f44e",
  "livemode": true,
  "object": "payout_order",
  "metadata": {
    "custom_client_id": "12345"
  },
  "payouts": [
    {
      "amount": 3000,
      "currency": "MXN",
      "expires_at": 1677626837,
      "id": "payout_2vZwsRAhhGp2dFDJx",
      "livemode": true,
      "object": "payout",
      "payout_order_id": "f2654d66-d740-457a-9a8c-f96b5196f44e",
      "status": "open"
    }
  ],
  "reason": "Payout order for the customer",
  "status": "open",
  "updated_at": 1677626837
}

Changes

No recorded changes to this operation across all 2 revisions of this API.