Create Recipient
POST /v2/send/recipients
POST
/v2/send/recipients
Create a new recipient
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ” X-API-Key
string
API Key
X-API-Secret
string
API Secret
Request Body required
Section titled “Request Body required ”object
userId
required
End user ID
string format: uuid
e271bc5c-f870-44cd-8462-54280d0411f6 displayNickName
required
Display nickname for recipient
string
John bankDetails
required
Bank details (will be tokenized)
object
Responses
Section titled “ Responses ”Recipient created successfully
object
id
required
Recipient ID
string format: uuid
e271bc5c-f870-44cd-8462-54280d0411f6 organisationId
required
Organisation ID
string format: uuid
userId
required
User ID
string format: uuid
displayNickName
required
Display nickname for recipient
string
John tokenizationId
required
Tokenization ID from Aegis vault
string
bankDetails
required
Bank details (detokenized)
object
createdAt
required
Created at
string format: date-time
updatedAt
required
Updated at
string format: date-time
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error