List Recipients
GET /v2/send/recipients
GET
/v2/send/recipients
List recipients with pagination and optional userId filtering
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” corridorId
required
string
userId
string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09Filter by external user ID
page[number]
number
1Page number (starts at 1)
page[size]
number
10Items per page
Responses
Section titled “ Responses ”Paginated list of recipients
object
items
required
List of recipients
Array<object>
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
page
required
Pagination info
object
number
required
Page number (starts at 1)
number
1 size
required
Items per page
number
10 totalPages
required
Total number of items
number
100 totalCount
required
Total number of pages
number
10 hasNext
required
Whether there is a next page
boolean
true hasPrev
required
Whether there is a previous page
boolean
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error