Sign in
Recipients

Create a recipient

Creates a recipient profile to which payments can be sent. A recipient is the individual or business receiving payments. Before paying out to a recipient, you must first create a recipient profile, either as a separate process or at the same time as the payout request.

<!-- 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 Update recipient endpoint.

<!-- 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 recipientRef, recipient email, recipient firstName and lastName, and the country for the recipient.

<div style="display:none;">

Request parameters

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

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>
post/payout/v3/recipient

Request body

recipientRefstring required

Your unique identifier for a recipient. This allows for easier synchronization across different systems.

<!-- theme: warning -->

Important

We strongly recommend that you include this value in your request in order to facilitate payment reconciliation.

emailEmail required— unresolved $ref
firstNameFirstName required— unresolved $ref
lastNameLastName required— unresolved $ref
countryCountry required— unresolved $ref
providerIdProviderId — unresolved $ref
userTypeUserType — unresolved $ref
genderGender — unresolved $ref
birthDateBirthDate — unresolved $ref
countryOfBirthCountryOfBirth — unresolved $ref
countryOfNationalityCountryOfNationality — unresolved $ref
currencystring
<!-- INTERNAL NOTE: Payquicker -->

The three-character ISO currency code for payouts to the specified recipient.

<!-- theme:info -->

Note

We pass this value through to the payout provider, but we do not save or return it in the response.

addressTypeAddressType — unresolved $ref
addressLine1AddressLine1 — unresolved $ref
addressLine2AddressLine2 — unresolved $ref
cityCity — unresolved $ref
regionRegion — unresolved $ref
postalCodePostalCode — unresolved $ref
phoneNumberPhoneNumber — unresolved $ref
phoneNumberCountryPhoneNumberCountry — unresolved $ref
mobileNumberMobileNumber — unresolved $ref
mobileNumberCountryMobileNumberCountry — unresolved $ref
governmentIdTypestring

Type of the government ID provided for the recipient.

<!-- INTERNAL NOTE: Payquicker, HyperWallet --> <!-- Possible types are the following: [GGG For PayQuicker, so not adding in yet) - PASSPORT - NATIONAL_ID_CARD - CURP - RFC - SSN - EIN - SIN -->

The ID indicated by this value corresponds to the ID provided in the recipientIdNumbers.governmentId parameter.

recipientIdNumbersRecipientIdNumbers — unresolved $ref

Response

Success

recipientRefRecipientRef — unresolved $ref
recipientIdRecipientId — unresolved $ref
payoutAccountIdPayoutAccountId — unresolved $ref
providerIdProviderId — unresolved $ref
providerTypeProviderType — unresolved $ref
providerRecipientRefProviderRecipientRef — unresolved $ref
userTypeUserType — unresolved $ref
firstNameFirstName — unresolved $ref
lastNameLastName — unresolved $ref
genderGender — unresolved $ref
birthDateBirthDate — unresolved $ref
countryOfBirthCountryOfBirth — unresolved $ref
countryOfNationalityCountryOfNationality — unresolved $ref
addressLine1AddressLine1 — unresolved $ref
addressLine2AddressLine2 — unresolved $ref
cityCity — unresolved $ref
regionRegion — unresolved $ref
postalCodePostalCode — unresolved $ref
countryCountry — unresolved $ref
emailEmail — unresolved $ref
phoneNumberPhoneNumber — unresolved $ref
mobileNumberMobileNumber — unresolved $ref
governmentIdTypeGovernmentIdType — unresolved $ref
recipientIdNumbersRecipientIdNumbers — unresolved $ref
createdAtstring

The date and time the recipient record was created in Nexio, formatted as an ISO-8601 date expressed in UTC.

updatedAtstring

The date and time the recipient 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.