The Apple Pay PayIn object
Description
The Apple Pay PayIn object allows platforms to process payments with Apple Pay.
Caution – Prerequisites to using Apple Pay
Using Apple Pay requires approval and activation from Mangopay. See How to process an Apple Pay payment for more information.
The platform also needs to integrate with Apple Pay. For more information, see the Apple Pay documentation.
Attributes
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
The date and time at which the object was created.
The unique identifier of the user at the source of the transaction.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
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).
Information about the fees. The values must match those requested from Apple Pay, because they are encrypted in the PaymentData.
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.
The explanation of the result code.
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.
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.
The unique identifier of the credited wallet.
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.
Returned values: APPLEPAY
The type of pay-in.
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION
The type of execution for the pay-in.
The mode applied for the 3DS2 protocol. On Apple Pay, this value is returned null as 3DS redirection is not applicable.
With Apple Pay, this parameter is always 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 regarding security and anti-fraud tools.
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.
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.
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.
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.
The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay via the Dashboard for more information.
Related resources
Was this page helpful?