Solicitar dispersión
Solicitar dispersión
Solicita la dispersión del balance a una cuenta bancaria registrada de tu empresa.
POST
Solicitar dispersión
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
string
required
Token único para garantizar la idempotencia de la petición
Body
number
Monto a dispersar en pesos (COP). Mínimo $10.000. Si no se envía, se dispersa el balance completo.
string
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.
string
Identificador propio de la dispersión, máximo 100 caracteres. Se devuelve en la respuesta y en
todos los webhooks
cashout.* de esta dispersión, para que puedas cruzarla contra tu sistema.Ejemplos de uso
- Balance completo
- Monto específico
- Cuenta específica
- Con external_id
Response
La respuesta es la línea de dispersión creada, con las mismas llaves que viajan después en los webhookscashout.*. Guarda el id (o envía tu propio external_id)
para poder casar esos eventos con la solicitud que hiciste.
string
Identificador único de la dispersión. Es el mismo
id que llega en los webhooks cashout.*.string
En esta dispersión es el ID de tu empresa, porque el dinero va a una cuenta propia y no a un
cliente. En
POST /cashouts en cambio es el cliente beneficiario.string
Cuenta bancaria de tu empresa a la que se envió el dinero.
number
Monto dispersado en pesos (COP), no en centavos.
string
Estado inicial de la dispersión (normalmente
to_process). Su evolución llega por webhook.boolean
true si la dispersión se creó con una llave de pruebas (sk_test_xxx).date | null
Fecha de programación. En esta dispersión siempre llega
null: se procesa de inmediato.string
Concepto de la operación. En dispersiones a cuenta propia siempre es
Envío de fondos OnePay a cuenta..boolean
true si las comisiones se descuentan del monto que llega a la cuenta destino.string
Canal utilizado (
ACH, TURBO).string | null
El
external_id que enviaste. Llega null si no lo enviaste.string
Referencia interna de la operación. En dispersiones a cuenta propia siempre es
Deposito a cuenta propia.date
Fecha de creación del registro.