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: Payout/Disbursement/SendR/payment-methods?
Base URL: https://laas.leatherback.co
HTTP Method: GET
Headers: authorization Set value to X-API: SECRET_KEY
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 | "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 | SortCode e.g. 0400004 | beneficiaryAccountNumber | "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 | BicSwift e.g. CMFGUS33 | IBAN | "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 | beneficiaryAccountNumber | "beneficiary": {
"currencyCode": "USD",
"countryCode": "USA",
"name": "string",
"email": "string",
"address": "house no T4",
"paymentMethodType": "AbaRouting",
"paymentMethodValue": "026073150",
"metaData": {
"beneficiaryAccountNumber": " string ",
"beneficiaryAccountName": " string "
}
}
|
| 5 | United States Dollar (USD) | Local | WireRouting e.g. 084009519
| beneficiaryAccountNumber | "beneficiary": {
"currencyCode": "USD",
"countryCode": "USA",
"name": "string",
"email": "string",
"address": "house no T4",
"paymentMethodType": "WireRouting
",
"paymentMethodValue": "026073150",
"metaData": {
"beneficiaryAccountNumber": "string",
"beneficiaryAccountName": " string"
}
}
|
| 6 | United States Dollar (USD) | International | BicSwift e.g. CMFGUS33 | IBAN | "beneficiary": {
"currencyCode": "USD",
"countryCode": "GBR",
"name": "string",
"email": "string",
"address": "house no T4",
"paymentMethodType": "BicSwift",
"paymentMethodValue": "CMFGUS33",
"metaData": {
"IBAN": "string",
"beneficiaryAccountName": " string "
}
}
|
To get Payment methods and Metadata for a specific currency, call the Payout/Disbursement/SendR/payment-methods endpoint by passing the BeneficiaryCurrencyCode BeneficiaryBankCountryCode , Currencycode, and Amount .Example of Payment methods/metadata for USD (local transaction) i.e Beneficiary USD account domiciled in the United States is shown below. We can also see from the illustration clearly that there are two Payment Methods available for USD Local transaction which are “WireRouting” & “AbaRouting”. Each of the Payment method may have different or same metadata. In this example, the identified Payment Methods have similar Meta data information ("beneficiaryAccountNumber" , "beneficiaryAccountName”).
Request Body
{
"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)
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.
Sample Response Body Response code : 200
{
"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": {}
}
0 Comments