Creates a recipient: a person or business you can pay out to. Use the returned id (REP-...) as recipient_id when you create a payout or split a payment link with payouts_share (see Platform-led marketplace).
recipient_type, relationship, and bank are required. Send first_name and last_name for an individual, or business_name for a business. In bank, send an iban (UAE and other IBAN countries) or an account_number. The API doesn't reject a recipient with neither, but that recipient can't be paid. If you leave out bank.country, it defaults to AE. To check an IBAN first, use Validate IBAN.
Creating a recipient has no KYC step of its own.
Validation errors
A failed validation returns 422 with error_code: VALIDATION_ERROR and an errors array. Common causes:
first_nameorlast_namemissing for anindividual, orbusiness_namemissing for abusiness.bank.namemissing when you send anaccount_numberor a non-UAE IBAN.bank.addressorbank.countrymissing when you send anaccount_number.bank.bic_codemissing when you send anaccount_numberfor a bank outside the US and India.- An
ibanthat isn't a valid IBAN. - A
date_of_birthin the future ("Date of birth cannot be in the future."). - Fields required by the payout corridor. For example, for an Indian bank (
bank.country: IN) you must sendphone_number, plusnationalityandeid_numberfor an individual orbusiness_registration_numberfor a business.
If the recipient passes validation but can't be saved, you get 422 with error_code: UNPROCESSABLE_ENTITY and the message Can not create recipient.
A 403 means the API key is missing, wrong, or inactive, or belongs to the other environment (for example a sandbox key sent to production), or your account is blocked. It is not a sign that recipients are disabled for your account. See Errors.
404Invalid request
429Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.
500Unexpected error