Beneficiaries

post
Get Beneficiaries

https://api.dapi.co/v1/payment/beneficiaries/get
Request
Response
Request
Headers
Authorization
required
string
Bearer <accessToken>
Body Parameters
userSecert
required
string
User Secret from Connect
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. Default is false
appSecret
required
string
App Secret from the dashboard
Response
200: OK
{
"jobID": "8b47a478-bb4a-4413-81db-122b9de6adf3",
"success": true,
"status": "done",
"beneficiaries": [
{
"name": "Aziz Ahmad",
"iban": "FTQ72AEDB20201555555893",
"accountNumber": "0201555555893",
"status": "approved",
"type": "local",
"id": "FYvMqo0sQhBK8K7S2nmariYVKXinaX7hFY+OaI31TJVprMGs/FP3KkXGwUYBLNwHLmeUdgqoOE3gz5ak+opvSg=="
},
{
"name": "Omar Shahin",
"type": "same",
"status": "rejected",
"iban": "FTQ72AEDB202015555551241",
"accountNumber": "02015454555893",
"id": "wKY6EmyG5WP5wH5ay0G+ExjW787Z/cVBIfWQJexj8wbxjqY9CoXJxIfMyyAcsX6EIwrLmsCv6+mJnhvwdtHayg=="
}
]
}
202: Accepted
// Asynchronous response
{
"jobID": "83515136-9146-523a-9936-3229d51fd49d",
"status": "initialized"
}
422: Unprocessable Entity
{
"success": false,
"status": "error",
"message": "The 'appSecret' field is required!"
}

post
Add Beneficiary

https://api.dapi.co/v1/payment/beneficiaries/create
Request
Response
Request
Headers
Authorization
required
string
Bearer <accessToken>
Body Parameters
address
required
object
The address of the beneficiary with keys of line1, line2 and line3. Note: The values shouldn't have commas in it. {"line1": "STREET NO", "line2": "CITY", "line3": "COUNTRY"}
country
required
string
The name of the country in full caps eg 'UNITED ARAB EMIRATES'
sortCode
required
string
The sort code of the bank.
branchAddress
required
string
The branch address of the bank's branch.
branchName
required
string
The branch name of the bank.
phoneNumber
required
string
The phone number of the beneficiary.
iban
required
string
The IBAN of the beneficiary.
userSecret
required
string
User Secret from Connect
swiftCode
required
string
The swift code of the beneficiary's bank. It's required when the type of beneficiary is local or intl
bankName
required
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
accountNumber
required
string
The account number of the beneficiary.
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,
"status": "user_input_required",
"userInputs": [{
"id": "otp",
"query": "Please input Smartpass token"
}]
}
202: Accepted
// Asynchronous response
{
"jobID": "290af268-62ea-5ce7-81ac-bef8af52f967",
"msg": "Job Resumed",
"success": null
}
422: Unprocessable Entity
{
"success": true,
"status": "error",
"message": "The 'appSecret' field is required!"
}

post
Add Beneficiary Resumption

https://api.dapi.co/v1/job/resume
Request
Response
Request
Headers
Authorization
required
string
Bearer <accessToken>
Body Parameters
address
required
object
The address of the beneficiary with keys of line1, line2 and line3. Note: The values shouldn't have commas in it. {"line1": "STREET NO", "line2":"CITY", "line3":"COUNTRY"}
type
required
string
same, local and intl type of beneficiary.
accountNumber
required
string
The account number of the beneficiary.
name
required
string
The name of the beneficiary to be added.
bankName
required
string
The beneficiary's bank name.
swiftCode
required
string
The beneficiary's bank's swift code.
iban
required
string
The IBAN of the beneficiary to be added.
phoneNumber
required
string
The phone number of the beneficiary.
country
required
string
The country of the beneficiary's bank in full caps, eg 'UNITED ARAB EMIRATES'
sortCode
required
string
The sort code of the beneficiary's bank.
branchAddress
required
string
The address of the beneficiary's bank's branch.
branchName
required
string
The branch name of the beneficiary's bank.
userInputs
required
object
An array of objects containing the key 'id' coming from the userInputs and the value containing the input from the user, for example {"otp": "12345"}
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,
"status": "done",
}
202: Accepted
// Asynchronous response
{
"jobID": "290af268-62ea-5ce7-81ac-bef8af52f967",
"msg": "Job Resumed",
"success": null
}
422: Unprocessable Entity
{
"success": true,
"status": "error",
"message": "The 'appSecret' field is required!"
}