Listar beneficiarios

GET/beneficiariesProbar

ServidorURL base

API key x-api-keyRecordar la clave en este navegador (localStorage, no sale de aquí)

Parámetros de consultalimitintegercursorstring`next_cursor` de la página anterior

La llamada la hace tu navegador, contra el servidor que elijas arriba. Si la documentación no está servida desde el mismo origen que la API, el navegador puede bloquear la respuesta por CORS: en ese caso abre estas páginas desde la propia API (/docs) o usa el curl de arriba.

GET

/beneficiaries

const url = 'http://localhost:3000/v1/beneficiaries?limit=25';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/v1/beneficiaries?limit=25' \
  --header 'x-api-key: <x-api-key>'

Scope beneficiaries:read. Paginación por cursor.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

limit

integer

default: 25 >= 1 <= 100

cursor

string

next_cursor de la página anterior

Responses

200

Página de beneficiarios

application/json

object

data

Array<object>

object

string format: uuid

full_name

string

national_id

string

bank_code

string

account_number

string

nullable

phone

string

nullable

asset

string

Allowed values: BS USD USDC VESC

country

string

status

string

Allowed values: active blocked

payout_count

Cuántas dispersiones le han llegado bien. Señal antifraude.

integer

last_success_at

string format: date-time

nullable

last_failure_reason

string

nullable

created_at

string format: date-time

has_more

boolean

next_cursor

string

nullable

Example

{
  "data": [
    {
      "asset": "BS",
      "status": "active"
    }
  ]
}

401

Error con código estable

application/json

object

error

object

meta

Contexto estructurado del error cuando lo hay: qué límite se superó y de cuánto, qué campo es inválido, cuánto saldo había. No aparece en errores internos.

object

key

additional properties

any

type

string

Allowed values: invalid_request_error authentication_error rate_limit_error provider_error api_error

code

Código ESTABLE. Programa contra esto.

string

message

string

request_id

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_balance",
    "request_id": "req_8a0312ba896772bc441134cd"
  }
}