API Reference

View a recipient by recipientRef

get
https://api.nexiopaysandbox.com/payout/v3/recipient/recipientRef/

Searches for recipients with the specified recipientRef.

Notes

  • You can only use recipientRef as the path parameter for this endpoint.
  • When searching for a recipient by recipientId use the View a recipient by recipientId endpoint.
  • To view a recipient using other IDs or parameters, use the View recipients endpoint.

Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

Include the recipientRef in the path parameter of the request.

Request parameters

  • recipientRef

Response parameters

  • recipientRef
  • recipientId
  • payoutAccountId
  • providerId
  • providerType
  • providerRecipientRef
  • userType
  • firstName
  • lastName
  • gender
  • birthDate
  • countryOfBirth
  • countryOfNationality
  • addressLine1
  • addressLine2
  • city
  • region
  • postalCode
  • country
  • email
  • phoneNumber
  • mobileNumber
  • governmentIdType
  • recipientIdNumbers
  • recipientIdNumbers.governmentId
  • recipientIdNumbers.passportId
  • recipientIdNumbers.employerId
  • recipientIdNumbers.driversLicenseId
  • createdAt
  • updatedAt
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 100

Payer's unique reference value for the recipient.

Responses

Updated 7 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago