Destination banks, by instrument

GET/payouts/banksProbar

URL base

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

Parámetros de consulta

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

Enviar peticiónCopiar como curl

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

curl --request GET \
  --url 'http://localhost:3000/v1/payouts/banks?method=pago_movil' \
  --header 'x-api-key: <x-api-key>'

• Pruebas (sandbox)
• Producción

Scope payments:read. The catalog of banks you can pay out to. method is required: the two lists don’t match —31 banks by pago móvil and 24 by bank transfer—. 0190 (Citibank) and 0601 (Instituto Municipal de Crédito Popular), for example, accept pago móvil and not bank transfer. Validate bankCode against the catalog of the instrument you are going to pay with.

The same code can come with a different name in each list (full in one, abbreviated in the other).

The response is served from cache and, if the payment network’s catalog doesn’t answer, a local copy is returned: this endpoint doesn’t fail.

For your app’s bank picker: shortName for the UI, name for receipts.

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

Media typeapplication/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"
    }
  ]
}

400

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

Media typeapplication/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 upstream_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

Media typeapplication/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 upstream_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"
  }
}