> ## 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.

# The Recipient Object

This object represents a recipient who will receive part of a [split payment](/docs/split-payments-marketplace). It represents a seller's account within your marketplace. The split allows you to disperse the money of a purchase in your marketplace directly to the seller's account while your commission goes to your marketplace account.

## Attributes

<ParamField body="id" type="string">
  The unique identifier of the recipient (MAX 64 ; MIN 36).

  Example: 9104911d-5df9-429e-8488-ad41abea1a4b.
</ParamField>

<ParamField body="account_id" type="string">
  The unique identifier of the account (MAX 64; MIN 36).

  Example: 4323f8a0-7699-4a5b-8293-f4d712312eb3bd.
</ParamField>

<ParamField body="merchant_recipient_id" type="string">
  The unique identifier of the recipient for the marketplace owner (MAX 255; MIN 3).

  Example: AAAA01.
</ParamField>

<ParamField body="national_entity" type="string">
  Beneficiary's national entity category. Could be INDIVIDUAL or ENTITY.

  Example: INDIVIDUAL.
</ParamField>

<ParamField body="entity_type" type="string">
  Beneficiary's national entity type. Could be PUBLIC, GOVERNMENTAL, NON\_PROFIT or PRIVATE.

  Example: PRIVATE.
</ParamField>

<ParamField body="first_name" type="string">
  The recipient's first name (MAX 255; MIN 3).

  Example: John.
</ParamField>

<ParamField body="last_name" type="string">
  The recipient's last name (MAX 255; MIN 3).

  Example: Doe.
</ParamField>

<ParamField body="legal_name" type="string">
  Beneficiary's name. (Max: 80) Only necessary when national entity is ENTITY (MAX 64 ; MIN 36).

  Example: Arcos dorados S.A.
</ParamField>

<ParamField body="email" type="string">
  The recipient's e-mail (MAX 255; MIN 3).

  Example: [john.doe@email.com](mailto:john.doe@email.com).
</ParamField>

<ParamField body="date_of_birth" type="string">
  The recipient's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10).

  Example: 1990-02-28.
</ParamField>

<ParamField body="country" type="enum">
  The recipient's country (MAX 2; MIN 2; <a href="/reference/the-customer-object">ISO 3166-1</a> ).

  Possible enum values: Check the <a href="/reference/country-reference">Country Code List</a>.
</ParamField>

<ParamField body="website" type="string">
  The recipient's website URL (MAX 255; MIN 3).

  Example: [https://www.my-site.com](https://www.my-site.com)
</ParamField>

<ParamField body="industry" type="string">
  The recipient's industry (MAX 235; MIN 1) For more information access the Industry category reference page.

  Example: VIRTUAL\_GOODS
</ParamField>

<ParamField body="merchant_category_code" type="string">
  The merchant category code (MAX 235; MIN 1).

  Example: TTR
</ParamField>

<ParamField body="document" type="object">
  Specifies the recipient's document object, including its number and type.

  <Expandable title="properties">
    <ParamField body="document_number" type="string">
      The recipient's document number (MAX 40; MIN 3).

      Example: 1093333333.
    </ParamField>

    <ParamField body="document_type" type="enum">
      The recipient's document type (MAX 6, MIN 2).

      Possible enum values: Check the <a href="/reference/country-reference">Country Reference</a>.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="phone" type="object">
  Specifies the recipient's phone number object.

  <Expandable title="properties">
    <ParamField body="country_code" type="string">
      The country code of the recipient's phone (MAX 3; MIN 2).

      Example: 57.
    </ParamField>

    <ParamField body="number" type="string">
      The recipient's phone number, without the country code (MAX 32; MIN 1).

      Example: 3132450765.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="address" type="object">
  Specifies the recipient's billing address object.

  <Expandable title="properties">
    <ParamField body="address_line_1" type="string">
      The primary billing address line of the recipient (MAX 255; MIN 3).

      Example: Calle 34 # 56 - 78.
    </ParamField>

    <ParamField body="address_line_2" type="string">
      The secondary billing address line of the recipient (MAX 255; MIN 3).

      Example: Apartamento 502, Torre I.
    </ParamField>

    <ParamField body="city" type="string">
      The city considered for the billing address (MAX 255; MIN 3).

      Example: Bogotá.
    </ParamField>

    <ParamField body="country" type="enum">
      The country considered for the billing address (MAX 2; MIN 2; <a href="/reference/the-customer-object">ISO 3166-1</a> ).

      Possible enum values: Check the <a href="/reference/country-reference">Country Code List</a>.
    </ParamField>

    <ParamField body="state" type="string">
      The state considered for the billing address (MAX 255; MIN 3).

      Example: Cundinamarca.
    </ParamField>

    <ParamField body="zip_code" type="string">
      The zipcode considered for the billing address (MAX 11; MIN 4).

      Example: 111111.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="withdrawal_methods" type="array of objects">
  A list of withdrawal method objects; each item contains a bank object

  <Expandable title="properties">
    <ParamField body="bank" type="struct">
      Bank details for this withdrawal method.

      <Expandable title="properties">
        <ParamField body="code" type="string">
          Bank’s code (MAX 3; MIN 3).

          Example: 246
        </ParamField>

        <ParamField body="branch" type="string">
          Bank’s branch (MAX 3; MIN 3).

          Example: 123
        </ParamField>

        <ParamField body="branch_digit" type="string">
          Bank’s branch digit (MAX 1; MIN 1).

          Example: 5
        </ParamField>

        <ParamField body="account" type="string">
          Beneficiary’s bank account number (MAX 250; MIN 3).

          Example: 1093333333
        </ParamField>

        <ParamField body="account_digit" type="string">
          Beneficiary’s bank account digit (MAX 1; MIN 1).

          Example: 7
        </ParamField>

        <ParamField body="account_type" type="enum">
          Beneficiary’s bank account type: `CHECKINGS` or `SAVINGS` .

          Example: SAVINGS
        </ParamField>

        <ParamField body="routing" type="string">
          Beneficiary’s bank account routing number.

          Example: 021000021
        </ParamField>

        <ParamField body="country" type="string">
          The bank account’s country (ISO 3166-1 alpha-2).

          Example: CO
        </ParamField>

        <ParamField body="currency" type="string">
          The bank account’s currency (ISO 4217).

          Example: COP
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="documentation" type="array of objects">
  An array of documentation objects provided by the merchant.

  <Expandable title="properties">
    <ParamField body="file_name" type="string">
      The name of the documentation sent (MAX 255; MIN 3).

      Example: receipt.pdf
    </ParamField>

    <ParamField body="content_type" type="enum">
      The type of the documentation sent by the merchant.

      Example: RECEIPT
    </ParamField>

    <ParamField body="content_category" type="string">
      The category of the documentation sent by the merchant (e.g., INVOICE, ID\_PROOF).
    </ParamField>

    <ParamField body="content" type="string">
      The content of the documentation encoded in base64 (Max size: 1MB).

      Example:JVBERi0xLjQKJcfs…
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="onboardings" type="array of objects">
  List of onboarding records for each provider connection.

  <Expandable title="properties">
    <ParamField body="id" type="enum">
      The unique identifier of the onboarding.

      Example: 9104911d-5df9-429e-8488-ad41abea1a4b
    </ParamField>

    <ParamField body="type" type="enum">
      Type of onboarding. If done previously or via Yuno.

      PREVIOUSLY\_ONBOARDED, ONBOARD\_ONTO\_THE\_PROVIDER
    </ParamField>

    <ParamField body="workflow" type="enum">
      Workflow of the onboarding.

      HOSTED\_BY\_PROVIDER, HOSTED\_BY\_YUNO, DIRECT
    </ParamField>

    <ParamField body="status" type="enum">
      Status of the vinculation with the merchant.

      PENDING, SUCCEEDED, DECLINED, BLOCKED, CANCELED, REJECTED, ERROR
    </ParamField>

    <ParamField body="provider_response_code" type="string">
      Provider response code returned by the provider during onboarding.

      Example: 00
    </ParamField>

    <ParamField body="provider_response_message" type="string">
      Descriptive provider message associated with the onboarding response.

      Example: Approved
    </ParamField>

    <ParamField body="provider_raw_response" type="string">
      Reference to the full raw provider response. Use this identifier to retrieve the complete payload when required.

      Example: 64b3f8cba12e3c7d9f0a1234
    </ParamField>

    <ParamField body="callback_url" type="string">
      URL to redirect your customer after the onboarding process, if needed.

      Example: [https://www.google.com](https://www.google.com)
    </ParamField>

    <ParamField body="provider" type="object">
      Information about the payment provider connection.

      <Expandable title="properties">
        <ParamField body="id" type="string">
          Provider identifier.

          Example: ADYEN
        </ParamField>

        <ParamField body="connection_id" type="string">
          The specific Yuno connection ID associated with that onboarding.

          Example: 322d48b6-f423-4438-8ffb-0b9b5059a2e9
        </ParamField>

        <ParamField body="recipient_id" type="string">
          The unique identifier of the provider's recipient.

          Example: 9104911d-5df9-429e-8488-ad41abea1a4b
        </ParamField>

        <ParamField body="redirect_url" type="string">
          Redirect URL where the end user will be redirected once the onboarding is finished.

          Example: [https://www.example.com/callback](https://www.example.com/callback)
        </ParamField>

        <ParamField body="onboarding_url" type="string">
          URL to redirect your recipient to finalize the onboarding.

          Example: [https://www.provider.com/onboarding](https://www.provider.com/onboarding)
        </ParamField>

        <ParamField body="legal_entity" type="string">
          The legal entity identifier associated with the provider.
        </ParamField>

        <ParamField body="recipient_additional_id" type="string">
          Additional information regarding the recipient. Usually the legal entity ID.
        </ParamField>

        <ParamField body="balance_account_id" type="string">
          The unique identifier of the provider's balance account.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="documentation" type="array of objects">
      An array of documentation objects provided by the merchant.

      <Expandable title="properties">
        <ParamField body="file_name" type="string">
          The name of the documentation sent (MAX 255; MIN 3).

          Example: receipt.pdf
        </ParamField>

        <ParamField body="content_type" type="enum">
          The type of the documentation sent by the merchant.

          Example: RECEIPT
        </ParamField>

        <ParamField body="content_category" type="string">
          The category of the documentation sent by the merchant.
        </ParamField>

        <ParamField body="content" type="string">
          The content of the documentation encoded in base64 (Max size: 1MB).

          Example: JVBERi0xLjQKJcfs…
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="withdrawal_methods" type="array of objects">
      A list of withdrawal method objects; each contains a `bank` struct.

      <Expandable title="properties">
        <ParamField body="bank" type="struct">
          Bank details for this withdrawal method.

          <Expandable title="properties">
            <ParamField body="code" type="string">
              Bank’s code (MAX 3; MIN 3).

              Example: 246
            </ParamField>

            <ParamField body="branch" type="string">
              Bank’s branch (MAX 3; MIN 3).

              Example: 123
            </ParamField>

            <ParamField body="branch_digit" type="string">
              Bank’s branch digit (MAX 3; MIN 3).

              Example: 5
            </ParamField>

            <ParamField body="account" type="string">
              Beneficiary’s bank account number (MAX 250; MIN 3).

              Example: 1093333333
            </ParamField>

            <ParamField body="account_digit" type="string">
              Beneficiary’s bank account digit (MAX 250; MIN 1).

              Example: 7
            </ParamField>

            <ParamField body="account_type" type="enum">
              Beneficiary’s bank account type: `CHECKINGS` , `SAVINGS`

              Example: SAVINGS
            </ParamField>
          </Expandable>
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="created_at" type="timestamp">
      Onboarding creation date (ISO 8601).

      Example: 2022-05-09T20:46:54.786342Z
    </ParamField>

    <ParamField body="updated_at" type="timestamp">
      Last onboarding updated date (ISO 8601).

      Example: 2022-07-09T20:43:54.786342Z
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="created_at" type="timestamp">
  Recipient creation date and time (MAX 27; MIN 27; <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> ).

  Example: 2022-05-09T20:46:54.786342Z.
</ParamField>

<ParamField body="updated_at" type="timestamp">
  Last recipient update date and time (MAX 27; MIN 27; <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> ).

  Example: 2022-05-09T20:46:54.786342Z.
</ParamField>
