Create Recipient
POST /v2/send/recipients
POST
/v2/send/recipients
Create a new recipient
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”object
corridorId
required
Corridor ID
string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09 userId
required
End user ID
string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09 displayNickName
required
Display nickname for recipient
string
John bankDetails
required
Bank details (will be tokenized)
object
Responses
Section titled “ Responses ”Created successfully
Recipient created successfully
object
id
required
Recipient ID
string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09 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