Create an Apple Pay PayIn

POST

/v2.01/:ClientId/payins/applepay/direct

POST

/v2.01/:ClientId/payins/applepay/direct

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payins/applepay/direct \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "AuthorId": "user_m_01J84RCFJ0Q9RVQZ13618FSNWN",
>     "CreditedWalletId": "wlt_m_01J84RDF46N1EQJ9ZA1560B1ZK",
>     "DebitedFunds": {
>       "Amount": 1600,
>       "Currency": "EUR"
>     },
>     "Fees": {
>       "Amount": 0,
>       "Currency": "EUR"
>     },
>     "FlowDescriptor": {
>       "Beneficiaries": [
>         {
>           "UserId": "user_m_02APAYTWSDYXHXN1FRTKX9WMA2"
>         }
>       ]
>     },
>     "PaymentData": {
>       "network": "MasterCard",
>       "tokenData": "{\"data\":\"2TihgKbmyPje02jYvkB6P+a6LCNmvKTFi4b7UN32sP4FJkllQP8CXIUPdv71xpIpBHetQ6TL7ON3Yex3L0Sc9hm15pME46/5fehwUxmgiumiK1eTupckAST6Zc0IYy2f9iJB9XpX+6dnKqTj7di12bo/iDXW4g2rbenNiDI0caiWebDaUG9DHSFjDxipQWx3Z8rf+zDiMGuDwO41LVh2SA1hRVbdINLpPpLtpxvyDeDkPQVohakcE+sK83QCHx0cEahAUKj6gAv6QuOLtWTsTtad04/ct3G0GnGeRp9p0fE0yJ+s4ybPj4WuV8lKNm6Lsg/WS9TqzT3RFgdjDjGdZ8W1CaEb/deG+Hh4MCebVJBP7iEdyfkB1afjJa0AqfbOBW2SIKXULtjP84QP\",\"signature\":\"MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJKoZIhvcNAQcBAACggDCCA+MwggOIoAMCAQICCEwwQUlRnVQ2MAoGCCqGSM49BAMCMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xOTA1MTgwMTMyNTdaFw0yNDA1MTYwMTMyNTdaMF8xJTAjBgNVBAMMHGVjYy1zbXAtYnJva2VyLXNpZ25fVUM0LVBST0QxFDASBgNVBAsMC2lPUyBTeXN0ZW1zMRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABMIVd+3r1seyIY9o3XCQoSGNx7C9bywoPYRgldlK9KVBG4NCDtgR80B+gzMfHFTD9+syINa61dTv9JKJiT58DxOjggIRMIICDTAMBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFCPyScRPk+TvJ+bE9ihsP6K7/S5LMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDQGA1UdHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlYWljYTMuY3JsMB0GA1UdDgQWBBSUV9tv1XSBhomJdi9+V4UH55tYJDAOBgNVHQ8BAf8EBAMCB4AwDwYJKoZIhvdjZAYdBAIFADAKBggqhkjOPQQDAgNJADBGAiEAvglXH+ceHnNbVeWvrLTHL+tEXzAYUiLHJRACth69b1UCIQDRizUKXdbdbrF0YDWxHrLOh8+j5q9svYOAiQ3ILN2qYzCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI/JJxE+T5O8n5sT2KGw/orv9LkswDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn/Rd8LCFtlk/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYgwggGEAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIITDBBSVGdVDYwCwYJYIZIAWUDBAIBoIGTMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTIzMTAwNDE0MjczMlowKAYJKoZIhvcNAQk0MRswGTALBglghkgBZQMEAgGhCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEICNPuucWpap0huG1HkZR1liLCfnUyPRFKc3BMuYYfb/1MAoGCCqGSM49BAMCBEcwRQIhAJSGdxshD9TsTvVniHsRx1Jez6j/5cv+1HFeJCjQxpXPAiBXBwBFqfvNpeUuEGHIJATVLN4kGQaxAunVG6aZ36e0CwAAAAAAAA==\",\"header\":{\"publicKeyHash\":\"xUyeFb75d359bfPEiq2JJMQj694UAxtTuBsaTWMOJxQ=\",\"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEkeuICjZ7x15b7hPEBEBT5Zp43l95wCmJCU3QNxBvOCusG9w9sJMULuXlT4K8LOlPgaZzAcyWlfNwnLivVdOPfg==\",\"transactionId\":\"97e64d87f13a89ff6443cdcc205d5ccf7e15368b0d64126a8a2e0888a3a5c2a0\"},\"version\":\"EC_v1\"}",
>       "transactionId": "97e64d87f13a89ff6443cdcc205d5ccf7e15368b0d64126a8a2e0888a3a5c2a0"
>     },
>     "StatementDescriptor": "Custom data",
>     "Tag": "Created using the Mangopay API Postman collection"
>   }
> }'

200Successful

1 {
2   "Id": "payin_m_01J83BDHEBH7Z0ZSR7WZXEZ6RB",
3   "Tag": "Created using the Mangopay API Postman collection",
4   "CreationDate": 1726689494,
5   "AuthorId": "user_m_01J84RCFJ0Q9RVQZ13618FSNWN",
6   "CreditedUserId": "user_m_01J84RCFJ0Q9RVQZ13618FSNWN",
7   "FlowDescriptor": {
8     "FlowId": "flow_wt_97448e0a-5bc6-4b83-ac29-cdfcadf60a08",
9     "Beneficiaries": [
10       {
11         "UserId": "user_m_02APAYTWSDYXHXN1FRTKX9WMA2"
12       }
13     ]
14   },
15   "DebitedFunds": {
16     "Currency": "EUR",
17     "Amount": 1600
18   },
19   "CreditedFunds": {
20     "Currency": "EUR",
21     "Amount": 1600
22   },
23   "Fees": {
24     "Currency": "EUR",
25     "Amount": 0
26   },
27   "Status": "SUCCEEDED",
28   "ResultCode": "000000",
29   "ResultMessage": "Success",
30   "ExecutionDate": 1726689503,
31   "Type": "PAYIN",
32   "Nature": "REGULAR",
33   "CreditedWalletId": "wlt_m_01J84RDF46N1EQJ9ZA1560B1ZK",
34   "DebitedWalletId": null,
35   "PaymentType": "APPLEPAY",
36   "ExecutionType": "DIRECT",
37   "SecureMode": null,
38   "CardId": null,
39   "SecureModeReturnURL": null,
40   "SecureModeRedirectURL": null,
41   "SecureModeNeeded": false,
42   "Culture": null,
43   "SecurityInfo": {
44     "AVSResult": "NO_CHECK"
45   },
46   "StatementDescriptor": "Custom data",
47   "BrowserInfo": null,
48   "IpAddress": null,
49   "Billing": null,
50   "Shipping": null,
51   "Requested3DSVersion": null,
52   "Applied3DSVersion": null,
53   "RecurringPayinRegistrationId": null,
54   "PreferredCardNetwork": null,
55   "PaymentCategory": null,
56   "CardInfo": {
57     "BIN": "516398",
58     "IssuingBank": "BANCO SANTANDER S.A.",
59     "IssuerCountryCode": "ES",
60     "Type": "DEBIT",
61     "SubType": "PLATINUM",
62     "Brand": "MASTERCARD"
63   },
64   "AuthenticationResult": {
65     "AuthenticationType": "FRICTIONLESS"
66   }
67 }

Create an Apple Pay PayIn

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.

AuthorIdstringRequired

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

CreditedWalletIdstringRequired

The unique identifier of the credited wallet.

DebitedFundsobjectRequired

Information about the debited funds.

FeesobjectRequired

Information about the fees.

PaymentDataobjectRequired

The data returned by Apple Pay containing information about the payment.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

FlowDescriptorobjectOptional

Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made (read more).

If the FlowDescriptor.Beneficiaries is sent in the API request, then:

The transaction’s CreditedWalletId holder is disregarded in KYC/KYB checks.
ALL UserId values in the array must be one of:
- OWNER whose KYCLevel is REGULAR
- PLATFORM

The pay-in Status becomes FAILED with ResultCode 002951 if at least one FlowDescriptor.Beneficiaries.UserId is:

PAYER
OWNER whose KYCLevel is LIGHT

If the FlowDescriptor.Beneficiaries is not sent in the API request, then the CreditedWalletId holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the CreditedWalletId holder is a PAYER or the same value as one of the FlowDescriptor.Beneficiaries.

StatementDescriptorstringOptional

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.

ProfilingAttemptReferencestringOptional

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.

Response

Success

IdstringOptional

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateintegerOptional

Unix timestamp (UTC) of the date and time the object was created.

AuthorIdstringOptional

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

CreditedUserIdstringOptional

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

FlowDescriptorobjectOptional

Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made (read more).

If the FlowDescriptor.Beneficiaries is sent in the API request, then:

The transaction’s CreditedWalletId holder is disregarded in KYC/KYB checks.
ALL UserId values in the array must be one of:
- OWNER whose KYCLevel is REGULAR
- PLATFORM

The pay-in Status becomes FAILED with ResultCode 002951 if at least one FlowDescriptor.Beneficiaries.UserId is:

PAYER
OWNER whose KYCLevel is LIGHT

DebitedFundsobjectOptional

Information about the debited funds. The values must match those requested from Apple Pay, because they are encrypted in the PaymentData.

CreditedFundsobjectOptional

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

FeesobjectOptional

Information about the fees.

StatusstringOptional

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCodestringOptional

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestringOptional

The explanation of the result code.

ExecutionDateintegerOptional

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.

TypestringOptional

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

NaturestringOptional

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.

CreditedWalletIdstringOptional

The unique identifier of the credited wallet.

DebitedWalletIdstringOptional

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.

PaymentTypestringOptional

Returned values: APPLEPAY

The payment type of the pay-in.

ExecutionTypestringOptional

Returned values: DIRECT

The execution type of the pay-in.

SecureModestringOptional

The mode applied for the 3DS2 protocol. On Apple Pay, this value is returned null as 3DS redirection is not applicable.

CardIdstringOptional

For Apple Pay recurring registrations, this value is returned null.

SecureModeReturnURLstringOptional

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.

SecureModeRedirectURLstringOptional

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.

SecureModeNeededbooleanOptional

Whether or not the SecureMode was used.

CulturestringOptional

The language in which the payment page is to be displayed. On Apple Pay, null is returned.

SecurityInfoobjectOptional

Information regarding security and anti-fraud tools.

StatementDescriptorstringOptional

Max. length: 10 characters; only alphanumeric and spaces

BrowserInfoobjectOptional

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.

IpAddressstringOptional

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.

BillingobjectOptional

Information about the end user billing address. On Apple Pay, null is returned as 3DS redirection does not apply.

ShippingobjectOptional

Information about the end user’s shipping address. On Apple Pay, null is returned as 3DS redirection does not apply.

Requested3DSVersionstringOptional

Returned values: V1, V2_1

The 3DS protocol version to be applied to the transaction.

Applied3DSVersionstringOptional

Returned values: V1, V2_1

The 3DS protocol version applied to the transaction.

RecurringPayinRegistrationIdstringOptional

The unique identifier of the recurring pay-in registration.

PreferredCardNetworkstringOptional

Allowed values: VISA, MASTERCARD, CB, MAESTRO

The card network to use, as chosen by the cardholder, in case of co-branded cards.

PaymentCategorystringOptional

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

CardInfoobjectOptional

Information about the card used for the transaction. If the information or data is not available, null is returned.

AuthenticationResultobjectOptional

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