SendR Payout
This is simply a cross-currency payout where a Merchant pays a beneficiary account in a currency different from the Payout account. A cross-currency payout refers to the entire transaction chain which results in the debiting of an account in one currency and the crediting of the equivalent amount into an account in another currency.
The following are the stages involved in the SendR process:
Panel | ||
---|---|---|
| ||
Step 1: Call Public/payout/Rate Endpoint |
This is used to retrieve the rate utilized during the conversion btw between two currency pairs. The Merchants simply pass the Base Account currency, Base Amount & Quote currency to the endpoint. The response shows the credit Amount equivalent to be credited to the destination Account (Beneficiary) and also the applied rate.
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Kindly ensure the rate is applied within the defined period. |
Sample Illustration
Rachael needs to send Joseph $1000 from her GBP Account
Rachel only has a GBP balance in his Leatherback Payout Account. This means Rachael needs to know the amount in GBP for a $1000 transfer to Joseph
Based on the above, source_currency/Base_currency is GBP, Quote_currency is USD, destination_amount is 1000 and credit_amount is unknown which is $1000 equivalent in GBP
To get the Credit_amount, Rachael makes an API call to Exchange Rate Endpoint
...
· Merchants must maintain a Payout Account in the Base (From) currency with Leatherback i.e. Merchant must have Accounts maintained with Leatherback in the sender’s Currency before the such process can be successful
· “To (The quote currency)must be part of currencies supported by Leatherback Payout (This can be checked using the Disbursement/Currencies/Beneficiaries endpoint
· NB: Leatherback Payout must support transfers to Beneficiary’s Account Currency before the such process can be successful
Panel | ||
---|---|---|
| ||
Step 2: Call Initiate Transaction Endpoint |
To initiate the Payout transaction, Gather the transaction details as shown on the Request payload and call Call Initiate Transaction Endpoint, Pass Rate Id
from Response in the Exchange Rate Endpoint, set reference Id
or we generate it for you, Pass Metadata
To get Metadata for a specific currency as seen on the Request params, call the Beneficiary Requirement endpoint by passing the Beneficiary Currency Code
and Beneficiary Country code
Panel | ||
---|---|---|
| ||
Step 3: Call Beneficiary Requirement Endpoint |
This endpoint helps to retrieve Metadata specific to a currency. Pass Beneficiary Currency Code
and Beneficiary Country code
. For example, If you want to retrieve metadata for an account in USD domiciled in the local country (United States), you pass Beneficiary Currency Code
= USD and Beneficiary Country code
=USA and for USD domiciliary Account opened outside the local country. E,g USD Accounts opened in Nigeria will have Beneficiary Currency Code
= USD and Beneficiary Country code
=NGA
Panel | ||
---|---|---|
| ||
Step 4: Call Disbursement/Currencies/Merchant Endpoint |
...
Example: If the endpoint in 4 returns (USD, NGN, GBP, CAD, EUR) and Endpoint in step 5 returns (NGN, GHS, INR, USD), This means the Beneficiary can only receive funds in the currencies (NGN, GHS, INR, USD, JPY) Only
Panel | ||
---|---|---|
| ||
Step 5: Disbursement/Currencies/Beneficiaries |
This shows the Currencies a Merchant can transfer to (NGN, GHS, INR, USD),
Panel | ||
---|---|---|
| ||
Step 6: Disbursement/Currencies/ |
Consolidation of distinct currencies in 4 & 5 (NGN, GHS, INR, USD, JPY, GBP, CAD, EUR). Call this endpoint to retrieve this unique set
Webhook: Ensure your Webhook URL is configured on the Dev portal Dashboard (see guide here).
...