Skip to main content
Get all payins
curl --request GET \
  --url https://api.example.com/payins
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 100000,
      "confirmedAmount": 100000,
      "currency": "COP",
      "status": "PENDING",
      "rail": "BRE_B",
      "reference": "INV-2024-001",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "inlineCustomer": "John Doe",
      "errorCode": null,
      "resultAt": "2024-01-01T00:00:00.000Z",
      "chargebackAt": "2024-01-01T00:00:00.000Z",
      "sourceData": {
        "keyString": "breb-key-string"
      },
      "callbackUrl": "https://example.com/callback"
    }
  ],
  "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 payins with pagination

​
data
object[]
required

List of payins

​
pagination
object
required

Pagination metadata