Search available banks

Performs the query of available banks using the parameters: bank code and bank name.

Get Banks

GET https://api.stage.localpayment.com/api/resources/banks

Returns a list of available banks with their codes.

Query Parameters

Name	Type	Description
countryISOCode3	string	Country in 3 character ISO format (ARG, BRA, etc.). Please refer to Country Codes for a full list of supported countries.
name	string	Bank name (full or partial match; case insensitive). E.g. you can find "bancomer" name to get "BBVA Bancomer"
code	string	Bank code. This is the code you will use to place a PayOut order. Please refer to Bank Codes for a full list of supported banks by country.
sort	string	Sort field. You can specify any of the output fields to sort by. E.g. you can sort by code or name
offset	number	Pagination offset.
take	number	Pagination limit.

Headers

Name	Type	Description
Authorization	string	JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication.

200 Response successful.

{
        "code": "007",
        "name": "BANCO DE GALICIA Y BUENOS AIRES S.A.U.",
        "swift": "GABAARBA"
    },
    {
        "code": "011",
        "name": "BANCO DE LA NACION ARGENTINA",
        "swift": "NACNARBA"
    },
    {
        "code": "014",
        "name": "BANCO DE LA PROVINCIA DE BUENOS AIRES",
        "swift": "PRBAARBA"
    },
    {
        "code": "015",
        "name": "INDUSTRIAL AND COMMERCIAL BANK OF CHINA",
        "swift": "ICBKARBA"
    }

404 Wrong parameters (Syntactic or semantic errors)

{    "message": "Wrong parameters (Syntactic or semantic errors)."}

Search available banks: request & response examples.

Example request

curl --location '{{Api_URL}}' \
--header 'Authorization: '{{Token_Generated}}'

Example response

[
    {
        "code": "007",
        "name": "BANCO DE GALICIA Y BUENOS AIRES S.A.U.",
        "swift": "GABAARBA"
    },
    {
        "code": "011",
        "name": "BANCO DE LA NACION ARGENTINA",
        "swift": "NACNARBA"
    },
    {
        "code": "014",
        "name": "BANCO DE LA PROVINCIA DE BUENOS AIRES",
        "swift": "PRBAARBA"
    },
    {
        "code": "015",
        "name": "INDUSTRIAL AND COMMERCIAL BANK OF CHINA",
        "swift": "ICBKARBA"
    }
]

Example response Cod

{
    "data": [
        {
            "id": 412,
            "code": "001",
            "bankType": "Bank",
            "name": "BANCO CENTRAL DE RESERVA DEL PERU",
            "swift": "CRPEPEPL",
            "countryId": 19,
            "countryISOCode3": "PER",
            "countryDesc": "Peru",
            "additionalInformation": null,
            "checkingRegex": "^[0-9]{20}$",
            "savingRegex": "^[0-9]{20}$",
            "branchRegex": null
        },       
    ],
    "total": 1,
    "offset": 0
}

Example response Name

{
    "data": [
        {
            "id": 516,
            "code": "001",
            "bankType": "Bank",
            "name": "BANCO DE GUATEMALA",
            "swift": "BAGUGTGC",
            "countryId": 220,
            "countryISOCode3": "GTM",
            "countryDesc": "Guatemala",
            "additionalInformation": "",
            "checkingRegex": "(1|2|3|5|6|7|8|9)[0-9]{6}",
            "savingRegex": "",
            "branchRegex": null
        }
    ],
    "total": 1,
    "offset": 0
}
```