--- title: "Update Recipient" method: PATCH path: "/recipients/{recipient_id}" --- # Update Recipient `PATCH /recipients/{recipient_id}` ## Request body - object - `onboarding_id` string, uuid — ID of an existing onboarding belonging to the recipient. When set, the identity fields sent in this request (e.g. first_name, email, phone, address) are stored as a per-onboarding override for that onboarding only, without modifying the shared recipient; when omitted, the update applies to the shared recipient and propagates to all non-terminal onboardings. Request-only, not returned in responses or webhooks. - `merchant_recipient_id` string — Unique identifier of the recipient defined by the merchant (MAX 255; MIN 1). - `first_name` string — Beneficiary's name. (MAX 80; MIN 1). - `last_name` string — Beneficiary's last name. (MAX 80; MIN 1). - `date_of_birth` string — The Beneficiary's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10). - `entity_type` 'GOVERNMENTAL' | 'PUBLIC' | 'NON_PROFIT' | 'PRIVATE' — The Beneficiary's type of organization. GOVERNMENTAL, PUBLIC, NON_PROFIT, PRIVATE - `website` string — The seller's website URL (MAX 255; MIN 3). - `industry` string — The seller's industry (MAX 235; MIN 1). For more information access the Industry category reference page. - `merchant_category_code` string — MCC - The merchant category code (MAX 235; MIN 1). - `email` string — The Beneficiary's email (MAX 255; MIN 3). - `phone` object - `country_code` string — Beneficiary's cell phone area code. (MAX 3; MIN 2). - `number` string — Beneficiary's cell phone number. (MAX 32; MIN 1). - `address` object - `address_line_1` string — The primary billing address line of the customer (MAX 255; MIN 3). - `address_line_2` string — The secondary billing address line of the customer (MAX 255; MIN 3). - `city` string — The city considered for the billing address (MAX 255; MIN 3). - `state` string — The state / province considered for the billing address (MAX 255; MIN 3). - `zip_code` string — The zipcode considered for the billing address (MAX 11; MIN 4). - `withdrawal_methods` object[] - `bank` object - `code` string — Bank's code (MAX 3; MIN 3). - `branch` string — Bank's branch (MAX 3; MIN 3). - `branch_digit` string — Bank's branch digit (MAX 3; MIN 3). - `account` string — Beneficiary's bank account number (MAX 250; MIN 3). - `account_digit` string — Beneficiary's bank account digit (MAX 250; MIN 3). - `account_type` 'CHECKINGS' | 'SAVINGS' — Beneficiary's bank account type (MAX 3; MIN 1). - `routing` string — Beneficiary's bank account routing number. - `country` string — The bank account's country (ISO 3166-1 MAX 2; MIN 2). - `currency` string — The bank account's currency (ISO 4217 MAX 3; MIN 3). - `documentation` object[] — Array of documentation objects - `file_name` string — The name of the documentation sent (MAX 255; MIN 3). - `content_type` string — The type of the documentation sent by the merchant. - `content_category` string — The category of the documentation sent by the merchant. - `content` string — The content of the documentation sent by the merchant encoded in base64. Max size: 1MB. - `onboardings` object[] — Array of onboarding objects for different payment providers - `type` 'PREVIOUSLY_ONBOARDED' | 'ONBOARD_ONTO_THE_PROVIDER' — Type of onboarding. If its done by Yuno. - `workflow` 'HOSTED_BY_PROVIDER' | 'DIRECT' — Workflow of the onboarding. - `callback_url` string — URL in case to redirect your customer after the onboarding process with the provider, if needed. - `provider` object - `id` 'PAGARME' | 'ALELO' | 'EDENRED' | 'PLUXEE' | 'VR' | 'STRIPE' | 'ADYEN' — Provider id. - `recipient_id` string — The unique identifier of the provider's recipient. - `documentation` object[] — Array of documentation objects for this onboarding - `file_name` string — The name of the documentation sent (MAX 255; MIN 3). - `content_type` string — The type of the documentation sent by the merchant. - `content_category` string — The category of the documentation sent by the merchant. - `content` string — The content of the documentation sent by the merchant encoded in base64. Max size: 1MB. - `withdrawal_methods` object[] — Withdrawal methods for this onboarding - `bank` object - `code` string — Bank's code (MAX 3; MIN 3). - `branch` string — Bank's branch (MAX 3; MIN 3). - `branch_digit` string — Bank's branch digit (MAX 3; MIN 3). - `account` string — Beneficiary's bank account number (MAX 250; MIN 3). - `account_digit` string — Beneficiary's bank account digit (MAX 250; MIN 3). - `account_type` 'CHECKINGS' | 'SAVINGS' — Beneficiary's bank account type (MAX 3; MIN 1). - `routing` string — Beneficiary's bank account routing number. - `country` string — The bank account's country (ISO 3166-1 MAX 2; MIN 2). - `currency` string — The bank account's currency (ISO 4217 MAX 3; MIN 3). - `split_configuration` object — Rules for automatic split calculation at the recipient level. - `calculation_type` 'PERCENTAGE' | 'FIXED' | 'MIXED', required — The method used to calculate the split amount. - `percentage` number — Percentage of the total payment amount to be split (0.01-100.00). Required if calculation_type is PERCENTAGE or MIXED. - `fixed_amount` number — Fixed amount to be split. Required if calculation_type is FIXED or MIXED. - `currency` string, required — ISO 4217 currency code. Required for all calculation types. - `rounding_mode` 'STANDARD' | 'ROUND_UP' | 'ROUND_DOWN' — The rounding strategy for calculated amounts. Required for PERCENTAGE and MIXED. ## Response `200` Recipient updated successfully - RecipientResponse - `id` string — The unique identifier of the recipient. - `account_id` string — The account identifier associated with this recipient. - `merchant_recipient_id` string — Unique identifier of the recipient defined by the merchant. - `national_entity` string — Beneficiary's national entity type. - `entity_type` string — Beneficiary's type of organization. - `first_name` string — Beneficiary's name. - `last_name` string — Beneficiary's last name. - `legal_name` unknown - `email` string — The Beneficiary's email. - `date_of_birth` string — Beneficiary's date of birth. - `country` string — The Beneficiary's country. - `website` string — The seller's website URL. - `industry` string — The seller's industry. - `merchant_category_code` string — The merchant category code (MCC) (MAX 235; MIN 1). - `document` object - `document_number` string - `document_type` string - `phone` object - `country_code` string - `number` string - `address` object - `address_line_1` string - `address_line_2` string - `city` string - `country` string - `state` string - `zip_code` string - `neighborhood` string - `legal_representatives` object[] - `merchant_reference` string - `first_name` string - `last_name` string - `email` string - `date_of_birth` string - `country` string - `nationality` string - `title` string - `publicly_exposed_person` boolean - `ultimate_beneficial_owner` boolean - `document` object - `document_type` string - `document_number` string - `phone` object - `country_code` string - `number` string - `address` object - `address_line_1` string - `address_line_2` unknown - `country` string - `state` string - `city` string - `zip_code` string - `withdrawal_methods` object - `bank` object - `code` string - `branch` string - `branch_digit` string - `account` string - `account_digit` string - `account_type` string - `routing` string - `country` string - `currency` string - `documentation` object[] - `file_name` string - `content_type` string - `content_category` string - `content` string - `onboardings` object[] - `id` string - `type` string - `workflow` string - `status` string - `callback_url` string - `provider` object - `id` string - `connection_id` string - `recipient_id` unknown - `redirect_url` unknown - `onboarding_url` unknown - `legal_entity` unknown - `balance_account_id` unknown - `legal_entity_id` unknown - `documentation` object[] - `file_name` string - `content_type` string - `content_category` string - `content` string - `legal_representatives` object[] - `requirements` object[] - `field` string - `message` string - `status` string - `withdrawal_methods` object - `bank` object - `code` string - `branch` string - `branch_digit` unknown - `account` string - `account_digit` unknown - `account_type` string - `routing` string - `country` string - `currency` string - `terms_of_service` object - `acceptance` boolean - `date` string - `ip` string - `created_at` string, date-time - `updated_at` string, date-time - `split_configuration` object — Rules for automatic split calculation at the recipient level. - `calculation_type` 'PERCENTAGE' | 'FIXED' | 'MIXED' — The method used to calculate the split amount. - `percentage` number — Percentage of the total payment amount to be split (0.01-100.00). Required if calculation_type is PERCENTAGE or MIXED. - `fixed_amount` number — Fixed amount to be split. Required if calculation_type is FIXED or MIXED. - `currency` string — ISO 4217 currency code. Required for all calculation types. - `rounding_mode` 'STANDARD' | 'ROUND_UP' | 'ROUND_DOWN' — The rounding strategy for calculated amounts. Required for PERCENTAGE and MIXED. - `created_at` string, date-time — Recipient creation date (ISO 8601 MAX 27; MIN 27). - `updated_at` string, date-time — Last Recipient updated date (ISO 8601 MAX 27; MIN 27). ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden --- [API](https://skmtc.net/y/apis/ai-caller.md) · [All operations](https://skmtc.net/y/apis/ai-caller/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/y/ai-caller/versions/05b629819b49/schema)