Get all payouts

GET

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

Show child attributes

data.id

string

required

Payout ID

Example:

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

data.amount

number

required

Payout amount

Example:

100000

data.currency

string

required

Payout currency

Example:

"COP"

data.status

string

required

Payout status

Example:

"PENDING"

data.rail

string

required

Payout rail

Example:

"BRE_B"

data.createdAt

string<date-time>

required

Payout created at

Example:

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

data.updatedAt

string<date-time>

required

Payout updated at

Example:

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

data.organizationId

string

required

Payout organization ID

Example:

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

data.targetData

object

required

Payout target data

Example:

{ "breb": { "keyString": "@ABCED1223" } }

data.reference

object

Payout reference

Example:

"OUT-2024-001"

data.inlineCustomer

object

Payout inline customer

Show child attributes

data.inlineCustomer.name

string

required

Customer full name

Example:

"John Doe"

data.inlineCustomer.idType

enum<string>

required

Type of identification document

Available options:

CO_CC,

MXN_RFC,

PASSPORT

Example:

"CO_CC"

data.inlineCustomer.idNumber

string

required

Identification document number

Example:

"1234567890"

data.inlineCustomer.phone

string

required

Customer phone number

Example:

"+573001234567"

data.inlineCustomer.email

string

required

Customer email address

Example:

"john.doe@example.com"

data.errorCode

object

Payout error code

Example:

null

data.resultAt

object

Payout result at

Example:

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

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 payoutCreates a new payment in transaction.

⌘I

{
  "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
  }
}

Getting Started

Guides

API reference

Query Parameters

Response