Skip to content

Get Recipient

GET
/v2/send/recipients/{recipientId}

Get details of a specific recipient

recipientId
required
string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09

Recipient ID

Recipient details

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