POST
/
cashouts
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

Identificador único del cuenta.

​
customer_id
string
required

Identificador único del 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.

{
   "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?