> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The Recurring PayPal PayIn object

### Description

The Recurring PayPal PayIn object allows platforms to process recurring payments with PayPal.

There are two types of recurring pay-ins:

* Customer-initiated transaction (CIT) – First pay-in of the series, which requires the user to authenticate.
* Merchant-initiated transaction (MIT) – All the pay-ins occurring after a successful CIT, which are executed in the absence of the user.

### Attributes

<ResponseField name="Id" type="string">
  Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details)

  The unique identifier of the object.
</ResponseField>

<ResponseField name="Tag" type="string">
  Max. length: 255 characters

  Custom data that you can add to this object.\
  For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
</ResponseField>

<ResponseField name="CreationDate" type="Unix timestamp">
  The date and time at which the object was created.
</ResponseField>

<ResponseField name="AuthorId" type="string">
  The unique identifier of the user at the source of the transaction.
</ResponseField>

<DebitedFunds8Response />

<CreditedFunds6Response />

<Fees6Response />

<ResponseField name="Status" type="string">
  **Returned values:** `CREATED`, `SUCCEEDED`, `FAILED`

  The status of the transaction.
</ResponseField>

<ResponseField name="ResultCode" type="string">
  The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.
</ResponseField>

<ResponseField name="ResultMessage" type="string">
  The explanation of the result code.
</ResponseField>

<ResponseField name="ExecutionDate" type="Unix timestamp">
  The date and time at which the status changed to `SUCCEEDED`, indicating that the transaction occurred. The statuses `CREATED` and `FAILED` return an `ExecutionDate` of `null`.
</ResponseField>

<ResponseField name="Type" type="string">
  **Returned values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`

  The type of the transaction.
</ResponseField>

<ResponseField name="Nature" type="string">
  **Returned values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT`

  The nature of the transaction, providing more information about the context in which the transaction occurred:

  * `REGULAR` – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.
  * `REPUDIATION` – Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).
  * `REFUND` – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).
  * `SETTLEMENT` – Transfer made to the repudiation wallet by the platform to settle a lost dispute.
</ResponseField>

<ResponseField name="CreditedWalletId" type="string">
  The unique identifier of the credited wallet.
</ResponseField>

<ResponseField name="PaymentType" type="string">
  **Returned values:** `PAYPAL`

  The type of pay-in.
</ResponseField>

<ResponseField name="ExecutionType" type="string">
  **Returned values:** `WEB`, `DIRECT`, `EXTERNAL_INSTRUCTION`

  The type of execution for the pay-in.
</ResponseField>

<ResponseField name="ReturnURL" type="string">
  Max. length: 255 characters

  The URL to which the user is returned after the payment, whether the transaction is successful or not.
</ResponseField>

<ResponseField name="RedirectURL" type="string">
  The URL to which to redirect the user to complete the payment.

  **Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
</ResponseField>

<ResponseField name="StatementDescriptor" type="string">
  Max. length: 10 characters; only alphanumeric and spaces

  Custom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the <a href="/bank-statements">Customizing bank statement references</a> article for details.
</ResponseField>

<ResponseField name="Shipping" type="object">
  **Default values:** `Shipping` information of the recurring pay-in registration object (if present).

  Information about the end user's shipping address, managed by `ShippingPreference`.

  <Expandable title="properties">
    <ResponseField name="FirstName" type="string">
      The first name of the user.
    </ResponseField>

    <ResponseField name="LastName" type="string">
      Max. length: 100 characters

      The last name of the user.
    </ResponseField>

    <ResponseField name="Address" type="object">
      Information about the shipping address.

      <Expandable title="properties">
        <ResponseField name="AddressLine1" type="string">
          Max. length: 255 characters

          The first line of the address.
        </ResponseField>

        <ResponseField name="AddressLine2" type="string">
          Max. length: 255 characters

          The second line of the address.
        </ResponseField>

        <ResponseField name="City" type="string">
          Max. length: 255 characters

          The city of the address.
        </ResponseField>

        <ResponseField name="Region" type="string">
          Max. length: 255 characters

          The region of the address. This field is optional except if the `Country` is US, CA, or MX.
        </ResponseField>

        <ResponseField name="PostalCode" type="string">
          Max. length: 255 characters

          The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        </ResponseField>

        <ResponseField name="Country" type="string">
          Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))

          The country of the address.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="LineItems" type="array">
  object

  Information about the items purchased in the transaction. The total of all line items’ `UnitAmount` and `TaxAmount` must equal the `DebitedFunds` amount (negative amounts not allowed).

  <Expandable title="properties">
    <ResponseField name="Name" type="string">
      Max. length: 127 characters (truncated after)

      The name of the item.
    </ResponseField>

    <ResponseField name="Quantity" type="integer">
      The quantity of the item.
    </ResponseField>

    <ResponseField name="UnitAmount" type="integer">
      The cost of the item, excluding tax.
    </ResponseField>

    <ResponseField name="TaxAmount" type="integer">
      The tax amount applied to the item.
    </ResponseField>

    <ResponseField name="Description" type="string">
      Max. length: 127 characters (truncated after)

      The platform’s unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `UserId` or the seller’s business name or first name and last name.\
      Caution: Failure to use a unique seller identifier may result in PayPal restricting your service.
    </ResponseField>

    <ResponseField name="Category" type="string">
      **Allowed values:** PHYSICAL\_GOODS, DIGITAL\_GOODS, DONATION

      The category of the item:

      * `PHYSICAL_GOODS` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.
      * `DIGITAL_GOODS` – Products or services that are distributed and consumed via digital platforms or devices. 
      * `DONATION` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `DONATION` within a single transaction, however it is not possible to combine `DONATION` other line item categories within the same transaction.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="Culture" type="string">
  **Returned values:** One of the supported languages in the <a href="/api-reference/overview/data-formats">ISO 639-1 format</a>: AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.

  The language in which the PayPal payment page is to be displayed.
</ResponseField>

<ResponseField name="ShippingPreference" type="string">
  **Returned values:** `SET_PROVIDED_ADDRESS`, `GET_FROM_FILE`, `NO_SHIPPING`

  Information about the shipping address behavior on the PayPal payment page:

  * `SET_PROVIDED_ADDRESS` - The `Shipping` parameter becomes required and its values are displayed to the end user, who is not able to modify them.
  * `GET_FROM_FILE` – The `Shipping` parameter is ignored and the end user can choose from registered addresses.
  * `NO_SHIPPING` – No shipping address section is displayed.
</ResponseField>

<ResponseField name="PaypalBuyerAccountEmail" type="string">
  The email address registered on the PayPal account used to make the payment.
</ResponseField>

<ResponseField name="Reference" type="string">
  Max. length: 127 characters (truncated after)

  The platform’s order reference for the transaction.
</ResponseField>

<ResponseField name="Trackings" type="array (object)">
  Shipping information of the `LineItems` added to the pay-in object.

  <Expandable title="properties">
    <ResponseField name="TrackingNumber" type="string">
      The shipment’s tracking number provided by the carrier.
    </ResponseField>

    <ResponseField name="Carrier" type="string">
      The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version.
    </ResponseField>

    <ResponseField name="NotifyBuyer" type="string">
      **Default value:** false

      If `true`, sends an email notification to the `PaypalBuyerAccountEmail` containing the `TrackingNumber` and `Carrier`, which allows the end user to track their shipment with the carrier.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="CancelURL" type="string">
  The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the RedirectURL.
</ResponseField>

<ResponseField name="PaypalOrderID" type="string">
  PayPal's unique identifier for the order.
</ResponseField>

<ResponseField name="BuyerCountry" type="string">
  The country of the buyer.
</ResponseField>

<ResponseField name="BuyerFirstname" type="string">
  The first name of the buyer.
</ResponseField>

<ResponseField name="BuyerPhone" type="string">
  The mobile phone number of the buyer.
</ResponseField>

<ResponseField name="BuyerLastname" type="string">
  The last name of the buyer.
</ResponseField>

<ResponseField name="PaypalPayerID" type="string">
  The PayPal identifier of the buyer.
</ResponseField>

<ResponseField name="RecurringPayinRegistrationId" type="string">
  The unique identifier of the recurring pay-in registration.
</ResponseField>

### Related resources

<Card title="Guide" href="/guides/payment-methods/card/recurring">Learn more about recurring card payments</Card>