Create an Apple Pay PayIn

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}".

The unique identifier of the user at the source of the transaction.

The unique identifier of the credited wallet.

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 <a href="/bank-statements">Customizing bank statement references</a> article for details.

The unique reference generated for the profiling session, used by the <a href="/guides/fraud-prevention">fraud prevention</a> 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 <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> for more information.

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, 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}".

Unix timestamp (UTC) of the date and time 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.

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

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.

The explanation of the result code.

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.

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 payment type of the pay-in.

Returned values: DIRECT

The execution type of the pay-in.

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.

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 <a href="/bank-statements">Customizing bank statement references</a> article for details.

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.

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.

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).