View a recipient by 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.

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
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!