> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.mangopay.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mangopay.com/_mcp/server. # The Recurring Apple Pay PayIn object ### Description The Recurring Apple Pay PayIn object represents an Apple Pay pay-in linked to a [Recurring PayIn Registration](/api-reference/recurring-payin-registrations/recurring-payin-registration-object) object. 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. > **Note** > > **Note – Prerequisites to using Apple Pay** > > Using Apple Pay requires activation from Mangopay, and your platform also needs to integrate with Apple Pay directly. See the [Apple Pay guide](/guides/payment-methods/apple-pay) for more information. > **Note** > > **Note – Max. 99 pay-ins possible against each registration** > > A maximum of 99 pay-ins, CIT and MIT included, can be made against each Recurring PayIn Registration. Once you reach this limit, the 100th pay-in will fail with the error [205001](/errors/codes/205001). > > You need to create a new registration object to restart the recurrence (with a CIT). ### Attributes ### Schema (`RecurringApplePayPayInResponse`) ```yaml components: schemas: Id: type: string description: >- Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. title: Id Tag: type: string description: >- Max. length: 255 characters Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: `"{\"id_1\":AB123,\"id_2\":DE456}"`. title: Tag CreationDate: type: integer description: Unix timestamp (UTC) of the date and time the object was created. title: CreationDate AuthorId: type: string description: The unique identifier of the user at the source of the transaction. title: AuthorId Currency: type: string description: >- **Allowed values:** The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings). The currency of the amount. title: Currency Amount: type: integer description: >- The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`. title: Amount RecurringApplePayPayInResponseDebitedFunds: type: object properties: Currency: $ref: '#/components/schemas/Currency' Amount: $ref: '#/components/schemas/Amount' description: >- Information about the debited funds. The values must match those requested from Apple Pay, because they are encrypted in the `PaymentData`. title: RecurringApplePayPayInResponseDebitedFunds RecurringApplePayPayInResponseCreditedFunds: type: object properties: Currency: $ref: '#/components/schemas/Currency' Amount: $ref: '#/components/schemas/Amount' description: >- Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`). title: RecurringApplePayPayInResponseCreditedFunds RecurringApplePayPayInResponseFees: type: object properties: Currency: $ref: '#/components/schemas/Currency' Amount: $ref: '#/components/schemas/Amount' description: Information about the fees. title: RecurringApplePayPayInResponseFees TransactionStatus: type: string description: |- **Returned values:** `CREATED`, `SUCCEEDED`, `FAILED` The status of the transaction. title: TransactionStatus ResultCode: type: string description: >- The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. title: ResultCode ResultMessage: type: string description: The explanation of the result code. title: ResultMessage TransactionExecutionDate: type: integer description: >- Unix timestamp (UTC) of the date and time the status changed to `SUCCEEDED`, indicating that the transaction occurred. The statuses `CREATED` and `FAILED` return an `ExecutionDate` of `null`. title: TransactionExecutionDate TransactionType: type: string description: |- **Returned values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT` The type of the transaction. title: TransactionType TransactionNature: type: string description: >- **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. title: TransactionNature CreditedUserId: type: string description: >- **Default value:** The unique identifier of the owner of the credited wallet. The unique identifier of the user whose wallet is credited. title: CreditedUserId StatementDescriptor_22: type: string description: >- Max. length: 22 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 Customizing bank statement references article for details. title: StatementDescriptor_22 AVSResult: type: object properties: AVSResult: type: string description: >- The result of the Address Verification System check (only available for UK, US, and Canada). description: Information regarding security and anti-fraud tools. title: AVSResult RecurringApplePayPayInResponseBrowserInfo: type: object properties: {} description: >- Information about the browser used by the end user (author) to perform the payment. On Apple Pay, `null` is returned as 3DS redirection does not apply. title: RecurringApplePayPayInResponseBrowserInfo PreferredCardNetwork_ApplePay: type: - string - 'null' description: >- Not applicable to Apple Pay pay-ins, so this value is returned `null`. For Apple Pay, the network is resolved by Apple Pay and returned in `PaymentData.Network` instead. title: PreferredCardNetwork_ApplePay PaymentCategory: type: string description: >- **Default value:** `ECommerce` **Allowed values:** `ECommerce`, `TelephoneOrder` The channel through which the user provided their card details, used to indicate mail-order and telephone-order (MOTO) payments: - `ECommerce` – Payment received online. - `TelephoneOrder` – Payment received via mail order or telephone order (MOTO). title: PaymentCategory CardInfo: type: object properties: BIN: type: string description: The bank identification number (BIN) of the card. IssuingBank: type: string description: The name of the bank that issued the card. IssuerCountryCode: type: string description: The country code of the card issuer. Type: type: string description: The type of card (for example, `CREDIT` or `DEBIT`). SubType: type: - string - 'null' description: The sub-type of the card, if available. Brand: type: string description: The card brand (for example, `VISA` or `MASTERCARD`). description: >- Information about the card used for the transaction. If the information or data is not available, `null` is returned. title: CardInfo AuthenticationResult: type: object properties: AuthenticationType: type: - string - 'null' description: >- **Returned values:** `CHALLENGE`, `FRICTIONLESS`, `DIRECT_AUTHORIZATION` The type of authentication: - `CHALLENGE` – The issuer requested SCA to be enforced (for example, using 3DS). - `FRICTIONLESS` – The transaction was exempted from SCA because an exemption was granted by the issuer. - `DIRECT_AUTHORIZATION` – The transaction was sent to the issuer for authorization without any frictionless or challenge (for example, if SCA doesn't apply). A `null` value typically indicates that authentication was not requested (for example, because the request failed before being sent) or a decision was not received. A `null` value typically indicates that authentication was not requested (for example, because the request failed before being sent) or a decision was not received. description: >- Information about the authentication result, based on the request made by Mangopay and the decision of the issuer regarding the type of authentication to be enforced (if applicable). title: AuthenticationResult RecurringApplePayPayInResponseBilling: type: object properties: {} description: >- Information about the end user billing address. On Apple Pay, `null` is returned as 3DS redirection does not apply. title: RecurringApplePayPayInResponseBilling RecurringApplePayPayInResponseShipping: type: object properties: {} description: >- Information about the end user's shipping address. On Apple Pay, `null` is returned as 3DS redirection does not apply. title: RecurringApplePayPayInResponseShipping RecurringApplePayPayInResponse: type: object properties: Id: $ref: '#/components/schemas/Id' Tag: $ref: '#/components/schemas/Tag' CreationDate: $ref: '#/components/schemas/CreationDate' AuthorId: $ref: '#/components/schemas/AuthorId' DebitedFunds: $ref: '#/components/schemas/RecurringApplePayPayInResponseDebitedFunds' description: >- Information about the debited funds. The values must match those requested from Apple Pay, because they are encrypted in the `PaymentData`. CreditedFunds: $ref: '#/components/schemas/RecurringApplePayPayInResponseCreditedFunds' description: >- Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`). Fees: $ref: '#/components/schemas/RecurringApplePayPayInResponseFees' description: Information about the fees. Status: $ref: '#/components/schemas/TransactionStatus' ResultCode: $ref: '#/components/schemas/ResultCode' ResultMessage: $ref: '#/components/schemas/ResultMessage' ExecutionDate: $ref: '#/components/schemas/TransactionExecutionDate' Type: $ref: '#/components/schemas/TransactionType' Nature: $ref: '#/components/schemas/TransactionNature' CreditedWalletId: type: string description: The unique identifier of the credited wallet. CreditedUserId: $ref: '#/components/schemas/CreditedUserId' PaymentType: type: string description: |- **Returned values:** `APPLEPAY` The payment type of the pay-in. ExecutionType: type: string description: |- **Returned values:** `DIRECT` The execution type of the pay-in. StatementDescriptor: $ref: '#/components/schemas/StatementDescriptor_22' DebitedWalletId: type: string description: >- The unique identifier of the debited wallet. In the case of a pay-in, this value is always `null` since there is no debited wallet. SecurityInfo: $ref: '#/components/schemas/AVSResult' SecureMode: type: string description: >- The mode applied for the 3DS2 protocol. On Apple Pay, this value is returned `null` as 3DS redirection is not applicable. CardId: type: string description: >- For Apple Pay recurring registrations, this value is returned `null`. SecureModeReturnURL: type: string description: >- Max. length: 255 characters The URL to which users are automatically returned after 3DS2 if it is triggered. On Apple Pay, `null` is returned as 3DS redirection does not apply. SecureModeRedirectURL: type: string description: >- Max. length: 255 characters The URL to which to redirect the user to proceed to 3DS2 validation. On Apple Pay, `null` is returned as 3DS redirection does not apply. SecureModeNeeded: type: boolean description: Whether or not the `SecureMode` was used. Culture: type: string description: >- The language in which the payment page is to be displayed. On Apple Pay, `null` is returned. BrowserInfo: $ref: '#/components/schemas/RecurringApplePayPayInResponseBrowserInfo' description: >- Information about the browser used by the end user (author) to perform the payment. On Apple Pay, `null` is returned as 3DS redirection does not apply. IpAddress: type: string description: >- The IP address of the end user initiating the transaction, in IPV4 or IPV6 format. On Apple Pay, `null` is returned as 3DS redirection does not apply. Requested3DSVersion: type: string description: |- **Returned values:** `V1`, `V2_1` The 3DS protocol version to be applied to the transaction. Applied3DSVersion: type: string description: |- **Returned values:** `V1`, `V2_1` The 3DS protocol version applied to the transaction. RecurringPayinRegistrationId: type: string description: The unique identifier of the recurring pay-in registration. PreferredCardNetwork: $ref: '#/components/schemas/PreferredCardNetwork_ApplePay' PaymentCategory: $ref: '#/components/schemas/PaymentCategory' CardInfo: $ref: '#/components/schemas/CardInfo' AuthenticationResult: $ref: '#/components/schemas/AuthenticationResult' Billing: $ref: '#/components/schemas/RecurringApplePayPayInResponseBilling' description: >- Information about the end user billing address. On Apple Pay, `null` is returned as 3DS redirection does not apply. Shipping: $ref: '#/components/schemas/RecurringApplePayPayInResponseShipping' description: >- Information about the end user's shipping address. On Apple Pay, `null` is returned as 3DS redirection does not apply. title: RecurringApplePayPayInResponse ``` ### Related resources #### [Guide](/guides/payment-methods/apple-pay#recurring-payments) Learn more about recurring Apple Pay payments #### [Testing](/testing/payment-methods#apple-pay) Learn about testing Apple Pay