Skip to main content
Get all payouts
curl --request GET \
  --url https://api.example.com/payouts
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 100000,
      "currency": "COP",
      "status": "PENDING",
      "rail": "BRE_B",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "targetData": {
        "breb": {
          "keyString": "@ABCED1223"
        }
      },
      "reference": "OUT-2024-001",
      "inlineCustomer": {
        "name": "John Doe",
        "idType": "CO_CC",
        "idNumber": "1234567890",
        "phone": "+573001234567",
        "email": "john.doe@example.com"
      },
      "errorCode": null,
      "resultAt": "2024-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "totalPages": 10,
    "hasNext": true,
    "hasPrev": false
  }
}

Query Parameters

​
page
number
default:1

Page number for pagination

Required range: x >= 1
Example:

1

​
limit
number
default:10

Number of items per page

Required range: x >= 1
Example:

10

​
total
number
default:100

Total number of items

Required range: x >= 1
Example:

100

​
totalPages
number
default:10

Total number of pages

Required range: x >= 1
Example:

10

​
hasNext
boolean
default:true

Whether there is a next page

Example:

true

​
hasPrev
boolean
default:false

Whether there is a previous page

Example:

false

Response

List of payouts with pagination

​
data
object[]
required

List of payouts

​
pagination
object
required

Pagination metadata