Listar dispersiones

curl https://api.onepay.la/v1/cashouts?page=1&per_page=50&filter[status]=processed&filter[created_at_from]=2026-09-01&filter[created_at_to]=2026-09-30&sort=-created_at \
  -H "Authorization: Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi"

const response = await fetch('https://api.onepay.la/v1/cashouts?page=1&per_page=50&filter[status]=processed&filter[created_at_from]=2026-09-01&filter[created_at_to]=2026-09-30&sort=-created_at', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi'
  }
});
const data = await response.json();
console.log(data.data); // Array de dispersiones
console.log(data.total); // Total de dispersiones

import requests

url = "https://api.onepay.la/v1/cashouts"
headers = {
    "Authorization": "Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi"
}
params = {
    "page": 1,
    "per_page": 50,
    "filter[status]": "processed",
    "filter[created_at_from]": "2026-09-01",
    "filter[created_at_to]": "2026-09-30",
    "sort": "-created_at"
}

response = requests.get(url, headers=headers, params=params)
data = response.json()
print(data["data"])  # Array de dispersiones
print(data["total"])  # Total de dispersiones

<?php
$ch = curl_init();

$url = "https://api.onepay.la/v1/cashouts?" . http_build_query([
    "page" => 1,
    "per_page" => 50,
    "filter" => [
        "status" => "processed",
        "created_at_from" => "2026-09-01",
        "created_at_to" => "2026-09-30",
    ],
    "sort" => "-created_at"
]);

curl_setopt_array($ch, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi"
    ]
]);

$response = curl_exec($ch);
$data = json_decode($response, true);

print_r($data["data"]); // Array de dispersiones
echo $data["total"];    // Total de dispersiones

curl_close($ch);
?>

{
   "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,
         "processed_at":"2026-09-15T18:09:02.000000Z",
         "created_at":"2026-09-15T18:07:18.000000Z",
         "external_id":null,
         "description":"Pago de nómina",
         "reference":"NOM-2026-07",
         "method":"ACH",
         "discount_to_destination":false
      },
      {
         "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,
         "processed_at":"2026-09-02T19:40:25.000000Z",
         "created_at":"2026-09-02T19:40:21.000000Z",
         "external_id":null,
         "description":null,
         "reference":null,
         "method":"TURBO",
         "discount_to_destination":false
      }
   ],
   "current_page":1,
   "from":1,
   "last_page":16,
   "per_page":50,
   "to":50,
   "total":756
}

GET

cashouts

curl https://api.onepay.la/v1/cashouts?page=1&per_page=50&filter[status]=processed&filter[created_at_from]=2026-09-01&filter[created_at_to]=2026-09-30&sort=-created_at \
  -H "Authorization: Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi"

const response = await fetch('https://api.onepay.la/v1/cashouts?page=1&per_page=50&filter[status]=processed&filter[created_at_from]=2026-09-01&filter[created_at_to]=2026-09-30&sort=-created_at', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi'
  }
});
const data = await response.json();
console.log(data.data); // Array de dispersiones
console.log(data.total); // Total de dispersiones

import requests

url = "https://api.onepay.la/v1/cashouts"
headers = {
    "Authorization": "Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi"
}
params = {
    "page": 1,
    "per_page": 50,
    "filter[status]": "processed",
    "filter[created_at_from]": "2026-09-01",
    "filter[created_at_to]": "2026-09-30",
    "sort": "-created_at"
}

response = requests.get(url, headers=headers, params=params)
data = response.json()
print(data["data"])  # Array de dispersiones
print(data["total"])  # Total de dispersiones

<?php
$ch = curl_init();

$url = "https://api.onepay.la/v1/cashouts?" . http_build_query([
    "page" => 1,
    "per_page" => 50,
    "filter" => [
        "status" => "processed",
        "created_at_from" => "2026-09-01",
        "created_at_to" => "2026-09-30",
    ],
    "sort" => "-created_at"
]);

curl_setopt_array($ch, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi"
    ]
]);

$response = curl_exec($ch);
$data = json_decode($response, true);

print_r($data["data"]); // Array de dispersiones
echo $data["total"];    // Total de dispersiones

curl_close($ch);
?>

{
   "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,
         "processed_at":"2026-09-15T18:09:02.000000Z",
         "created_at":"2026-09-15T18:07:18.000000Z",
         "external_id":null,
         "description":"Pago de nómina",
         "reference":"NOM-2026-07",
         "method":"ACH",
         "discount_to_destination":false
      },
      {
         "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,
         "processed_at":"2026-09-02T19:40:25.000000Z",
         "created_at":"2026-09-02T19:40:21.000000Z",
         "external_id":null,
         "description":null,
         "reference":null,
         "method":"TURBO",
         "discount_to_destination":false
      }
   ],
   "current_page":1,
   "from":1,
   "last_page":16,
   "per_page":50,
   "to":50,
   "total":756
}

Parámetros de consulta

number

default:1

Página que deseas consultar.

number

default:50

Registros por página (máx. 100).

string

ID único de la dispersión

string

ID del cliente destinatario de la dispersión

string

Identificador externo que enviaste al crear la dispersión (coincidencia exacta)

string

Estado exacto de la dispersión: draft, scheduled, to_process, processing, processed, failed, cancelled, require_approval o require_fraud_check_approval. No distingue mayúsculas.

string

Moneda de la dispersión

string

Monto de la dispersión

string

Título de la dispersión

string

Referencia de la dispersión

string

Nombre del cliente

string

Número de documento de identidad del cliente

string

Dispersiones creadas en ese día (YYYY-MM-DD, día UTC).

string

Dispersiones creadas desde esa fecha, inclusive. Acepta YYYY-MM-DD o fecha y hora ISO 8601.

string

Dispersiones creadas hasta esa fecha, inclusive. Acepta YYYY-MM-DD o fecha y hora ISO 8601.

string

Dispersiones procesadas en ese día. También acepta filter[processed_at_from] y filter[processed_at_to].

string

Dispersiones programadas para ese día. También acepta filter[scheduled_at_from] y filter[scheduled_at_to].

string

Filtrar por fecha

Los filtros de fecha existen para created_at, processed_at y scheduled_at, cada uno en tres formas:

Parámetro	Resultado
`filter[created_at]=2026-09-01`	Todo ese día
`filter[created_at_from]=2026-09-01`	Desde ese día, inclusive
`filter[created_at_to]=2026-09-30`	Hasta ese día, inclusive

Para un rango envía _from y _to juntos. Se combinan con los demás filtros, con sort y con la paginación. Zona horaria. Una fecha YYYY-MM-DD corresponde al día completo en UTC, la misma zona en la que la API devuelve created_at (sufijo Z). Para acotar por el día en Colombia, envía en _from y _to una fecha y hora ISO 8601 con su zona horaria, que se convierte a UTC antes de filtrar:

filter[created_at_from]=2026-09-01T00:00:00-05:00
filter[created_at_to]=2026-09-01T23:59:59-05:00

Sin zona horaria, la hora se interpreta en UTC. Si usas una zona positiva (+02:00), codifica el + como %2B en la URL. Un valor inválido responde 422 con el error en filter.<parámetro>, por ejemplo una fecha inexistente (2026-02-30), otro formato (01/09/2026), dos valores separados por coma, o una hora en filter[created_at] (para acotar por hora usa _from y _to).

curl https://api.onepay.la/v1/cashouts?page=1&per_page=50&filter[status]=processed&filter[created_at_from]=2026-09-01&filter[created_at_to]=2026-09-30&sort=-created_at \
  -H "Authorization: Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi"

const response = await fetch('https://api.onepay.la/v1/cashouts?page=1&per_page=50&filter[status]=processed&filter[created_at_from]=2026-09-01&filter[created_at_to]=2026-09-30&sort=-created_at', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi'
  }
});
const data = await response.json();
console.log(data.data); // Array de dispersiones
console.log(data.total); // Total de dispersiones

import requests

url = "https://api.onepay.la/v1/cashouts"
headers = {
    "Authorization": "Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi"
}
params = {
    "page": 1,
    "per_page": 50,
    "filter[status]": "processed",
    "filter[created_at_from]": "2026-09-01",
    "filter[created_at_to]": "2026-09-30",
    "sort": "-created_at"
}

response = requests.get(url, headers=headers, params=params)
data = response.json()
print(data["data"])  # Array de dispersiones
print(data["total"])  # Total de dispersiones

<?php
$ch = curl_init();

$url = "https://api.onepay.la/v1/cashouts?" . http_build_query([
    "page" => 1,
    "per_page" => 50,
    "filter" => [
        "status" => "processed",
        "created_at_from" => "2026-09-01",
        "created_at_to" => "2026-09-30",
    ],
    "sort" => "-created_at"
]);

curl_setopt_array($ch, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer sk_test_KjbE0Vobf5Lg1yNZ4HoKawDItDs3Rod9VXNBWrEYmGn06tkesPIi"
    ]
]);

$response = curl_exec($ch);
$data = json_decode($response, true);

print_r($data["data"]); // Array de dispersiones
echo $data["total"];    // Total de dispersiones

curl_close($ch);
?>

Response

array

Listado de dispersiones.

number

Número de la página actual

string

URL para acceder a la primera página de resultados

number

Índice inicial del primer elemento en la página actual

string

URL para acceder a la siguiente página de resultados. Será null si es la última página

string

URL base de la API sin los parámetros de paginación

number

Cantidad de elementos por página

string

URL para acceder a la página anterior. Será null si es la primera página

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,
         "processed_at":"2026-09-15T18:09:02.000000Z",
         "created_at":"2026-09-15T18:07:18.000000Z",
         "external_id":null,
         "description":"Pago de nómina",
         "reference":"NOM-2026-07",
         "method":"ACH",
         "discount_to_destination":false
      },
      {
         "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,
         "processed_at":"2026-09-02T19:40:25.000000Z",
         "created_at":"2026-09-02T19:40:21.000000Z",
         "external_id":null,
         "description":null,
         "reference":null,
         "method":"TURBO",
         "discount_to_destination":false
      }
   ],
   "current_page":1,
   "from":1,
   "last_page":16,
   "per_page":50,
   "to":50,
   "total":756
}

API

Empresas

Métodos de pago

Recaudo

Productos

Facturación

Balances

Webhooks

Fintech as a service

Parámetros de consulta

Filtrar por fecha

Response

​Parámetros de consulta

​Filtrar por fecha

​Response

Parámetros de consulta

Filtrar por fecha

Response