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.

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

Query parameters

Collapse

Expand

No items found.

Path parameters

Collapse

Expand

No items found.

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

Response Body

{"code":"string","message":"string"}

Response Body

{"code":"string","message":"string"}

Response Body

{"code":"string","message":"string"}

Response Body

{"code":"string","message":"string"}

CURL REQUEST

copy code snippetcode copiedexpand code snippetClose code snippet
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
  }
}';
Get Response

RESPONSE

copy responseexpand responseclose response
No items found.
No items found.
close

Sign in now!

Please sign up or sign in to add to watchlist

Sign in
close

Added to watchlist!

Your interest has been noted. An NCR Voyix Rep
will contact you with further details soon.