Learn how to transfer funds from an account.
This function allows transfers from an account. It can be used for:
- Transferring funds from merchant account to user account (credit funds to a user).
- Payouts to bank accounts. Coming soon.
Flows can be user to user, merchant to user, user to merchant, or user to bank account.
Disbursement
Merchants can transfer (credit) funds to a user account. These funds will be deducted from your balance and credited to the user's wallet.
To make such operation, the merchant needs to input user's account_id
on destination_account_id
parameter and transfer_type = "disbursement"
.
Retrieve Funds
Merchants can retrieve (debit) funds from a user account. These funds will be deducted from the user's wallet and credited to your balance.
To make such operation, the merchant needs to input user's account_id
on source_account_id
parameter and transfer_type = "retrieve"
.
Cashout - Payout to a bank account
Users can transfer funds to a bank account. These funds will be deducted from the sender's account balance.
To make such operation, the merchant needs to input sender's account_id
on source_account_id
parameter and "external"
on destination_account_id
parameter. Also, transfer_type = "payout"
and Beneficiary Bank Details object must be provided.
Mock Sending Transfer in Sandbox
To mock desired responses in sandbox, you need to specify the following inputs in the header. 'X-Dlocal-Disbursement-Result'.
Step to Mock | Transfer STATUS to Mock | header' Input |
---|---|---|
Receive a success when submitting the transfer but a rejection when checking the status | REJECTED | DELIVERED:300 |
Receive a success both when submitting the payout and when checking the status | COMPLETED | DELIVERED:COMPLETED |
Asynchronous notifications
When there is a change of status in the transaction, we will send you a notification to the provided notification_url indicating transfer_id. You will need to call Get transfer information function to review these changes.
{
“transfer_id”:“ISGT-4-87270764b197409d9d2b29c8b43da784"
}