Payment API

Payment API provides all the functionality required to manage beneficiaries and initiate payments on your user's behalf.

The Payment APIs are:

• CreateTransfer - The easiest and most efficient way to facilitate payments.
• [Not required when using CreateTransfer] Get beneficiaries - Retrieve beneficiaries from the bank account.
• [Not required when using CreateTransfer] Create Beneficiary - Create a beneficiary into the bank account.
• [Not required when using CreateTransfer] CreateTransferToExistingBeneficiary - Initiate a transfer to an existing beneficiary only.

CreateTransfer [Recommended]

createTransfer automatically takes care of all requirements for adding a beneficiary as well as initiating a transfer. We recommend using createTransfer to initiate a payment.

you can send money from an account to an account with a specific amount.All 3 variables are optional.

Parameters

📘

Note

Behavior of the SDK depends on the parameters that will be set.

❗️

How to set beneficiary details?

There are multiple ways to communicate the beneficiary details to Dapi. Please follow the best approach based on your exact use case and security requirements

---

• Option 1: Set the beneficiary on the Dapi Dashboard.
  • ⚠️ Works only for static beneficiaries. (All of the transfers will be sent to beneficiaries that you know ahead of time.)
  • ✅ No configuration required on the SDK nor on the SDK Backend Server side.

---

• Option 2: Set the beneficiary as the DapiBeneficiary object in the SDK function call
  • ✅ Works for both dynamic and static beneficiaries.
  • ⚠️ You should be double-checking the beneficiary details integrity in the SDK Backend Server that you set up. This is to ensure no tampering with the data on the front-end layer.

---

• Option 3: Set the beneficiary details only in the SDK Backend Server (in principle the same as Option 2)
  • ✅ Works for both dynamic and static beneficiaries.
  • ✅ You never have to expose the beneficiary details to the front-end layer.
  • ✅ You want your backend to be in full control of the beneficiary details.
  • ⚠️ Don't recommend for static beneficiary use cases, since it would be unnecessary additional development work on the Backend Server Side.

---

Example - When toBeneficiary Is Not Specified

Here we will pick the first account in the connection object. Remember, a bank connection might have several accounts, so the accounts object is a list. You will need to pick which account you're sending from.

await connection.CreateTransfer(connection.Accounts.First(), null, 100);

Example - When toBeneficiary Is Specified

We first need to create a new Object called Beneficiary. We will then need to set a few details about the bank account we're sending the money to.

DapiBeneficiary beneficiary = new DapiBeneficiary(
  "EBILAEAD",
  "Emirates NBD Bank PJSC",
  "John Doe",
  "AE140260000959040184901",
  "0959040184901",
  "AE",
  "Emirates NBD Bank PJSC",
  "Baniyas Road Deira PO Box 777 Dubai UAE",
  "0585859206",
  new DapiLinesAddress("baniyas road", "dubai", "united arab emirates")
);
await connection.CreateTransfer(connection.Accounts.First(), beneficiary, 100);

Example - When fromAccount Is Not Specified

await connection.CreateTransfer(null, null, 100);

The SDK shows UI for the user to select an account to send money from

Example - When amount Is Not Specified

await connection.CreateTransfer(connection.Accounts.First());

The SDK shows UI for the user to enter the amount to send

Example - When nothing is specified

await connection.CreateTransfer();

The SDK shows UI for the user to select an account to send money from then navigate to the amount screen to enter the amount to send

CreateTransferToExistingBeneficiary

📘

Note

If you use createTransferToExistingBeneficiary you have to implement bank processing logic and validations on your end. You will require the use of the following APIs to process a transaction:

• Get Account
• Create Beneficiary
• Get Beneficiaries

createTransfer abstracts all these requirements. There is no need to implement bank processing logic or validations. Dapi recommends using createTransfer to initiate a payment.

A method for sending money to an existing beneficiary.

Parameters

Example

DapiAccount account = connection?.Accounts[0];
DapiResponse<DapiBankBeneficiary[]> beneficiaries = await connection?.GetBeneficiaries();
await connection?.CreateTransferToExistingBeneficiaryFromAccount(
  beneficiaries.Data[0].Id,
  account,
  1,
  "remark"
);

🚧

Beneficiary Not Activated error on Sandbox

This error occurs If you make a transfer on Sandbox to wrong or random beneficiary details, instead you should make the beneficiary details to be of another sandbox user.

To get the beneficiary details of a sandbox user you can do the following:

1- Open your app on the dashboard and navigate to the Sandbox tab. You'll see the Sandbox Users table.
2- Click an Account from the Accounts column.
3- A dialog shows up containing beneficiary details.

CreateBeneficiary

A method for adding a new beneficiary

Parameters

Example

DapiBeneficiary beneficiary = new DapiBeneficiary(
  "EBILAEAD",
  "Emirates NBD Bank PJSC",
  "John Doe",
  "AE140260000959040184901",
  "0959040184901",
  "AE",
  "Emirates NBD Bank PJSC",
  "Baniyas Road Deira PO Box 777 Dubai UAE",
  "0585859206",
  new DapiLinesAddress("baniyas road", "dubai", "united arab emirates")
);

await connection?.CreateBeneficiary(beneficiary);

GetBeneficiaries

A method for obtaining registered beneficiaries

Parameters

Method does not receive any parameter.

Example

await connection?.GetBeneficiaries();

Response

Response Example