Bancos destino admitidos, por instrumento

GET/payouts/banksProbar

ServidorURL base

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

Parámetros de consultamethodobligatorioInstrumento de entrega para el que quieres el catálogo.

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

/payouts/banks

const url = 'http://localhost:3000/v1/payouts/banks?method=pago_movil';
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/payouts/banks?method=pago_movil' \
  --header 'x-api-key: <x-api-key>'

Scope payments:read. Catálogo de los bancos a los que se puede dispersar. method es obligatorio: las dos listas no coinciden —31 bancos por pago móvil y 24 por transferencia—. El 0190 (Citibank) y el 0601 (Instituto Municipal de Crédito Popular), por ejemplo, aceptan pago móvil y no transferencia. Valida el bankCode contra el catálogo del instrumento con el que vas a pagar.

Un mismo código puede venir con nombre distinto en cada lista (el 0175 es «Banco Bicentenario» en pago móvil y «BDT» en transferencia).

La respuesta se sirve de caché y, si el catálogo del riel no contesta, se devuelve una copia local: este endpoint no falla.

Para el selector de bancos de tu aplicación: shortName para la interfaz, name para los comprobantes.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

method

required

string

Allowed values: pago_movil transferencia

Instrumento de entrega para el que quieres el catálogo.

Responses

200

Catálogo de bancos para ese instrumento

application/json

object

method

string

Allowed values: pago_movil transferencia

data

Array<object>

object

code

Código de banco de 4 dígitos. Es el bankCode del beneficiario.

string

name

Nombre completo, para comprobantes.

string

shortName

Nombre corto, para la interfaz. Nunca viene vacío.

string

Example

{
  "method": "pago_movil",
  "data": [
    {
      "code": "0102",
      "name": "Banco de Venezuela S.A.C.A. Banco Universal",
      "shortName": "Banco de Venezuela"
    },
    {
      "code": "0105",
      "name": "Banco Mercantil, C.A. Banco Universal",
      "shortName": "Mercantil"
    },
    {
      "code": "0108",
      "name": "Banco Provincial, S.A. Banco Universal",
      "shortName": "Banco Provincial - BBVA"
    },
    {
      "code": "0134",
      "name": "Banesco Banco Universal S.A.C.A.",
      "shortName": "Banesco"
    },
    {
      "code": "0138",
      "name": "Banco Plaza, Banco Universal C.A",
      "shortName": "Banco Plaza"
    },
    {
      "code": "0175",
      "name": "Banco Bicentenario del Pueblo de la Clase Obrera, Mujer y Comunas B.U.",
      "shortName": "Banco Bicentenario"
    }
  ]
}

400

method ausente, o distinto de pago_movil y transferencia. error.code = validation_failed.

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"
  }
}

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"
  }
}