Skip to main content
POST
https://api.onepay.la/v1
/
cashouts
Crear dispersión
curl --request POST \
  --url https://api.onepay.la/v1/cashouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-idempotency: <x-idempotency>' \
  --data '
{
  "amount": 123,
  "account_id": "<string>",
  "customer_id": "<string>",
  "description": "<string>",
  "external_id": "<string>",
  "currency": "<string>",
  "method": "<string>"
}
'
{
   "id":"9d44ce43-a227-4566-b107-5a6bc01cbcdf",
   "customer_id":"9b7c5f38-b2b5-4b0d-8e4c-458192e88eae",
   "account_id":"9d0ac58c-2226-4f1c-b305-15e6dc3b47f6",
   "is_test":false,
   "amount":1000,
   "status":"processed",
   "scheduled_at":null,
   "created_at":"2024-10-17T18:07:18.000000Z",
   "external_id":null,
   "method":"ACH"
}

​
Headers

​
x-idempotency
string
required
Token único para garantizar la idempotencia de la petición

​
Body

​
amount
number
required
Monto de la dispersión.
​
account_id
string
required
ID de la cuenta bancaria registrada. Aprende a registrar cuentas.
​
customer_id
string
required
ID del cliente beneficiario. Crea primero el cliente.
​
description
string
Descripción de la dispersión.
​
external_id
string
Identificador externo de la dispersión.
​
currency
string
required
Moneda de la dispersión.
​
method
string
required
Método de dispersión.

​
Ejemplos de uso

curl https://api.onepay.la/v1/cashouts \
  -X POST \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "Content-Type: application/json" \
  -H "x-idempotency: cashout-001" \
  -d '{
    "amount": 1000000,
    "currency": "COP",
    "customer_id": "9b7c5f38-b2b5-4b0d-8e4c-458192e88eae",
    "account_id": "9d0ac58c-2226-4f1c-b305-15e6dc3b47f6",
    "description": "Pago de nómina",
    "method": "ACH",
    "external_id": "PAYROLL-2391"
  }'

​
Response

​
id
string
Identificador único de la dispersión.
​
customer_id
string
Cliente beneficiario.
​
account_id
string
Cuenta bancaria donde se enviará el dinero.
​
amount
number
Monto en centavos.
​
currency
string
Moneda de la dispersión.
​
status
string
Estado actual (pending, processing, processed, failed).
​
method
string
Canal utilizado (ACH, TURBO).
​
scheduled_at
date
Fecha de programación si existe.
​
external_id
string
Referencia propia que enviaste en la creación.
​
created_at
date
Fecha de creación del registro.
{
   "id":"9d44ce43-a227-4566-b107-5a6bc01cbcdf",
   "customer_id":"9b7c5f38-b2b5-4b0d-8e4c-458192e88eae",
   "account_id":"9d0ac58c-2226-4f1c-b305-15e6dc3b47f6",
   "is_test":false,
   "amount":1000,
   "status":"processed",
   "scheduled_at":null,
   "created_at":"2024-10-17T18:07:18.000000Z",
   "external_id":null,
   "method":"ACH"
}