---
title: "Update recipient"
method: PUT
path: "/payout/v3/recipient"
tags: ["Recipients"]
---

# Update recipient

`PUT /payout/v3/recipient`

This endpoint is used to update information for an existing payout recipient.

<!-- theme: warning -->
> 🛑 Important
> 
> You can only update a recipient record if the request is accepted by the payout provider associated with the `recipientId`.

<!-- theme: info -->
> 📘 Note 
> 
> For the payout provider Interchecks, if you pass a value for one of the `recipientIdNumbers` parameters when creating a new recipient, you cannot update any recipient information with this endpoint.<br/><br/>In the case that a value has been passed for the `recipientIdNumbers` and you are wanting to change information for an existing Interchecks recipient, contact Interchecks to update the recipient's information.

<!-- 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 at least a `recipienId` and recipient `firstName` and `lastName`.


<div style="display:none;">

## Request parameters
- recipientId
- firstName
- lastName
- recipientIdNumbers
- recipientIdNumbers.governmentId
- recipientIdNumbers.passportId
- recipientIdNumbers.employerId
- recipientIdNumbers.driversLicenseId
- providerId
- recipientRef
- email
- userType
- gender
- birthDate
- countryOfBirth
- countryOfNationality
- country
- currency
- addressType
- addressLine1
- addressLine2
- city
- region
- postalCode
- phoneNumber
- phoneNumberCountry
- mobileNumber
- mobileNumberCountry

## Response parameters
- payoutAccountId
- providerId
- recipientId
- recipientRef
- email
- firstName
- lastName
- providerType
- providerRecipientRef
- userType
- addressLine1
- addressLine2
- city
- region
- postalCode
- country
- phoneNumber
- mobileNumber
- countryOfBirth
- countryOfNationality
- gender
- birthDate
- recipientRulesMetadata
- recipientRulesMetadata.id
- recipientRulesMetadata.recipientId
- recipientRulesMetadata.metadata
- recipientRulesMetadata.createdAt
- recipientRulesMetadata.updatedAt
- recipientIdNumbers
- recipientIdNumbers.governmentId
- recipientIdNumbers.passportId
- recipientIdNumbers.employerId
- recipientIdNumbers.driversLicenseId
- createdAt
- updatedAt

</div>

## Request body

- object
  - `recipientId` integer, required — The Nexio ID for the recipient.
  - `firstName` string, required — The recipient's first name. For testing purposes with the Mock Payout account, you can trigger a timeout error by sending `firstName` with a value of `timeout`. You can trigger a server error by sending `firstName` with a value of `server` (along with the appropriate value for `lastName`).
  - `lastName` string, required — The recipient's last name. For testing purposes with the Mock Payout account, you can trigger a server error by sending `lastName` with a value of `error` (along with the appropriate value for `firstName`).
  - `recipientIdNumbers` object — Contains any specified IDs for the recipient.
    - `governmentId` string — The recipient's government ID. This value corresponds to the selection for the `governmentIdType` parameter.
    - `passportId` string — The recipient's passport ID.
    - `driversLicenseId` string — The recipient's driver's license number. This value cannot be updated once the recipient has been verified in the payment provider’s system.
    - `employerId` string — The recipient's employer ID. This is generally used for tax purposes.
  - `providerId` integer — The Nexio ID for the provider. Indicates which payout provider to associate with this recipient profile. If no providerId is specified in the request, the system uses the first listed payout provider for the merchant account. For information about the possible providers and provider IDs for your account, contact [Integrations Support](https://docs.nexiopay.com/page/contact-us).
  - `recipientRef` string — Payer's unique reference value for the recipient. This allows for easier synchronization and searching across different systems.
  - `email` string — The recipient's email address. This must be unique to the specified payout provider (where the provider is indicated in the `providerId` parameter).
  - `userType` 'BUSINESS' | 'INDIVIDUAL' — The user type associated with the recipient. <!-- INTERNAL NOTE: Payquicker, HyperWallet -->
  - `gender` 'FEMALE' | 'MALE' — The recipient's gender. <!-- INTERNAL NOTE: Payquicker Only -->
  - `birthDate` string — The recipient's date of birth. Use any of the following formats for the date: - Four-digit year and two-digit month and day, separated with hyphens: YYYY-MM-DD.<br>For example, 2001-08-26 - [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.<br>For example, 2001-08-26T13:35:00Z - UNIX date (as an integer representing seconds).<br>For example, 998854500 <!-- INTERNAL NOTE: Payquicker, HyperWallet -->
  - `countryOfBirth` string — The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the country where the recipient was born.
  - `countryOfNationality` string — The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the recipient's country of citizenship or nationality.
  - `country` string — The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the recipient's address.
  - `currency` string — The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the payout to the specified recipient.
  - `addressType` 'BUSINESS' | 'RESIDENTIAL' — The type of address associated with this recipient for the specified address information. <!-- INTERNAL NOTE: Payquicker Only -->
  - `addressLine1` string — The recipient's street address.
  - `addressLine2` string — Additional information about the recipient's street address.
  - `city` string — The recipient's city.
  - `region` string — The recipient's state, province, or region.
  - `postalCode` string — The recipient's postal code.
  - `phoneNumber` string — The recipient's phone number.
  - `phoneNumberCountry` string — The country associated with the recipient's phone number.
  - `mobileNumber` string — The recipient's mobile phone number.
  - `mobileNumberCountry` string — The country associated with the mobile phone number.

## Response `200`

OK

- object
  - `payoutAccountId` string — The Nexio ID for the payout account associated with the webhooks. This parameter is only returned when the request included the `payoutAccountId` parameter. Either this parameter or `merchantId` is returned.
  - `providerId` integer — The Nexio ID for the provider. Indicates the payout provider associated with this recipient profile.
  - `recipientId` RecipientId — unresolved $ref
  - `recipientRef` RecipientRef — unresolved $ref
  - `email` string — The recipient's email address.
  - `firstName` FirstName — unresolved $ref
  - `lastName` LastName — unresolved $ref
  - `providerType` ProviderType — unresolved $ref
  - `providerRecipientRef` string — Reference value for the payout from the payout provider. This allows for easier synchronization and searching across different systems.
  - `userType` UserType — unresolved $ref
  - `addressLine1` AddressLine1 — unresolved $ref
  - `addressLine2` AddressLine2 — unresolved $ref
  - `city` City — unresolved $ref
  - `region` Region — unresolved $ref
  - `postalCode` PostalCode — unresolved $ref
  - `country` Country — unresolved $ref
  - `phoneNumber` PhoneNumber — unresolved $ref
  - `mobileNumber` MobileNumber — unresolved $ref
  - `countryOfBirth` CountryOfBirth — unresolved $ref
  - `countryOfNationality` CountryOfNationality — unresolved $ref
  - `gender` Gender — unresolved $ref
  - `birthDate` string — The recipient's date of birth, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date. <!-- INTERNAL NOTE: Payquicker, HyperWallet -->
  - `recipientRulesMetadata` object — A list of additional recipient information.
    - `id` integer — A unique ID generated by Nexio when rules are being applied to a recipient.
    - `recipientId` RecipientId — unresolved $ref
    - `metadata` string — A list of rules that are applied to a recipient account based on their account information.
    - `createdAt` CreatedAt — unresolved $ref
    - `updatedAt` UpdatedAt — unresolved $ref
  - `recipientIdNumbers` object — Contains any specified IDs for the recipient.
    - `driversLicenseId` string — The masked driver's license number for the recipient. This value cannot be updated once the recipient has been verified in the payment provider’s system.
    - `employerId` string — The masked employer ID for the recipient. This is generally used for tax purposes.
    - `governmentId` string — The masked government ID for the recipient. See the `governmentIdType` parameter for the type of government ID specified here. This value cannot be updated once the recipient has been verified in the payment provider’s system. <!-- [GGG figure out if this is true] -->
    - `passportId` string — The masked passport ID for the recipient. This value cannot be updated once the recipient has been verified in the payment provider’s system.
  - `createdAt` string — The date and time the payout request was sent to the provider, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.
  - `updatedAt` string — The date and time the payout record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.

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