Consultar entidades bancarias

Obtén las entidades bancarias habilitadas para realizar dispersiones. Es importante tener el cuenta la moneda y el tipo de proceso que vas a realizar.

Ruta

GET /v1/merchant/payout/entities

Encabezado

Name	Type	Description
x-auth-token*	String	Es el código generado a partir del proceso de autenticación.
Content-Type	String	Es el tipo de contenido que se está enviando en la solicitud. Ejemplo: application/json

Cuerpo

Name	Type	Description
type	string	Es el método que se usará para la dispersión. normal | instant | scheduled Por defecto es normal
currency	string	Código que identifica la divisa de la dispersión en formato ISO 4217. COP | USD Por defecto es COP

Respuesta

200

{
    "entities": [
        {
            "code": 1815,
            "name": "Alianza Fiduciaria",
            "account_number": {
                "min_length": 6,
                "max_length": 16
            },
            "logos": {
                "default": "https://content.trazo.co/payments/logos/1815.png",
                "circle": "https://content.trazo.co/payments/logos/1815-circle.png",
                "horizontal": "https://content.trazo.co/payments/logos/1815-horizontal.png"
            }
        },
        {...}
    ]
}

400

{
    "error": "No bank was found with the provided parameters. Please try again with a different type (type)."
}

---

Ejemplo

cURL

curl --location --request GET '{{base_url}}/v1/merchant/payout/entities' \
--header 'x-auth-token: {{token}}' \
--data '{
    "currency": "USD"
}'

NodeJS(Axios)

const axios = require('axios');

let data = JSON.stringify({
  "currency": "COP",
  "type": "instant"
});


let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: `${base_url}/v1/merchant/payout/entities`,
  headers: { 
    'x-auth-token': token //Añadir token
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Python

import requests

url = f"{base_url}/v1/merchant/payout/entities"

payload = json.dumps({
  "currency": "COP",
  "type": "instant"
})

headers = {
  'x-auth-token': token #Añadir token
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)