Beneficiaries

post
Get Beneficiaries

https://api.dapi.co/v1/payment/GetBeneficiaries
Request
Response
Request
Headers
Authorization
required
string
Bearer <accessToken>
Body Parameters
userSecert
required
string
User Secret from Connect
type
required
string
same, local, intl type of beneficiary
addresses
optional
array
Specify which webhook URL(s) defined in app settings to send data to. If empty, an update will be sent to all defined webhook urls
sync
optional
boolean
true or false, if set the connection is maintained till the result is returned
appSecret
required
string
App Secret from the dashboard
Response
200: OK
{
"jobID": "8b47a478-bb4a-4413-81db-122b9de6adf3",
"success": true,
"msg": "Job Finished",
"result": {
"beneficiaries": [
{
"name": "Aziz Ahmad",
"iban": "FTQ72AEDB20201555555893",
"accountNumber": "0201555555893",
"type": "local",
"id": "FYvMqo0sQhBK8K7S2nmariYVKXinaX7hFY+OaI31TJVprMGs/FP3KkXGwUYBLNwHLmeUdgqoOE3gz5ak+opvSg=="
},
{
"name": "Omar Shahin",
"type": "local",
"iban": "FTQ72AEDB202015555551241",
"accountNumber": "02015454555893",
"id": "wKY6EmyG5WP5wH5ay0G+ExjW787Z/cVBIfWQJexj8wbxjqY9CoXJxIfMyyAcsX6EIwrLmsCv6+mJnhvwdtHayg=="
}
]
},
"done": true
}
202: Accepted
// Asynchronous response
{
"jobID": "83515136-9146-523a-9936-3229d51fd49d",
"msg": "Job Intitalized",
"success": null
}
422: Unprocessable Entity
{
"msg": "Parameters validation error!",
"success": false,
"field": "appSecret",
"err": "The 'appSecret' field is required!"
}

post
Add Beneficiary

https://api.dapi.co/v1/payment/AddBeneficiary
Request
Response
Request
Headers
Authorization
required
string
Bearer <accessToken>
Body Parameters
userSecret
required
string
User Secret from Connect
swiftCode
optional
string
The swift code of the beneficiary's bank. It's required when the type of beneficiary is local or intl
bankName
optional
string
The bank name of the beneficiary. It's required when the type of beneficiary is local or intl
name
required
string
The name of the beneficiary to be added
beneficiaryAccountNumber
required
string
The account number of the beneficiary. In the case of local and intl beneficiaries, the accountNumber is the IBAN.
type
required
string
same, local, intl type of beneficiary
addresses
optional
array
Webhook URL(s) to send data to. If empty an update will be sent to all webhook urls defined in app settings
sync
optional
boolean
true or false, if set the connection is maintained till the result is returned
appSecret
required
string
App Secret from the dashboard
Response
200: OK
// Synchronous and Webhook Response
{
"jobID": "290af268-62ea-5ce7-81ac-bef8af52f967",
"success": true,
"msg": "Job Initialized",
"result": {
"success": true,
"msg": "Smartpass token is required!"
},
"done": false
}
202: Accepted
// Asynchronous response
{
"jobID": "83515136-9146-523a-9936-3229d51fd49d",
"msg": "Job Intitalized",
"success": null
}
422: Unprocessable Entity
{
"msg": "Parameters validation error!",
"success": false,
"field": "appSecret",
"err": "The 'appSecret' field is required!"
}

post
Add Beneficiary Resumption

https://api.dapi.co/v1/payment/AddBeneficiary
Request
Response
Request
Headers
Authorization
required
string
Bearer <accessToken>
Body Parameters
otp
required
string
OTP code from user
jobID
required
string
A job UUID returned from the first AddBeneficiary call
addresses
optional
array
Webhook URL(s) to send data to. If empty an update will be sent to all webhook urls defined in app settings
sync
optional
boolean
true or false, if set the connection is maintained till the result is returned
appSecret
required
string
App Secret from the dashboard
Response
200: OK
// Synchronous and Webhook Response
{
"jobID": "290af268-62ea-5ce7-81ac-bef8af52f967",
"success": true,
"msg": "Job Finished",
"result": {
"success": true,
"msg": "Beneficiary added successfully"
},
"done": true
}
202: Accepted
// Asynchronous response
{
"jobID": "290af268-62ea-5ce7-81ac-bef8af52f967",
"msg": "Job Resumed",
"success": null
}
422: Unprocessable Entity
{
"msg": "Parameters validation error!",
"success": false,
"field": "appSecret",
"err": "The 'appSecret' field is required!"
}