Main menu
Introduction

Accounts

Update contact info

Money Movement

Disclosures

Banking Images

Authentication

Alerts

Legacy Authentication

Reset Password

E-Statements

Experience Group

Banking

Customer Information

E-Statement Reports

.png)
Creates a transfer
The service uses a oauth2 authentication token and for transfers requires the token to be generated with the scopes accounts:read, transfers:write in the body.
ENDPOINTS
post
/v1/transfers
Header parameters
Collapse
Expand
Authorization
string
required
An OAuth2 access token that authorizes this request.
transactionId
string
required
An ID that identifies this request. A unique identifier should be generated for each request made.
Body parameters
Collapse
Expand
No items found.
- { …
- "amount" : { …,
- "amount" : 0,
- "currencyCode" : "AED"
- "confirmation" : "string",
- "fee" : { …,
- "amount" : 0,
- "currencyCode" : "AED"
- "fromAccountHolderId" : "string",
- "fromAccountId" : "string",
- "id" : "string",
- "memo" : "string",
- "notificationMessage" : "string",
- "paymentOption" : "DEFAULT",
- "payoffAmount" : { …,
- "amount" : 0,
- "currencyCode" : "AED"
- "previousYearContribution" : true,
- "schedule" : { …,
- "dayOfWeek" : 0,
- "daysOfMonth" : [ …,
- "0" : 0
- "endDate" : "2019-08-24",
- "finalExecutionDate" : "2019-08-24",
- "frequency" : "ONETIME",
- "lifeType" : "ENDDATE",
- "nextExecutionDate" : "2019-08-24",
- "numberOfExecutions" : 0,
- "remainingNumberOfExecutions" : 0,
- "startDate" : "2019-08-24"
- "status" : "SUCCESS",
- "toAccountHolderId" : "string",
- "toAccountId" : "string"
- "amount" :
Query parameters
Collapse
Expand
No items found.
Path parameters
Collapse
Expand
No items found.
Responses
Collapse
Expand
200
Success
Response Body
- { …
- "amount" : { …,
- "amount" : 0,
- "currencyCode" : "AED"
- "confirmation" : "string",
- "fee" : { …,
- "amount" : 0,
- "currencyCode" : "AED"
- "fromAccountHolderId" : "string",
- "fromAccountId" : "string",
- "id" : "string",
- "memo" : "string",
- "notificationMessage" : "string",
- "paymentOption" : "DEFAULT",
- "payoffAmount" : { …,
- "amount" : 0,
- "currencyCode" : "AED"
- "previousYearContribution" : true,
- "schedule" : { …,
- "dayOfWeek" : 0,
- "daysOfMonth" : [ …,
- "0" : 0
- "endDate" : "2019-08-24",
- "finalExecutionDate" : "2019-08-24",
- "frequency" : "ONETIME",
- "lifeType" : "ENDDATE",
- "nextExecutionDate" : "2019-08-24",
- "numberOfExecutions" : 0,
- "remainingNumberOfExecutions" : 0,
- "startDate" : "2019-08-24"
- "status" : "SUCCESS",
- "toAccountHolderId" : "string",
- "toAccountId" : "string"
- "amount" :
400
Client error
Response Body
- { …
- "code" : "string",
- "message" : "string"
401
Authentication error
Response Body
- { …
- "code" : "string",
- "message" : "string"
403
Authorization error
Response Body
- { …
- "code" : "string",
- "message" : "string"
500
Server error
Response Body
- { …
- "code" : "string",
- "message" : "string"
curl -X 'POST' \
'https://api.candescent.com/digitalbanking/db-transfers/v1/transfers' \
-H 'transactionid: SOME_STRING_VALUE' \
-H 'authorization: SOME_STRING_VALUE' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
"fromAccountHolderId": "string",
"toAccountHolderId": "string",
"fromAccountId": "string",
"toAccountId": "string",
"amount": {
"currencyCode": "AED",
"amount": 0
},
"memo": "string",
"paymentOption": "DEFAULT",
"previousYearContribution": true,
"status": "SUCCESS",
"confirmation": "string",
"fee": {
"currencyCode": "AED",
"amount": 0
},
"payoffAmount": {
"currencyCode": "AED",
"amount": 0
},
"notificationMessage": "string",
"id": "string",
"schedule": {
"lifeType": "ENDDATE",
"startDate": "2025-04-10",
"endDate": "2025-04-10",
"numberOfExecutions": 0,
"frequency": "ONETIME",
"dayOfWeek": 0,
"daysOfMonth": [
0
],
"nextExecutionDate": "2025-04-10",
"finalExecutionDate": "2025-04-10",
"remainingNumberOfExecutions": 0
}
}';
No items found.
No items found.