Skip to main content
POST
Create a new payout

Body

application/json
amountInCents
number
required

Payment amount in cents

Required range: x >= 1
Example:

100000

currency
string
required

Payment currency

Example:

"COP"

rail
string
required

Payment rail type

Example:

"TRANSFIYA"

reference
string
required

Unique reference for the payout

Example:

"OUT-2024-001"

inlineCustomer
object

Customer data

breb
object

Bre-B key details (required when type is BRE_B)

transfiya
object

Transfiya key details (required when type is TRANSFIYA)

Response

Payout successfully created

id
string
required

Payout ID

Example:

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

amount
number
required

Payout amount

Example:

100000

amountInCents
number
required

Payout amount in cents

Example:

10000000

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:
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"