List of available banks

• Sandbox: GET https://sandbox.payme.io/api/banks/{country_iso_code}
• Production: GET https://live.payme.io/api/banks/{country_iso_code}

Credentials

No credentials are documented for this endpoint.

Overview

This API Endpoint will allow you retreive a list of available banks by filtering your request per country.

Parameters

Name	In	Type	Required	Description
PayMe-Partner-Key	header	string	no	Your PayMe's Partner Secret Key
country_iso_code	path	string	yes

Code samples

curl

curl -X GET 'https://sandbox.payme.io/api/banks/<country_iso_code>'

Node.js

const response = await fetch("https://sandbox.payme.io/api/banks/<country_iso_code>", {
  method: "GET",
});

console.log(await response.text());

Python

import requests

response = requests.get(
    "https://sandbox.payme.io/api/banks/<country_iso_code>",
)

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/banks/<country_iso_code>');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — OK (success)

Field	Type	Description
status_code	integer	status_code = 0 (success) status_code = 1 (failure)
items_count	integer	The total items count in your response
items_per_page	integer	The total items count per page in your response
country_code	string	Find the iso codes here
items	array	The items object - presenting the list of banks
items[].code	string	Bank code
items[].local_name	string	Local bank name
items[].international_name	string	Internal bank name

{
  "status_code": 0,
  "items_count": 0,
  "items_per_page": 0,
  "country_code": "string",
  "items": [
    {
      "code": "string",
      "local_name": "string",
      "international_name": "string"
    }
  ]
}