---
title: "View a recipient by recipientRef"
method: GET
path: "/payout/v3/recipient/recipientRef/{recipientRef}"
tags: ["Recipients"]
---

# View a recipient by recipientRef

`GET /payout/v3/recipient/recipientRef/{recipientRef}`

Searches for recipients with the specified `recipientRef`.

<!-- theme: info -->
> 📘 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](https://docs.nexiopay.com/reference/viewrecipientbyrecipientid) endpoint.
> - To view a recipient using other IDs or parameters, use the [View recipients](https://docs.nexiopay.com/reference/viewrecipients) endpoint.

<!-- theme: warning -->
> ⚠️ Try It
> 
> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).<br/><br/>Include the `recipientRef` in the path parameter of the request.

<div style="display:none;">

## 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

</div>

## Response `200`

OK

- Schema — unresolved $ref

## Other responses

- `401` — Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) · [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nexiopay/payments-api-reference/revisions/b414b73979e5/schema)