> ## Documentation Index > Fetch the complete documentation index at: https://docs.y.uno/llms.txt > Use this file to discover all available pages before exploring further. # Update Recipient Updates an existing recipient. Only specified fields will be updated. ## OpenAPI ````yaml openapi/recipients-for-marketplace/update-recipient-1.json PATCH /recipients/{recipient_id} openapi: 3.1.0 info: title: Recipients API version: 1.0.0 description: >- API for managing recipients in split payment scenarios. This feature enables merchants to split payments among multiple recipients, which is particularly beneficial for marketplace models where transactions need to be divided among different sellers or stakeholders. servers: - url: https://api-sandbox.y.uno/v1 security: - sec0: [] sec1: [] paths: /recipients/{recipient_id}: parameters: - name: recipient_id in: path required: true description: The unique identifier of the recipient schema: type: string patch: summary: Update Recipient operationId: update-recipient requestBody: content: application/json: schema: type: object properties: merchant_recipient_id: type: string description: >- Unique identifier of the recipient defined by the merchant (MAX 255; MIN 1). first_name: type: string description: Beneficiary's name. (MAX 80; MIN 1). last_name: type: string description: Beneficiary's last name. (MAX 80; MIN 1). date_of_birth: type: string description: >- The Beneficiary's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10). entity_type: type: string enum: - GOVERNMENTAL - PUBLIC - NON_PROFIT - PRIVATE description: >- The Beneficiary's type of organization. GOVERNMENTAL, PUBLIC, NON_PROFIT, PRIVATE website: type: string description: The seller's website URL (MAX 255; MIN 3). industry: type: string description: >- The seller's industry (MAX 235; MIN 1). For more information access the Industry category reference page. merchant_category_code: type: string description: MCC - The merchant category code (MAX 235; MIN 1). email: type: string description: The Beneficiary's email (MAX 255; MIN 3). phone: type: object properties: country_code: type: string description: Beneficiary's cell phone area code. (MAX 3; MIN 2). number: type: string description: Beneficiary's cell phone number. (MAX 32; MIN 1). address: type: object properties: address_line_1: type: string description: >- The primary billing address line of the customer (MAX 255; MIN 3). address_line_2: type: string description: >- The secondary billing address line of the customer (MAX 255; MIN 3). city: type: string description: >- The city considered for the billing address (MAX 255; MIN 3). state: type: string description: >- The state / province considered for the billing address (MAX 255; MIN 3). zip_code: type: string description: >- The zipcode considered for the billing address (MAX 11; MIN 4). withdrawal_methods: type: array items: type: object properties: bank: type: object properties: code: type: string description: Bank's code (MAX 3; MIN 3). branch: type: string description: Bank's branch (MAX 3; MIN 3). branch_digit: type: string description: Bank's branch digit (MAX 3; MIN 3). account: type: string description: >- Beneficiary's bank account number (MAX 250; MIN 3). account_digit: type: string description: Beneficiary's bank account digit (MAX 250; MIN 3). account_type: type: string enum: - CHECKINGS - SAVINGS description: Beneficiary's bank account type (MAX 3; MIN 1). routing: type: string description: Beneficiary's bank account routing number. country: type: string description: >- The bank account's country (ISO 3166-1 MAX 2; MIN 2). currency: type: string description: >- The bank account's currency (ISO 4217 MAX 3; MIN 3). documentation: type: array description: Array of documentation objects items: type: object properties: file_name: type: string description: The name of the documentation sent (MAX 255; MIN 3). content_type: type: string description: The type of the documentation sent by the merchant. content_category: type: string description: >- The category of the documentation sent by the merchant. content: type: string description: >- The content of the documentation sent by the merchant encoded in base64. Max size: 1MB. onboardings: type: array description: Array of onboarding objects for different payment providers items: type: object properties: type: type: string enum: - PREVIOUSLY_ONBOARDED - ONBOARD_ONTO_THE_PROVIDER description: Type of onboarding. If its done by Yuno. workflow: type: string enum: - HOSTED_BY_PROVIDER - DIRECT description: Workflow of the onboarding. callback_url: type: string description: >- URL in case to redirect your customer after the onboarding process with the provider, if needed. provider: type: object properties: id: type: string enum: - PAGARME - ALELO - EDENRED - PLUXEE - VR - STRIPE - ADYEN description: Provider id. example: PAGARME recipient_id: type: string description: The unique identifier of the provider's recipient. documentation: type: array description: Array of documentation objects for this onboarding items: type: object properties: file_name: type: string description: >- The name of the documentation sent (MAX 255; MIN 3). content_type: type: string description: >- The type of the documentation sent by the merchant. content_category: type: string description: >- The category of the documentation sent by the merchant. content: type: string description: >- The content of the documentation sent by the merchant encoded in base64. Max size: 1MB. withdrawal_methods: type: array description: Withdrawal methods for this onboarding items: type: object properties: bank: type: object properties: code: type: string description: Bank's code (MAX 3; MIN 3). branch: type: string description: Bank's branch (MAX 3; MIN 3). branch_digit: type: string description: Bank's branch digit (MAX 3; MIN 3). account: type: string description: >- Beneficiary's bank account number (MAX 250; MIN 3). account_digit: type: string description: >- Beneficiary's bank account digit (MAX 250; MIN 3). account_type: type: string enum: - CHECKINGS - SAVINGS description: >- Beneficiary's bank account type (MAX 3; MIN 1). routing: type: string description: Beneficiary's bank account routing number. country: type: string description: >- The bank account's country (ISO 3166-1 MAX 2; MIN 2). currency: type: string description: >- The bank account's currency (ISO 4217 MAX 3; MIN 3). split_configuration: type: object description: >- Rules for automatic split calculation at the recipient level. required: - calculation_type - currency properties: calculation_type: type: string description: The method used to calculate the split amount. enum: - PERCENTAGE - FIXED - MIXED example: PERCENTAGE percentage: type: number description: >- Percentage of the total payment amount to be split (0.01-100.00). Required if calculation_type is PERCENTAGE or MIXED. minimum: 0.01 maximum: 100 example: 10.5 fixed_amount: type: number description: >- Fixed amount to be split. Required if calculation_type is FIXED or MIXED. minimum: 0.0001 example: 5 currency: type: string description: >- ISO 4217 currency code. Required for all calculation types. example: USD rounding_mode: type: string description: >- The rounding strategy for calculated amounts. Required for PERCENTAGE and MIXED. enum: - STANDARD - ROUND_UP - ROUND_DOWN example: STANDARD examples: Update Contact Info: value: email: newemail@example.com phone: country_code: '57' number: '9876543210' Update Address: value: address: address_line_1: New Street 123 city: New City state: New State zip_code: '12345' Update Banking Info: value: withdrawal_methods: bank: code: '123' branch: YYY account: '987654321' account_type: CHECKINGS Update Onboarding: value: onboardings: - type: ONBOARD_ONTO_THE_PROVIDER workflow: DIRECT callback_url: https://myapp.com/new-callback provider: id: ADYEN responses: '200': description: Recipient updated successfully content: application/json: schema: $ref: '#/components/schemas/RecipientResponse' examples: Success Response: value: id: 9104911d-5df9-429e-8488-ad41abea1a4b account_id: 9104911d-5df9-429e-8488-ad41abea1a4b merchant_recipient_id: AAAA01 national_entity: INDIVIDUAL first_name: John last_name: Doe email: newemail@example.com country: CO created_at: '2024-01-15T10:30:00Z' updated_at: '2024-01-15T11:45:00Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Invalid Request: value: code: INVALID_REQUEST messages: - Invalid request format '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Unauthorized: value: code: INVALID_CREDENTIALS messages: - Invalid credentials '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Forbidden: value: code: AUTHORIZATION_REQUIRED messages: - The merchant has no authorization to use this API. components: schemas: RecipientResponse: type: object properties: id: type: string description: The unique identifier of the recipient. example: 3aaa4d82-11e8-48ce-8ef5-04eee3a10802 account_id: type: string description: The account identifier associated with this recipient. example: fe14c7c6-c75e-43b7-bdbe-4c87ad52c482 merchant_recipient_id: type: string description: Unique identifier of the recipient defined by the merchant. example: MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6 national_entity: type: string description: Beneficiary's national entity type. example: INDIVIDUAL entity_type: type: string description: Beneficiary's type of organization. example: PRIVATE first_name: type: string description: Beneficiary's name. example: Juan last_name: type: string description: Beneficiary's last name. example: Perez legal_name: type: - string - 'null' description: Beneficiary's legal name. example: null email: type: string description: The Beneficiary's email. example: juan.perez@example.com date_of_birth: type: string description: Beneficiary's date of birth. example: '1990-01-15' country: type: string description: The Beneficiary's country. example: CO website: type: string description: The seller's website URL. example: https://juanperez.com industry: type: string description: The seller's industry. example: Technology merchant_category_code: type: string description: The merchant category code (MCC) (MAX 235; MIN 1). example: '5734' document: type: object properties: document_number: type: string example: '1234567890' document_type: type: string example: CC phone: type: object properties: country_code: type: string example: '57' number: type: string example: '3001234567' address: type: object properties: address_line_1: type: string example: 'Carrera 7 # 32-16' address_line_2: type: - string - 'null' example: Oficina 201 city: type: string example: Bogota country: type: string example: CO state: type: string example: Cundinamarca zip_code: type: string example: '110311' neighborhood: type: string example: Centro legal_representatives: type: array items: type: object properties: merchant_reference: type: string example: REP_001 first_name: type: string example: Maria last_name: type: string example: Gonzalez email: type: string example: maria.gonzalez@example.com date_of_birth: type: string example: '1985-05-20' country: type: string example: CO nationality: type: string example: CO title: type: string example: CEO publicly_exposed_person: type: boolean example: false ultimate_beneficial_owner: type: boolean example: true document: type: object properties: document_type: type: string example: CC document_number: type: string example: '0987654321' phone: type: object properties: country_code: type: string example: '57' number: type: string example: '3109876543' address: type: object properties: address_line_1: type: string example: 'Calle 26 # 13-19' address_line_2: type: - string - 'null' example: null country: type: string example: CO state: type: string example: Cundinamarca city: type: string example: Bogota zip_code: type: string example: '110311' withdrawal_methods: type: object properties: bank: type: object properties: code: type: string example: '001' branch: type: string example: '004' branch_digit: type: - string - 'null' example: '123' account: type: string example: '1234567890' account_digit: type: - string - 'null' example: '123' account_type: type: string example: SAVINGS routing: type: string example: '021000021' country: type: string example: CO currency: type: string example: COP documentation: type: array items: type: object properties: file_name: type: string example: cc-front.pdf content_type: type: string example: application/pdf content_category: type: string example: IDENTIFICATION content: type: string example: JVBERi0xLjQKJ... onboardings: type: array items: type: object properties: id: type: string example: 84c42684-dbe5-4e0f-bd17-4d094e19762d type: type: string example: ONBOARD_ONTO_THE_PROVIDER workflow: type: string example: DIRECT status: type: string example: PENDING callback_url: type: string example: https://merchant.example.com/webhook/onboarding provider: type: object properties: id: type: string example: ALELO connection_id: type: string example: cc389b51-53a1-4a29-af40-c8cee26c3399 recipient_id: type: - string - 'null' example: null redirect_url: type: - string - 'null' example: null onboarding_url: type: - string - 'null' example: null legal_entity: type: - string - 'null' example: null balance_account_id: type: - string - 'null' example: null legal_entity_id: type: - string - 'null' example: null documentation: type: array items: type: object properties: file_name: type: string example: utility-bill.pdf content_type: type: string example: application/pdf content_category: type: string example: ADDRESS_PROOF content: type: string example: JVBERi0xLjQKJ... legal_representatives: type: array items: type: object example: [] requirements: type: array items: type: object properties: field: type: string example: document.cc message: type: string example: Provide CC document image status: type: string example: PENDING withdrawal_methods: type: object properties: bank: type: object properties: code: type: string example: '002' branch: type: string example: '002' branch_digit: type: - string - 'null' example: null account: type: string example: '9876543210' account_digit: type: - string - 'null' example: null account_type: type: string example: SAVINGS routing: type: string example: '021000022' country: type: string example: CO currency: type: string example: COP terms_of_service: type: object properties: acceptance: type: boolean example: true date: type: string example: '2025-07-21T20:43:54Z' ip: type: string example: 129.21.111.11 created_at: type: string format: date-time example: '2025-08-27T15:41:19.516982Z' updated_at: type: string format: date-time example: '2025-08-27T15:41:19.516989Z' split_configuration: type: object description: Rules for automatic split calculation at the recipient level. properties: calculation_type: type: string description: The method used to calculate the split amount. enum: - PERCENTAGE - FIXED - MIXED example: PERCENTAGE percentage: type: number description: >- Percentage of the total payment amount to be split (0.01-100.00). Required if calculation_type is PERCENTAGE or MIXED. minimum: 0.01 maximum: 100 example: 10.5 fixed_amount: type: number description: >- Fixed amount to be split. Required if calculation_type is FIXED or MIXED. minimum: 0.0001 example: 5 currency: type: string description: ISO 4217 currency code. Required for all calculation types. example: USD rounding_mode: type: string description: >- The rounding strategy for calculated amounts. Required for PERCENTAGE and MIXED. enum: - STANDARD - ROUND_UP - ROUND_DOWN example: STANDARD created_at: type: string format: date-time description: Recipient creation date (ISO 8601 MAX 27; MIN 27). example: '2025-08-27T15:41:19.497413Z' updated_at: type: string format: date-time description: Last Recipient updated date (ISO 8601 MAX 27; MIN 27). example: '2025-08-27T15:41:19.497425Z' ErrorResponse: type: object properties: code: type: string example: INVALID_REQUEST messages: type: array items: type: string example: Invalid request securitySchemes: sec0: type: apiKey in: header name: public-api-key x-default: sec1: type: apiKey in: header name: private-secret-key x-default: ````