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

Show child attributes

inlineCustomer.name

string

required

Customer full name

Example:

"John Doe"

inlineCustomer.idType

enum<string>

required

Type of identification document

Available options:

CO_CC,

MXN_RFC,

PASSPORT

Example:

"CO_CC"

inlineCustomer.idNumber

string

required

Identification document number

Example:

"1234567890"

inlineCustomer.phone

string

required

Customer phone number

Example:

"+573001234567"

inlineCustomer.email

string

required

Customer email address

Example:

"john.doe@example.com"

breb

object

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

Show child attributes

breb.keyString

string

required

BREB payment key string

Example:

"breb-key-string"

transfiya

object

Transfiya key details (required when type is TRANSFIYA)

Show child attributes

transfiya.keyString

string

required

Transfiya payment key string

Example:

"transfiya-key-string"

transfiya.account

object

required

Transfiya account details

Show child attributes

transfiya.account.bank

string

required

Bank code (it should be supported by Transfiya)

Example:

"CO_BANCOLOMBIA"

transfiya.account.bankAccountNumber

string

required

Bank account number

Example:

"1234567890"

transfiya.account.customerDocumentNumber

string

required

Customer document number

Example:

"1234567890"

Example:

"transfiya-key-string"

Response

Payout successfully created

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

Show child attributes

inlineCustomer.name

string

required

Customer full name

Example:

"John Doe"

inlineCustomer.idType

enum<string>

required

Type of identification document

Available options:

CO_CC,

MXN_RFC,

PASSPORT

Example:

"CO_CC"

inlineCustomer.idNumber

string

required

Identification document number

Example:

"1234567890"

inlineCustomer.phone

string

required

Customer phone number

Example:

"+573001234567"

inlineCustomer.email

string

required

Customer email address

Example:

"john.doe@example.com"

errorCode

object

Payout error code

Example:

null

resultAt

object

Payout result at

Example:

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

Getting Started

Guides

API reference

Body

Response