Introduction
Accounts
Update contact info
Money Movement
Disclosures
Banking Images
Authentication
Alerts
Banking Activity
Unlock User
Legacy Authentication
Reset Password
Experience Group
Customer Information
Transactions
E-Statement Reports
.png)
Creates/validates a recipient.
Create Recipient - Before a transfer can take place, a recipient record must be created and stored:
- Identify the recipient as a valid customer of the FI, with the proper account for transfer
- Identify the account to receive transfers
- Identify the recipient's email address and display nickname
- Input the recipient's passcode (needed to validate transfer execution)
- Validate the recipient (calls the Validate Recipient API)
Send the customer ID of the recipient
Send the recipient's account number to receive transfers
Send the recipient's account type
Send the recipient's passcode
- Send the customer ID of the recipient
- Send the recipient's account number to receive transfers
- Send the recipient's account typeSend the recipient's passcode
ENDPOINTS
post
/v1/recipients
Header parameters
Collapse
callingAppId
string
no
The id of the app or service calling the recipients service.
Authorization
string
required
An OAuth2 access token (in JWT format) that authorizes this request. The transactions:read and accounts:read scopes are required to access this API. Must be in the format Bearer {JWT}
transactionId
string
required
An ID that identifies this request. A unique identifier should be generated for each request made.
Body parameters
Collapse
Query parameters
Collapse
fromAccountId
string
no
The account ID of the sender.
validate
boolean
no
Validate the recipient if true, otherwise .
Responses
Collapse
200
Success
Response Body
{"recipients":[{"id":"string","institutionId":"string","institutionCustomerId":"string","memberNumber":"string","accountNumber":"string","accountType":"SAVINGS","passCode":"string","email":"string","nickName":"string","fullName":"string"}]}
400
Bad request
Response Body
{"code":"string","message":"string"}
401
Unauthorized Possible causes: - Full authentication was not provided in the request. - The authentication token that was sent in the request is invalid.
Response Body
{"code":"string","message":"string"}
403
Forbidden Possible causes: - The authentication provided does not authorize this request.
Response Body
{"code":"string","message":"string"}
500
Server error
Response Body
{"code":"string","message":"string"}
CURL REQUEST
curl -X 'POST' \
'https://api.candescent.com/digitalbanking/db-recipients/v1/recipients' \
-H 'transactionid: SOME_STRING_VALUE' \
-H 'authorization: SOME_STRING_VALUE' \
-H 'callingappid: SOME_STRING_VALUE' \
-H 'accept: application/json' \ RESPONSE
