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 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 – 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 for more information.
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.
You need to create a new registration object to restart the recurrence (with a CIT).
Attributes
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
Unix timestamp (UTC) of the date and time the object was created.
Information about the debited funds. The values must match those requested from Apple Pay, because they are encrypted in the PaymentData.
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
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.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
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.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
Returned values: APPLEPAY
The payment type of the pay-in.
Returned values: DIRECT
The execution type of the pay-in.
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 Customizing bank statement references article for details.
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.
Information regarding security and anti-fraud tools.
The mode applied for the 3DS2 protocol. On Apple Pay, this value is returned null as 3DS redirection is not applicable.
For Apple Pay recurring registrations, this value is returned null.
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.
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.
Whether or not the SecureMode was used.
The language in which the payment page is to be displayed. On Apple Pay, null is returned.
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.
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.
Returned values: V1, V2_1
The 3DS protocol version to be applied to the transaction.
Returned values: V1, V2_1
The 3DS protocol version applied to the transaction.
The unique identifier of the recurring pay-in registration.
Allowed values: VISA, MASTERCARD, CB, MAESTRO
The card network to use, as chosen by the cardholder, in case of co-branded cards.
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).
Information about the card used for the transaction. If the information or data is not available, null is returned.
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).
Information about the end user billing address. On Apple Pay, null is returned as 3DS redirection does not apply.
Information about the end user’s shipping address. On Apple Pay, null is returned as 3DS redirection does not apply.