Skip to main content
GET
/
payins
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"
    }
  ],
  "pageInfo": {
    "hasNext": true,
    "hasPrevious": false,
    "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTAzLTEzVDEyOjAwOjAwLjAwMFoiLCJpZCI6IjEyM2U0NTY3LWU4OWItMTJkMy1hNDU2LTQyNjYxNDE3NDAwMCJ9",
    "previousCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTAzLTEzVDEyOjAwOjAwLjAwMFoiLCJpZCI6IjEyM2U0NTY3LWU4OWItMTJkMy1hNDU2LTQyNjYxNDE3NDAwMCJ9"
  }
}

Query Parameters

cursor
string

Opaque cursor for the target page

Example:

"eyJjcmVhdGVkQXQiOiIyMDI2LTAzLTEzVDEyOjAwOjAwLjAwMFoiLCJpZCI6IjEyM2U0NTY3LWU4OWItMTJkMy1hNDU2LTQyNjYxNDE3NDAwMCJ9"

pageSize
number
default:10

Number of items per page

Required range: 1 <= x <= 100
Example:

10

Response

List of payins with cursor pagination

data
object[]
required

List of payins

pageInfo
object
required

Cursor pagination metadata