Description
The Apple Pay PayIn object allows platforms to process payments with Apple Pay.Note – Prerequisites to using Apple PayUsing Apple Pay requires and activation from Mangopay, and your platform also needs to integrate with Apple Pay directly. See the Apple Pay guide for more information.
Attributes
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 fees. The values must match those requested from Apple Pay, because they are encrypted in the
PaymentData.The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
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:
REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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 debited wallet.In the case of a pay-in, this value is always
null since there is no debited wallet.The mode applied for the 3DS2 protocol. On Apple Pay, this value is returned
null as 3DS redirection is not applicable.Max. length: 255 charactersThe 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 charactersThe URL to which to redirect the user to proceed to 3DS2 validation. On Apple Pay,
null is returned as 3DS redirection does not apply.Max. length: 10 characters; only alphanumeric and spacesCustom 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.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
Guide
Learn more about Apple Pay
Testing
Learn about testing Apple Pay