Empresas
Métodos de pago
Recaudo
Dispersiones
Webhooks
Fintech as a service
Solicitar dispersión
curl --request POST \
--url https://api.onepay.la/v1/balances \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-idempotency: <x-idempotency>' \
--data '
{
"amount": 123,
"account_id": "<string>"
}
'(No Content)
Solicitar dispersión
Solicita la dispersión del balance a una cuenta bancaria registrada de tu empresa.
POST
/
balances
Solicitar dispersión
curl --request POST \
--url https://api.onepay.la/v1/balances \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-idempotency: <x-idempotency>' \
--data '
{
"amount": 123,
"account_id": "<string>"
}
'(No Content)
Dispersa el balance de tu cuenta OnePay a una cuenta bancaria registrada de tu empresa.
Ambos parámetros son opcionales:
- Si no envías
amount, se dispersa el balance completo. - Si no envías
account_id, se usa la cuenta bancaria principal (fundable) de tu empresa.
La cuenta bancaria debe pertenecer directamente a tu empresa. Cuentas de tipo PSE no son elegibles como cuenta principal.
Si envías un
account_id que pertenece a un cliente o invitado, recibirás un error company_account_not_found.Headers
Token único para garantizar la idempotencia de la petición
Body
Monto a dispersar en pesos (COP). Mínimo $10.000. Si no se envía, se dispersa el balance completo.
ID de la cuenta bancaria destino. Debe pertenecer a tu empresa (no a un cliente o invitado). Si no se envía, se usa la cuenta principal. Aprende a registrar cuentas.
Ejemplos de uso
- Balance completo
- Monto específico
- Cuenta específica
curl https://api.onepay.la/v1/balances \
-X POST \
-H "Authorization: Bearer sk_test_xxx" \
-H "Content-Type: application/json"
curl https://api.onepay.la/v1/balances \
-X POST \
-H "Authorization: Bearer sk_test_xxx" \
-H "Content-Type: application/json" \
-d '{"amount": 500000}'
curl https://api.onepay.la/v1/balances \
-X POST \
-H "Authorization: Bearer sk_test_xxx" \
-H "Content-Type: application/json" \
-d '{"amount": 500000, "account_id": "9d0ac58c-2226-4f1c-b305-15e6dc3b47f6"}'
Errores
| Código | Nombre | HTTP | Descripción |
|---|---|---|---|
| 10500 | balance_is_empty | 401 | El saldo está vacío |
| 10501 | insufficient_funds | 401 | El monto solicitado supera el balance disponible |
| 10809 | company_account_not_found | 422 | No se encontró cuenta bancaria o no pertenece a tu empresa |
(No Content)
Was this page helpful?
⌘I