Skip to content

Get Recipient

GET
/v2/send/recipients/{recipientId}

Get details of a specific recipient

recipientId
required
string format: uuid

Recipient ID

Example
82c4fce1-d2c7-48cb-a647-6993dbe37819

Recipient details

object
id
required

Recipient ID

string format: uuid
82c4fce1-d2c7-48cb-a647-6993dbe37819
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