Skip to main content
GET
/
states
Listado de departamentos
curl --request GET \
  --url https://api.onepay.la/v1/states \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 5,
    "name": "Antioquia"
  },
  {
    "id": 8,
    "name": "Atlántico"
  },
  {
    "id": 11,
    "name": "Bogotá D.C."
  },
  {
    "id": 13,
    "name": "Bolívar"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.onepay.la/llms.txt

Use this file to discover all available pages before exploring further.

Usado en listar ciudades

El id de cada departamento es el valor que se envía como filter[state_id] al consultar el listado de ciudades.

​
Query Parameters

​
filter[name]
string
Filtra departamentos por nombre (búsqueda parcial, case-insensitive).
​
sort
string
default:"name"
Ordenamiento por nombre. Usa name para ascendente y -name para descendente.

​
Ejemplos de uso

curl https://api.onepay.la/v1/states \
  -X GET \
  -H "Authorization: Bearer sk_test_xxx"
Con filtro por nombre:
curl "https://api.onepay.la/v1/states?filter[name]=antio" \
  -X GET \
  -H "Authorization: Bearer sk_test_xxx"

​
Response

La respuesta es un arreglo con todos los departamentos disponibles (no paginado).
​
id
integer
ID único del departamento. Úsalo como filter[state_id] al consultar ciudades.
​
name
string
Nombre del departamento.

​
Ejemplo de respuesta

[
  {
    "id": 5,
    "name": "Antioquia"
  },
  {
    "id": 8,
    "name": "Atlántico"
  },
  {
    "id": 11,
    "name": "Bogotá D.C."
  },
  {
    "id": 13,
    "name": "Bolívar"
  }
]