---
title: "Create a recipient"
method: POST
path: "/payout/v3/recipient"
tags: ["Recipients"]
---

# Create a recipient

`POST /payout/v3/recipient`

## Request

- Base URL: `https://api.nexiopaysandbox.com`
- URL: `https://api.nexiopaysandbox.com/payout/v3/recipient`
- Auth: HTTP basic

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](ref:submitpayouts).

<!-- 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](ref:updaterecipient) endpoint.

<!-- theme: warning -->
> ⚠️ Try It
>
> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).<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>

## Request body

- object
  - `recipientRef` string, 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.
  - `email` Email, required (unresolved $ref)
  - `firstName` FirstName, required (unresolved $ref)
  - `lastName` LastName, required (unresolved $ref)
  - `country` Country, required (unresolved $ref)
  - `providerId` ProviderId (unresolved $ref)
  - `userType` UserType (unresolved $ref)
  - `gender` Gender (unresolved $ref)
  - `birthDate` BirthDate (unresolved $ref)
  - `countryOfBirth` CountryOfBirth (unresolved $ref)
  - `countryOfNationality` CountryOfNationality (unresolved $ref)
  - `currency` string: <!-- INTERNAL NOTE: Payquicker --> The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) 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.
  - `addressType` AddressType (unresolved $ref)
  - `addressLine1` AddressLine1 (unresolved $ref)
  - `addressLine2` AddressLine2 (unresolved $ref)
  - `city` City (unresolved $ref)
  - `region` Region (unresolved $ref)
  - `postalCode` PostalCode (unresolved $ref)
  - `phoneNumber` PhoneNumber (unresolved $ref)
  - `phoneNumberCountry` PhoneNumberCountry (unresolved $ref)
  - `mobileNumber` MobileNumber (unresolved $ref)
  - `mobileNumberCountry` MobileNumberCountry (unresolved $ref)
  - `governmentIdType` string: 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.
  - `recipientIdNumbers` RecipientIdNumbers (unresolved $ref)

## Response `200`

Success

- object: Contains the set of recipient parameters.
  - `recipientRef` RecipientRef (unresolved $ref)
  - `recipientId` RecipientId (unresolved $ref)
  - `payoutAccountId` PayoutAccountId (unresolved $ref)
  - `providerId` ProviderId (unresolved $ref)
  - `providerType` ProviderType (unresolved $ref)
  - `providerRecipientRef` ProviderRecipientRef (unresolved $ref)
  - `userType` UserType (unresolved $ref)
  - `firstName` FirstName (unresolved $ref)
  - `lastName` LastName (unresolved $ref)
  - `gender` Gender (unresolved $ref)
  - `birthDate` BirthDate (unresolved $ref)
  - `countryOfBirth` CountryOfBirth (unresolved $ref)
  - `countryOfNationality` CountryOfNationality (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)
  - `email` Email (unresolved $ref)
  - `phoneNumber` PhoneNumber (unresolved $ref)
  - `mobileNumber` MobileNumber (unresolved $ref)
  - `governmentIdType` GovernmentIdType (unresolved $ref)
  - `recipientIdNumbers` RecipientIdNumbers (unresolved $ref)
  - `createdAt` string: The date and time the recipient record was created in Nexio, 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 recipient 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](doc:common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payouts-api-reference.md) - [All operations](https://skmtc.dev/nexiopay/apis/payouts-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/nexiopay/apis/payouts-api-reference/revisions/36c088967d63?raw)