Get all payins

GET

payins

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 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

Show child attributes

data.id

string

required

Payin ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.amount

number

required

Payin amount

Example:

100000

data.currency

string

required

Payin currency

Example:

"COP"

data.status

string

required

Payin status

Example:

"PENDING"

data.rail

string

required

Payin rail

Example:

"BRE_B"

data.reference

string

required

Payin reference

Example:

"INV-2024-001"

data.createdAt

string<date-time>

required

Payin created at

Example:

"2024-01-01T00:00:00.000Z"

data.updatedAt

string<date-time>

required

Payin updated at

Example:

"2024-01-01T00:00:00.000Z"

data.organizationId

string

required

Payin organization ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.inlineCustomer

object

Payin inline customer

Example:

"John Doe"

data.errorCode

object

Payin error code

Example:

null

data.resultAt

object

Payin result at

Example:

"2024-01-01T00:00:00.000Z"

data.chargebackAt

object

Payin chargeback at

Example:

"2024-01-01T00:00:00.000Z"

data.sourceData

object

Payin pse response

Show child attributes

data.sourceData.keyString

string

required

BREB payment key string

Example:

"breb-key-string"

data.callbackUrl

object

Payin callback URL

Example:

"https://example.com/callback"

pagination

object

required

Pagination metadata

Show child attributes

pagination.page

number

required

Current page number

Example:

1

pagination.limit

number

required

Number of items per page

Example:

10

pagination.total

number

required

Total number of items

Example:

100

pagination.totalPages

number

required

Total number of pages

Example:

10

pagination.hasNext

boolean

required

Whether there is a next page

Example:

true

pagination.hasPrev

boolean

required

Whether there is a previous page

Example:

false

Create a new payinCreates a new payin request.

⌘I

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 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
  }
}

Getting Started

Guides

API reference

Query Parameters

Response