Skip to main content
GET
https://api.onepay.la/v1
/
cashouts
Listar dispersiones
curl --request GET \
  --url https://api.onepay.la/v1/cashouts \
  --header 'Authorization: Bearer <token>'
{
   "data":[
      {
         "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"
      },
      {
         "id":"9d18ade4-1607-4ef4-9d9d-8a40fb9e0aef",
         "customer_id":"9d18ad3b-782f-4448-b2fb-bd17b1420a91",
         "account_id":null,
         "is_test":false,
         "amount":1,
         "status":"processed",
         "scheduled_at":null,
         "created_at":"2024-09-25T19:40:21.000000Z",
         "external_id":null,
         "method":"TURBO"
      }
   ],
   "current_page":1,
   "from":1,
   "last_page":16,
   "per_page":50,
   "to":50,
   "total":756
}

​
Parámetros de consulta

​
page
number
default:1
Página que deseas consultar.
​
per_page
number
default:50
Registros por página (máx. 100).
​
filter[id]
string
ID único de la dispersión
​
filter[status]
string
Estado de la dispersión
​
filter[payment_currency]
string
Moneda de la dispersión
​
filter[amount]
string
Monto de la dispersión
​
filter[title]
string
Título de la dispersión
​
filter[reference]
string
Referencia de la dispersión
​
filter[name]
string
Nombre del cliente
​
filter[document_number]
string
Número de documento de identidad del cliente
​
sort
string
Ordena los resultados (created_at | -created_at | processed_at | -processed_at | scheduled_at | -scheduled_at | amount | -amount).

​
Response

​
data
array
Listado de dispersiones.
​
current_page
number
Número de la página actual
​
first_page_url
string
URL para acceder a la primera página de resultados
​
from
number
Índice inicial del primer elemento en la página actual
​
next_page_url
string
URL para acceder a la siguiente página de resultados. Será null si es la última página
​
path
string
URL base de la API sin los parámetros de paginación
​
per_page
number
Cantidad de elementos por página
​
prev_page_url
string
URL para acceder a la página anterior. Será null si es la primera página
​
to
number
Índice final del último elemento en la página actual
{
   "data":[
      {
         "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"
      },
      {
         "id":"9d18ade4-1607-4ef4-9d9d-8a40fb9e0aef",
         "customer_id":"9d18ad3b-782f-4448-b2fb-bd17b1420a91",
         "account_id":null,
         "is_test":false,
         "amount":1,
         "status":"processed",
         "scheduled_at":null,
         "created_at":"2024-09-25T19:40:21.000000Z",
         "external_id":null,
         "method":"TURBO"
      }
   ],
   "current_page":1,
   "from":1,
   "last_page":16,
   "per_page":50,
   "to":50,
   "total":756
}