Welcome to Dapi

Here you will find comprehensive documentation to help you integrate with Dapi's API as quickly as possible, as well as support if you get stuck. Get started below!

Get Started    

Create Beneficiary

Use Create Beneficiaries to add a new beneficiary to enable transfers from the user's account to the beneficiary's.

Request

[POST] https://api.dapi.co/v1/payment/beneficiaries/create

Headers

Parameter

Type

Description

Authorization
REQUIRED

String

Set type to bearer token and the value to the accessToken obtained using the Exchange Token request.

Body Parameters

🚧

Warning

Required parameters may be different for certain banks. For more information, see Exceptions.

Parameter

Type

Description

appSecret
REQUIRED

String

Private token generated at application creation.

userSecret
REQUIRED

String

Encrypted version of the userKey.

name
REQUIRED

String

Name of the beneficiary.

accountNumber
REQUIRED

String

Account number of the beneficiary.

type
REQUIRED

String

Type of beneficiary. Can be set to same if the beneficiary's bank is the same as the sender's, local if the beneficiary's bank is in the same country, or intl if the beneficiary's bank is in a different country.

address
REQUIRED

Object<Address>

An object containing the address information of the beneficiary.

country
REQUIRED

String

Name of the country in all uppercase letters (e.g. “UNITED ARAB EMIRATES”).

sortCode
OPTIONAL

String

Financial institution’s sort code.

branchAddress
REQUIRED

String

Address of the financial institution’s specific branch.

branchName
REQUIRED

String

Name of the financial institution’s specific branch.

phoneNumber
REQUIRED

String

Beneficiary's phone number.

iban
REQUIRED

String

Beneficiary's IBAN number.

swiftCode
REQUIRED

String

Beneficiary's financial institution's SWIFT code.

sync
OPTIONAL

Boolean

Set to true so the connection is maintained until the job is complete (synchronous response).

addresses
OPTIONAL

Array<String>

Specify which webhook URL(s) defined in app settings to send data to. If empty, an update will be sent to all defined webhook URL(s).

Address schema

Parameter

Type

Description

line1
REQUIRED

String

Street name and number. Note: value should not contain any commas or special characters.

line2
REQUIRED

String

City name. Note: value should not contain any commas or special characters.

line3
REQUIRED

String

Country name. Note: value should not contain any commas or special characters.

🚧

Warning

If the response status is user_input_required send another request to continue the operation with the required userInputs and jobID from the previous request response. For more information, see Job Resume.

Response

📘

Note

Your responses may differ from those listed below on a case-by-case basis.

Parameter

Type

Description

jobID

String

Unique ID generated to identify a specific operation.

success

Boolean

Returns true if request is successful and false for all else.

status

Enum( "done", "failed", "user_input_required", "initialized" )

The status of the job. For further explanation see Job Status

userInputs

Array<UserInputs>

Specifies the type of further information required from the user before the job can be completed.

User Input Required

{
    "jobID": "47204fa6-dca6-44a5-8111-6c6489a232a2",
    "success": true,
    "status": "user_input_required",
    "userInputs": [
        {
            "id": "otp",
            "query": "Please enter the One Time Password sent to your registered mobile number"
        }
    ]
}

For more information on handling user input, please see User Inputs.

Job Complete

{
    "jobID": "3b74fcb5-56c2-4664-a010-39769ebfbcec",
    "success": true,
    "status": "done"
}

Error

{
    “success”: false,
    “msg”: “Invalid JSON request”,
    “type”: “INVALID_JSON”
}
{
    "success": false,
    "msg": "Invalid/expired token, invalid secret or invalid connectionID"
}

📘

Note

For more information and detailed breakdown of possible errors, please see Errors.

Updated 7 months ago

Create Beneficiary


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.