Skip to main content
GET
/
payouts
/
{id}
{
  "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"
}

Path Parameters

​
id
string
required

The unique identifier of the payout

Response

Payout found

​
id
string
required

Payout ID

Example:

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

​
amount
number
required

Payout amount

Example:

100000

​
currency
string
required

Payout currency

Example:

"COP"

​
status
string
required

Payout status

Example:

"PENDING"

​
rail
string
required

Payout rail

Example:

"BRE_B"

​
createdAt
string<date-time>
required

Payout created at

Example:

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

​
updatedAt
string<date-time>
required

Payout updated at

Example:

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

​
organizationId
string
required

Payout organization ID

Example:

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

​
targetData
object
required

Payout target data

Example:
{ "breb": { "keyString": "@ABCED1223" } }
​
reference
object

Payout reference

Example:

"OUT-2024-001"

​
inlineCustomer
object

Payout inline customer

​
errorCode
object

Payout error code

Example:

null

​
resultAt
object

Payout result at

Example:

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