COconekta
Payout Orders

Get a list of Payout Orders

Get Payout order details in the form of a list

get/payout_orders

Request

Query parameters

limitinteger

The numbers of items to return, the maximum value is 250

searchstring

General order search, e.g. by mail, reference etc.

nextstring

next page

previousstring

previous page

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

Response

successful operation

has_moreboolean required

Indicates if there are more pages to be requested

objectstring required

Object type, in this case is list

next_page_urlstring nullable

URL of the next page.

previous_page_urlstring nullable

Url of the previous page.

Example response

{
  "data": [
    {
      "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
    }
  ],
  "object": "list",
  "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
  "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1"
}

Changes

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