Payment Method Requirement for a Currency
Title: Get Payment Method Requirement for a Currency
Description: This endpoint helps to retrieve payment method applicable to a specific currency and other additional information (metadata) that may be required
URL: https://laas.leatherback.co/Payout/Disbursement/SendR/payment-methods?
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 |
e.g. 000023 |
| "beneficiary": {
"currencyCode": "NGN",
"countryCode": "NGA",
"name": "string",
"email": "string",
"address": "house no T4",
"paymentMethodType": "BankCode",
"paymentMethodValue": "000023",
"metaData": {
"beneficiaryAccountNumber": " string",
"beneficiaryAccountName": "string"
}
}
} |
2 | British Pounds (GBP) | Local |
e.g. 0400004 |
| "beneficiary": {
"currencyCode": "GBP",
"countryCode": "GBR",
"name": "string",
"email": "string",
"address": "house no T4",
"paymentMethodType": "SortCode",
"paymentMethodValue": "0400004",
"metaData": {
"beneficiaryAccountNumber": "string",
"beneficiaryAccountName": "string"
}
} |
3 | British Pounds (GBP) | International |
e.g. CMFGUS33 |
| "beneficiary": {
"currencyCode": "GBP",
"countryCode": "NGA",
"name": "string",
"email": "string",
"address": "house no T4",
"paymentMethodType": "BicSwift",
"paymentMethodValue": "CMFGUS33",
"metaData": {
"IBAN": " string",
"beneficiaryAccountName": " string "
}
} |
4 | United States Dollar (USD) | Local | AbaRouting e.g. 026073150 |
| |
5 | United States Dollar (USD) | Local | WireRouting e.g. 084009519
|
| |
6 | United States Dollar (USD) | International |
e.g. CMFGUS33 |
|
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)
Related articles
Leatherback 2024