Sign in

v1

latestOpenAPI 3.1.02026-07-2479154362.5 KB
payout

List payout

get/payout/transfer

Query parameters

external_idstring

The external id of the payout equal to

external_provider_idstring

The external provider id of the payout equal to

timestampstring date-time

The timestamp of the payout equal to

timestamp_fromstring date-time

The timestamp of the payout greater than or equal to

timestamp_tostring date-time

The timestamp of the payout less than or equal to

amountnumber double

String encoded decimal number

Example:10

The amount of the payout equal to

amount_minnumber double

String encoded decimal number

Example:10

The amount of the payout greater than or equal to

amount_maxnumber double

String encoded decimal number

Example:10

The amount of the payout less than or equal to

state'created' | 'initiated' | 'pending' | 'failed' | 'settled' | 'cancelled'

The current state of the payout equal to

currencystring

ISO-4217 currency code

Example:MXN

The currency of the payout equal to

origin_financial_institutionstring

The origin financial institution code of the payout equal to

origin_accountstring

The origin account number of the payout equal to

customer_accountstring

The customer account number of the payout equal to

namestring

The customer name of the payout equal to

customer_tax_idstring

The customer tax id of the payout equal to

ordering'timestamp' | 'amount' | 'fee'

Order by

pageinteger

Page

Response

Payout listed

countinteger

The number of payout listed

nextstring uri

The next page of listed payout

previousstring uri

The previous page of listed payout

Example response

{
  "count": 123,
  "next": "http://api.example.org/payout/transfer/?page=4",
  "previous": "http://api.example.org/payout/transfer/?page=2",
  "results": [
    {
      "id": "4d6c83e6-44ce-4963-ac83-e644ced9631c",
      "origin": "f3676011-5203-43db-a760-115203e3db5e",
      "description": "Test Payout",
      "external_id": "e5af7e6e-98f4-4e43-af7e-6e98f42e43ef",
      "amount": 10,
      "fee": 10,
      "total_amount": 10,
      "reference": "XBVTIQ3CQNN1ETFPG79TCC5IYA",
      "timestamp": "2024-09-30T18:00:58.087Z",
      "customer": {
        "name": "Jane Doe",
        "tax_id_type": "rfc",
        "tax_id": "DODJ2301016J3",
        "external_id": "SOME_PREFIX:SOME_UNIQUE_ID",
        "withdrawal_account": {
          "id": "9c1dd10e-7c19-470d-9dd1-0e7c19670d64",
          "account_format": "clabe",
          "account_number": "012180826854179156",
          "description": "Account",
          "branch": "0",
          "bank": {
            "code": "012",
            "bicfi": "BBVAMXMMXXX",
            "name": "BBVA",
            "country": "MX"
          }
        }
      },
      "events": [
        {
          "state": "created",
          "timestamp": "2024-09-30T18:00:58.087Z",
          "message": "Payin created"
        }
      ]
    }
  ]
}