Get Banks

Description: Endpoint to get eligible banks in a country

Request Parameters

Request Parameters

Parameter	Type	Description	Required
id	Integer	Unique Identifier	Yes
terminalId	string	Terminal Identifier	Yes
terminalCard	boolean	Terminal Card parameter	Yes
direction	string	Parameter to identify of message is a request or response. Value “request” is to be passed for requests	Yes
transaction	object	An object holding the transaction information as follows:	Yes
destinationCountry	string	Country code for the destination country e.g. US	Yes
reference	string	Reference number	Yes
senderName	string	Sender Name	Yes
endPoint	string	Endpoint to call. FX for foreign exchange transaction.	Yes
action	string	Action to be performed e.g. BL. The transaction type to be performed. Refer to section 1.2 for possible actions.	Yes
account	string	Account object	No
beneficiary	object	Beneficiary object. This is applicable when action is CP= cash pickup	No
sender	object	Sender object. This is applicable when action is CP= cash pickup	No

Response Parameters

Response Parameters

Parameter	Type	Description	Mandatory
direction	string	Parameter to identify of message is a request or response. Value “response” is to be returned for response	Yes
reference	string	Reference Number	Yes
companyId	string	Company Identifier	No
date	string	date	No
amount	decimal	Transaction amount	Yes
totalFailed	integer	Total number of transactions that failed	No
totalSuccess	integer	Total number of transactions that succeeded	No
error	integer	Error code. If there are no error, value here will be 0	Yes
message	string	Message received as response data	Yes
bulkItems	object	Object holding bulk items	No
otherReference	string	Other reference number	No
action	string	Action performed e.g. BL. The transaction type performed. Refer to section 1.2 for possible actions	Yes
records	string	Not used	No
currency	string	Currency Code	No
openingBalance	decimal	Opening Balance	No
closingBalance	decimal	Closing Balance	No
bankCode	string	Bank Code	No

Sample Request

Request Parameters

POST {base_url}/banks

curl `${base_url}/banks`
-H "Content-type: application/json"
-X POST
-d '{
    "id":"2233",
    "terminalId":"7000000004",
    "terminalCard":false,
    "direction":"request",
    "transaction":{
        "reference":"reference{{random_number}}",
        "destinationCountry":"NG",
        "senderName":"Tester sent",
        "endPoint":"FX"
    },
    "action":"BL",
    "account": null,
    "beneficiary": null,
    "sender": null
}
'

Sample Response

Sample Success Response

POST {base_url}/banks

{
  "direction": "response",
  "reference": "09FG2110141524400822WKY9A",
  "companyId": null,
  "date": null,
  "amount": 0,
  "totalFailed": 0,
  "totalSuccess": 0,
  "error": "0",
  "message": "{\"bank\":[{\"bankCode\":\"AIRTELMONEY\",\"bankName\":\"AIRTELMONEY\",\"bankAlias\":\"MNO\"}]}",
  "bulkItems": null,
  "otherReference": "reference958239",
  "action": "BL",
  "records": null,
  "currency": null,
  "openingBalance": 0,
  "closingBalance": 0,
  "bankCode": null
}