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 Transfer

Use Create Transfer to initiate a new payment from a user to a beneficiary.

📘

Note

For certain banks, money transfers can only be made to specific pre-approved bank accounts, called beneficiaries. In order to create a beneficiary, please see Create Beneficiaries .

Request

[POST] https://api.dapi.co/v1/payment/transfer/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.

receiverID
REQUIRED

String

An identifier for the beneficiary that will receive the money. Obtained from the Get Beneficiaries endpoint.

amount
REQUIRED

Number

Amount of money to be sent. Should be number rounded to up to 2 decimal points.

senderID
REQUIRED

String

An identifier for the bank account the user will send money from. Obtained from the Account endpoint.

remark
OPTIONAL

String

A message associated with the transfer.

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).

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

reference

String

A reference number for the transfer as provided by the financial institution.

Success

{
    "jobID": "74521eb4-34e3-4b49-9161-0edfe4683be7",
    "success": true,
    "status": "done",
    "reference": "119421587"
}

User Input Required

{
    "jobID": "32d05c2e-e1c3-458c-a59f-209488629f16",
    "success": true,
    "status": "user_input_required",
    "userInputs": [
        {
            "id": "otp"
        }
    ]
}

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

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 9 months ago


Create Transfer


Suggested Edits are limited on API Reference Pages

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