Metodos de pago
Recaudo
Dispersiones
Webhooks
Fintech as a service
Crear dispersión
Copy
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>"
}
'Copy
{
"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"
}
Crear dispersión
Endpoint para registrar una dispersión en el sistema de OnePay.
POST
https://api.onepay.la/v1
/
cashouts
Crear dispersión
Copy
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>"
}
'Copy
{
"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
Token único para garantizar la idempotencia de la petición
Body
Monto de la dispersión.
ID de la cuenta bancaria registrada. Aprende a registrar cuentas.
ID del cliente beneficiario. Crea primero el cliente.
Descripción de la dispersión.
Identificador externo de la dispersión.
Moneda de la dispersión.
Método de dispersión.
Ejemplos de uso
- curl
- JavaScript
- Python
Copy
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"
}'
Copy
const payload = {
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'
};
await fetch('https://api.onepay.la/v1/cashouts', {
method: 'POST',
headers: {
Authorization: 'Bearer sk_test_xxx',
'Content-Type': 'application/json',
'x-idempotency': 'cashout-001'
},
body: JSON.stringify(payload)
});
Copy
import requests
payload = {
"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 = requests.post(
"https://api.onepay.la/v1/cashouts",
headers={
"Authorization": "Bearer sk_test_xxx",
"x-idempotency": "cashout-001"
},
json=payload,
timeout=15
)
response.raise_for_status()
print(response.json())
Response
Identificador único de la dispersión.
Cliente beneficiario.
Cuenta bancaria donde se enviará el dinero.
Monto en centavos.
Moneda de la dispersión.
Estado actual (
pending, processing, processed, failed).Canal utilizado (
ACH, TURBO).Fecha de programación si existe.
Referencia propia que enviaste en la creación.
Fecha de creación del registro.
Copy
{
"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"
}
Was this page helpful?
⌘I