Sign in
Recipients

Update 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.<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>
put/payout/v3/recipient

Request body

recipientIdinteger required

The Nexio ID for the recipient.

firstNamestring 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).

lastNamestring 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).

providerIdinteger

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.

recipientRefstring

Payer's unique reference value for the recipient. This allows for easier synchronization and searching across different systems.

emailstring

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

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

The two-character (Alpha-2) ISO code for the country where the recipient was born.

countryOfNationalitystring

The two-character (Alpha-2) ISO code for the recipient's country of citizenship or nationality.

countrystring

The two-character (Alpha-2) ISO country code for the recipient's address.

currencystring

The three-character ISO currency code 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 -->
addressLine1string

The recipient's street address.

addressLine2string

Additional information about the recipient's street address.

citystring

The recipient's city.

regionstring

The recipient's state, province, or region.

postalCodestring

The recipient's postal code.

phoneNumberstring

The recipient's phone number.

phoneNumberCountrystring

The country associated with the recipient's phone number.

mobileNumberstring

The recipient's mobile phone number.

mobileNumberCountrystring

The country associated with the mobile phone number.

Example request

{
  "recipientId": 137256,
  "firstName": "John",
  "lastName": "Doe",
  "recipientIdNumbers": {
    "governmentId": "1234567891",
    "passportId": "4561231232",
    "employerId": "2468013579"
  },
  "recipientRef": "[your_recipient_id]",
  "email": "jdoe@example.com",
  "userType": "INDIVIDUAL",
  "gender": "MALE",
  "birthDate": "1990-12-05",
  "countryOfBirth": "US",
  "countryOfNationality": "US",
  "country": "US",
  "currency": "USD",
  "addressType": "RESIDENTIAL",
  "addressLine1": "2147 West Silverlake Drive",
  "addressLine2": "Apt 42",
  "city": "Scranton",
  "region": "PA",
  "postalCode": "18503",
  "phoneNumber": "1555555555",
  "phoneNumberCountry": "US",
  "mobileNumber": "1555555555",
  "mobileNumberCountry": "US"
}

Response

OK

payoutAccountIdstring

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.

providerIdinteger

The Nexio ID for the provider. Indicates the payout provider associated with this recipient profile.

recipientIdRecipientId — unresolved $ref
recipientRefRecipientRef — unresolved $ref
emailstring

The recipient's email address.

firstNameFirstName — unresolved $ref
lastNameLastName — unresolved $ref
providerTypeProviderType — unresolved $ref
providerRecipientRefstring

Reference value for the payout from the payout provider. This allows for easier synchronization and searching across different systems.

userTypeUserType — unresolved $ref
addressLine1AddressLine1 — unresolved $ref
addressLine2AddressLine2 — unresolved $ref
cityCity — unresolved $ref
regionRegion — unresolved $ref
postalCodePostalCode — unresolved $ref
countryCountry — unresolved $ref
phoneNumberPhoneNumber — unresolved $ref
mobileNumberMobileNumber — unresolved $ref
countryOfBirthCountryOfBirth — unresolved $ref
countryOfNationalityCountryOfNationality — unresolved $ref
genderGender — unresolved $ref
birthDatestring

The recipient's date of birth, formatted as an ISO-8601 date.

<!-- INTERNAL NOTE: Payquicker, HyperWallet -->
createdAtstring

The date and time the payout request was sent to the provider, formatted as an ISO-8601 date expressed in UTC.

updatedAtstring

The date and time the payout record was most recently updated in Nexio, formatted as an ISO-8601 date expressed in UTC.

Changes

No recorded changes to this endpoint across all 1 revision of this API.