Create Recipient
Loading...
API endpoint path: /db-recipients/v1/recipients
Creates a new recipient record and optionally validates the provided information. Use this endpoint to add new payees that can receive transfers.
Validation:
Set validate=true query parameter to validate the recipient exists at the institution
before saving. This performs a "lucky transfer" test to verify the account.
Request
Responses
- 200
- 400
- 401
- 403
- 500
Success
Bad request
Unauthorized Possible causes:
- Full authentication was not provided in the request.
- The authentication token that was sent in the request is invalid.
Forbidden Possible causes:
- The authentication provided does not authorize this request.
Server error