Panel | ||
---|---|---|
| ||
Title: Get Payment Method Requirement for a Currency |
...
Panel | ||
---|---|---|
| ||
URL: Payout/Disbursement/SendR/payment-methods? |
Panel | ||
---|---|---|
| ||
Base URL: https://laas.leatherback.co |
Panel | ||
---|---|---|
| ||
HTTP Method: GET |
...
This endpoint helps to retrieve Payment methods and Metadata (requirements) required to transfer to a Beneficiary Account in a specific currency. To consume this endpoint, Pass BeneficiaryCurrencyCode,
BeneficiaryBankCountryCode
, Amount
, and CurrencyCode
For example, If you want to retrieve payment method & metadata for an account in USD domiciled in the local country (United States), you pass BeneficiaryCurrencyCode
= USD and BeneficiaryBankCountryCode
=USA (This is a local Transaction), and for USD domiciliary Account opened outside the local country. E.g. USD Accounts opened in Nigeria will have BeneficiaryCurrencyCode
= USD and BeneficiaryBankCountryCode=NGA
(This is an International Transaction). There are different Payment method types and requirements as determined by the Beneficiary Account Currency. Examples of Payment Method types include; AbaRouting
, WireRouting, BicSwift
, SortCode,
etc. Each of these identified Payment methods has additional metadata (information) required to be provided for a successful transaction to take place. The table below shows a comprehensive list of Payment methods that can be used for a given Currency during a local or International transaction.
Currency | Transaction Type | Payment Method Type | Meta Data | Payload Sample | ||||||
---|---|---|---|---|---|---|---|---|---|---|
1 | Naira (NGN) | Local | BankCode e.g. 000023 | beneficiaryAccountNumber |
| |||||
2 | British Pounds (GBP) | Local | SortCode e.g. 0400004 | beneficiaryAccountNumber |
| |||||
3 | British Pounds (GBP) | International | BicSwift e.g. CMFGUS33 | IBAN |
| |||||
4 | United States Dollar (USD) | Local | AbaRouting e.g. 026073150 | beneficiaryAccountNumber |
| |||||
5 | United States Dollar (USD) | Local | WireRouting e.g. 084009519
| beneficiaryAccountNumber |
| |||||
6 | United States Dollar (USD) | International | BicSwift e.g. CMFGUS33 | IBAN |
|
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
To get Payment methods and Metadata for a specific currency, call thePayout/Disbursement/SendR/payment-methods endpoint by passing the |
Panel | ||
---|---|---|
| ||
Request Body |
Code Block | ||
---|---|---|
| ||
{ "BeneficiaryCurrencyCode": "USD", "BeneficiaryBankCountryCode": "GBR", "CurrencyCode": "NGN", "Amount": "8001", } |
BeneficiaryCurrencyCode:
three-letter alphabetic codes that represent the various currencies used throughout the world. When combined in pairs, they make up the symbols and cross rates used in currency trading. (Required)BeneficiaryBankCountryCode:
This is the country code in which the Beneficiary account is domiciled (Required)CurrencyCode
: This is the sender's Account currency Code (Required)Amount:
This is the transaction Amount that the sender intends to transfer to the Beneficiary (Required)
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
From the response below, the “requireFileUpload” flag is set to False when the transaction Amount is equal to or below the defined threshold limit set for that Transaction Currency/Customer. Hence no supporting documents are required to consummate the process. However, if the “requireFileUpload” is returned as true, Supporting documents would be required. |
Panel | ||
---|---|---|
| ||
Sample Response Body Response code : 200 |
Code Block | ||
---|---|---|
| ||
{ "value": [ { "name": "BankCode", "currency": "NGN", "requireFileUpload": false, "paymentDestination": "Local", "metaData": { "beneficiaryAccountNumber": "Text", "beneficiaryAccountName": "Text" } } ], "isSuccess": true, "error": "", "message": "", "responseCode": null, "type": null, "title": null, "status": 200, "detail": null, "instance": null, "extensions": {} } |
...