DapiUS

The DapiUS Developer Hub

Welcome to the DapiUS developer hub. You'll find comprehensive guides and documentation to help you start working with DapiUS as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Get Beneficiaries

Use Get Beneficiaries to access the beneficiaries already added for a user within a financial institution.

Request

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

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

Parameter

Type

Description

appSecret
REQUIRED

String

Private token generated at application creation.

userSecret
REQUIRED

String

Encrypted version of the userKey.

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

beneficiaries

Array<Beneficiaries>

Returns beneficiary information per beneficiary, such as their name, iban, account number, type, and ID.

userInputs

Array<UserInputs>

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

Beneficiaries schema

Parameter

Type

Description

name

String

Beneficiary's name.

iban

String

Beneficiary's IBAN.

accountNumber

String

Beneficiary's account number.

status

Enum( "approved", "rejected", "cancelled", "waiting_for_confirmation", "modified_for_pending_approval" )

Status of beneficiary with the financial institution.

type

Enum( "same", "local", "intl" )

Beneficiary's type.

id

String

Beneficiary's unique identifier.

Success

{
    "jobID": "c90da2a2-18fa-4ae8-afe0-73f2aa4fc7de",
    "success": true,
    "status": "done",
    "beneficiaries": [
        {
            "name": "Aziz Ahmad",
            "iban": "FTQ72AEDB20201555555893",
            "accountNumber": "0201555555893",
            "type": "same",
            "status": "approved",
            "id": "CqOWurgxKH5KkrGwtg3jM1U0/MOj9BLYvgQx0DFrClAxwtynwEYHs0FxX/tFPM4kYav0wgGtdiliF3GPMsLwLw=="
        }
    ]
}

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"
        }
    ]
}

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

Get Beneficiaries


Suggested Edits are limited on API Reference Pages

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