Returns all recipients that meet the specified parameters (if any) and that are associated with the Nexio account used to authenticate.
You may also request to return additional parameters and/or filter results using one or more query parameters.
📘
Notes
For example, to return (filter) all recipients where the address' country is NL and also (request to include) the recipientIdNumbers object in the response, the request would look like this: /payout/v3/recipient?recipientIdNumbers.&country=NL
To return (filter) only the recipient with the specified recipientRef parameter, the request would look like this: /payout/v3/recipient?recipientRef=10524260
For a more detailed tutorial, see the query parameters section of Guides.
⚠️
Try It
To use the Try It feature for this endpoint, you must use your own Sandbox credentials.
Request parameters
limit
offset
startDate
endDate
recipientId
recipientRef
providerRecipientRef
providerType
email
firstName
lastName
phoneNumber
mobileNumber
addressLine1
addressLine2
city
region
postalCode
country
countryOfBirth
countryOfNationality
providerId
payoutAccountId
recipientIdNumbers
recipientIdNumbers.governmentId
recipientIdNumbers.passportId
recipientIdNumbers.employerId
recipientIdNumbers.driversLicenseId
userType
birthDate
gender
addressType
phoneNumberCountry
mobileNumberCountry
governmentIdType
createdAt
updatedAt
Response parameters
offset
limit
rows
rows.recipientRef
rows.recipientId
rows.payoutAccountId
rows.providerId
rows.providerType
rows.providerRecipientRef
rows.userType
rows.firstName
rows.lastName
rows.gender
rows.birthDate
rows.countryOfBirth
rows.countryOfNationality
rows.addressLine1
rows.addressLine2
rows.city
rows.region
rows.postalCode
rows.country
rows.email
rows.phoneNumber
rows.mobileNumber
rows.governmentIdType
rows.recipientIdNumbers
rows.recipientIdNumbers.governmentId
rows.recipientIdNumbers.passportId
rows.recipientIdNumbers.employerId
rows.recipientIdNumbers.driversLicenseId
rows.createdAt
rows.updatedAt
hasMore
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!