post https://api.nexiopaysandbox.com/payout/v3/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.
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.
Try It
To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.
Include at least a recipientRef, recipient email, recipient firstName and lastName, and the country for the recipient.
Request parameters
- recipientRef
- 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
- phoneNumber
- mobileNumber
- governmentIdType
- recipientIdNumbers
- recipientIdNumbers.governmentId
- recipientIdNumbers.passportId
- recipientIdNumbers.employerId
- recipientIdNumbers.driversLicenseId
- createdAt
- updatedAt