Skip to main content
POST

Authorizations

Authorization
string
header
required

User API authentication token with format cash_<64-char-hex>. Sample value cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.

Body

application/json

Outbound COP payout. Omit destinationType or send bank for Fast Pay / ACH. Bank requires accountType, bankCode, accountNumber (max 20), beneficiaryFullName, documentType, and documentNumber. The bank must support Fast Pay or ACH and the chosen account type. breb_key requires keyValue, beneficiaryFullName, documentType, and documentNumber. Do not send bank fields. breb_qr requires qrValue (EMV or base64). Beneficiary and document are optional. If the QR encodes a fixed amount, amount must match or the API returns 400 with code: BREB_QR_AMOUNT_MISMATCH.

accountId
string<uuid>
required
Example:

"YOUR_ACCOUNT_UUID"

amount
required

Positive amount. String values allow at most 2 decimal places.

Required range: x > 0
destinationType
enum<string>

Defaults to bank when omitted

Available options:
bank,
breb_key,
breb_qr
accountType
enum<string>

Required for bank. cc checking, ch savings, dp electronic deposit.

Available options:
cc,
ch,
dp
bankCode
string

Required for bank. 4-digit code from GET /co/banks.

Pattern: ^\d{4}$
accountNumber
string

Required for bank

Maximum string length: 20
beneficiaryFullName
string

Required for bank and Bre-B key. Optional for Bre-B QR.

documentType
enum<string>

cc Citizenship ID, nit NIT, ce Foreign ID, pa Passport, ppt PPT, ti Identity card, rc Birth certificate, te Foreign card, die Foreign identification document, nd No document (Nequi). Most numbers are digits only. Passport (pa) and PPT (ppt) are alphanumeric. nd is bank-only, only for bank code 1507. documentNumber must be ND, and phone (E.164) is required. nd is rejected on Bre-B.

Available options:
cc,
nit,
ce,
pa,
ppt,
ti,
rc,
te,
die,
nd
documentNumber
string
keyValue
string

Required for breb_key

qrValue
string

Required for breb_qr. EMV or base64 payload.

phone
string

Optional E.164 phone. Required when documentType is nd.

Example:

"+570000000000"

email
string<email>
Example:

"payer@example.com"

description
string
Maximum string length: 40
webhookUrl
string<uri>

Response

Payout accepted

id
string<uuid>
required
status
enum<string>
required
Available options:
processing