.png)
Creates a transfer
ENDPOINTS
post
/v1/transfers
Header parameters
Collapse
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
{"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":"2019-08-24","endDate":"2019-08-24","numberOfExecutions":0,"frequency":"ONETIME","dayOfWeek":0,"daysOfMonth":[0],"nextExecutionDate":"2019-08-24","finalExecutionDate":"2019-08-24","remainingNumberOfExecutions":0}}
Responses
Collapse
200
Success
Response Body
{"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":"2019-08-24","endDate":"2019-08-24","numberOfExecutions":0,"frequency":"ONETIME","dayOfWeek":0,"daysOfMonth":[0],"nextExecutionDate":"2019-08-24","finalExecutionDate":"2019-08-24","remainingNumberOfExecutions":0}}
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
}
}';