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)
Retrieves a list of recipients
After one or more recipient records are created, the list can be retrieved:
- Commonly used in the context of creating a list of recipients to be selected during a transfer.
- Retrieves all recipient records created by a given customer, along with their associated data
ENDPOINTS
get
/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
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 'GET' \
'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
