Skip to main content
POST

Autorizaciones

Authorization
string
header
requerido

Token de autenticación de API de usuario con formato cash_<64-char-hex>. Valor de ejemplo cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.

Cuerpo

application/json

Payout saliente en COP. Omita destinationType o envíe bank para Fast Pay / ACH. Banco exige accountType, bankCode, accountNumber (máx. 20), beneficiaryFullName, documentType y documentNumber. El banco debe admitir Fast Pay o ACH y el tipo de cuenta elegido. breb_key exige keyValue, beneficiaryFullName, documentType y documentNumber. No envíe campos bancarios. breb_qr exige qrValue (EMV o base64). Beneficiario y documento son opcionales. Si el QR trae un monto fijo, amount debe coincidir o la API responde 400 con code: BREB_QR_AMOUNT_MISMATCH.

accountId
string<uuid>
requerido
Ejemplo:

"YOUR_ACCOUNT_UUID"

amount
requerido

Monto positivo. Los valores string admiten como máximo 2 decimales.

Rango requerido: x > 0
destinationType
enum<string>

Si se omite, el valor es bank

Opciones disponibles:
bank,
breb_key,
breb_qr
accountType
enum<string>

Obligatorio para banco. cc corriente, ch ahorros, dp depósito electrónico.

Opciones disponibles:
cc,
ch,
dp
bankCode
string

Obligatorio para banco. Código de 4 dígitos de GET /co/banks.

Pattern: ^\d{4}$
accountNumber
string

Obligatorio para banco

Maximum string length: 20
beneficiaryFullName
string

Obligatorio para banco y llave Bre-B. Opcional para QR Bre-B.

documentType
enum<string>

cc cédula de ciudadanía, nit NIT, ce cédula de extranjería, pa pasaporte, ppt PPT, ti tarjeta de identidad, rc registro civil, te tarjeta de extranjería, die documento de identificación extranjero, nd sin documento (Nequi). La mayoría de los números son solo dígitos. Pasaporte (pa) y PPT (ppt) son alfanuméricos. nd es solo bancario y solo para el código de banco 1507. documentNumber debe ser ND y phone (E.164) es obligatorio. nd se rechaza en Bre-B.

Opciones disponibles:
cc,
nit,
ce,
pa,
ppt,
ti,
rc,
te,
die,
nd
documentNumber
string
keyValue
string

Obligatorio para breb_key

qrValue
string

Obligatorio para breb_qr. Payload EMV o base64.

phone
string

Teléfono E.164 opcional. Obligatorio cuando documentType es nd.

Ejemplo:

"+570000000000"

email
string<email>
Ejemplo:

"payer@example.com"

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

Respuesta

Payout aceptado

id
string<uuid>
requerido
status
enum<string>
requerido
Opciones disponibles:
processing