Mangopay Apple Pay API

openapi: 3.2.0
info:
  title: Reference Apple Pay API
  version: 1.0.0
servers:
- url: https://api.sandbox.mangopay.com
  description: Sandbox
- url: https://api.mangopay.com
  description: Production
- url: https://api-mtls.sandbox.mangopay.com
  description: mTLS Sandbox
- url: https://api-mtls.mangopay.com
  description: mTLS Production
- url: '%7BCardRegistrationUrl%7D'
  description: "The full dynamic URL returned by the Create a Card Registration call, including host, path, and query parameters. \n"
- url: '%7BSettlementFileUploadUrl%7D'
  description: 'The unique URL returned by the [POST Create a Settlement and secure URL](/api-reference/settlements/create-settlement) endpoint.


    **Note:** Use the full dynamic URL including the host, path, and all query parameters. The URL is already authenticated, so this call does not require an Authorization header.

    '
tags:
- name: applePay
paths:
  /v2.01/{ClientId}/payins/applepay/direct:
    post:
      operationId: applePay_create_apple_pay_payin
      summary: Create an Apple Pay PayIn
      tags:
      - applePay
      parameters:
      - name: ClientId
        in: path
        description: Platform's API account identifier, associated with the API key.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplePayPayInResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAnApplePayPayInRequest'
      security:
      - oauth2: []
components:
  schemas:
    AuthenticationResult:
      type: object
      properties:
        AuthenticationType:
          type:
          - string
          - 'null'
          description: '**Returned values:** `CHALLENGE`, `FRICTIONLESS`, `DIRECT_AUTHORIZATION`


            The type of authentication:


            - `CHALLENGE` – The issuer requested SCA to be enforced (for example, using 3DS).

            - `FRICTIONLESS` – The transaction was exempted from SCA because an exemption was granted by the issuer.

            - `DIRECT_AUTHORIZATION` – The transaction was sent to the issuer for authorization without any frictionless or challenge (for example, if SCA doesn''t apply). A `null` value typically indicates that authentication was not requested (for example, because the request failed before being sent) or a decision was not received.


            A `null` value typically indicates that authentication was not requested (for example, because the request failed before being sent) or a decision was not received.'
      description: 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).
      title: AuthenticationResult
    Amount:
      type: integer
      description: The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      title: Amount
    FlowDescriptorRequestBeneficiariesItems:
      type: object
      properties:
        UserId:
          type: string
          description: The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in.
      title: FlowDescriptorRequestBeneficiariesItems
    FlowDescriptorResponseBeneficiariesItems:
      type: object
      properties:
        UserId:
          type: string
          description: The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in.
      title: FlowDescriptorResponseBeneficiariesItems
    TransactionExecutionDate:
      type: integer
      description: 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`.
      title: TransactionExecutionDate
    PreferredCardNetwork_ApplePay:
      type:
      - string
      - 'null'
      description: 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.
      title: PreferredCardNetwork_ApplePay
    AuthorId:
      type: string
      description: The unique identifier of the user at the source of the transaction.
      title: AuthorId
    PaymentCategory:
      type: string
      description: '**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).'
      title: PaymentCategory
    ProfilingAttemptReference:
      type: string
      description: '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.'
      title: ProfilingAttemptReference
    FlowDescriptorRequest:
      type: object
      properties:
        Beneficiaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FlowDescriptorRequestBeneficiariesItems'
          description: 'Max. length: 5 items


            The list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values.'
      description: "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](/guides/payin-beneficiaries)).\n\nIf the `FlowDescriptor.Beneficiaries` is sent in the API request, then:\n- The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks.\n- **ALL** `UserId` values in the array must be one of:\n  - `OWNER` whose `KYCLevel` is `REGULAR`\n  - `PLATFORM`\n  \nThe pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is:\n- `PAYER`\n- `OWNER` whose `KYCLevel` is `LIGHT`\n\nIf 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`. \n"
      title: FlowDescriptorRequest
    CreateAnApplePayPayInRequestDebitedFunds:
      type: object
      properties:
        Currency:
          $ref: '#/components/schemas/Currency'
        Amount:
          $ref: '#/components/schemas/Amount'
      required:
      - Currency
      - Amount
      description: Information about the debited funds.
      title: CreateAnApplePayPayInRequestDebitedFunds
    ApplePayPayInResponseFees:
      type: object
      properties:
        Currency:
          $ref: '#/components/schemas/Currency'
        Amount:
          $ref: '#/components/schemas/Amount'
      description: Information about the fees.
      title: ApplePayPayInResponseFees
    TransactionStatus:
      type: string
      description: '**Returned values:** `CREATED`, `SUCCEEDED`, `FAILED`


        The status of the transaction.'
      title: TransactionStatus
    FlowDescriptorResponse:
      type: object
      properties:
        FlowId:
          type: string
          description: Unique identifier of the payment flow, used by Mangopay for internal purposes.
        Beneficiaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FlowDescriptorResponseBeneficiariesItems'
          description: 'Max. length: 5 items


            The list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values.'
      description: "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](/guides/payin-beneficiaries)).\n\nIf the `FlowDescriptor.Beneficiaries` is sent in the API request, then:\n- The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks.\n- **ALL** `UserId` values in the array must be one of:\n  - `OWNER` whose `KYCLevel` is `REGULAR`\n  - `PLATFORM`\n  \nThe pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is:\n- `PAYER`\n- `OWNER` whose `KYCLevel` is `LIGHT`\n\nIf 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`.\n"
      title: FlowDescriptorResponse
    ResultMessage:
      type: string
      description: The explanation of the result code.
      title: ResultMessage
    Currency:
      type: string
      description: '**Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).


        The currency of the amount.'
      title: Currency
    CreditedUserId:
      type: string
      description: '**Default value:** The unique identifier of the owner of the credited wallet.


        The unique identifier of the user whose wallet is credited.'
      title: CreditedUserId
    ApplePayPayInResponseBrowserInfo:
      type: object
      properties: {}
      description: 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.
      title: ApplePayPayInResponseBrowserInfo
    StatementDescriptor_22:
      type: string
      description: '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.'
      title: StatementDescriptor_22
    TransactionNature:
      type: string
      description: '**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.'
      title: TransactionNature
    AVSResult:
      type: object
      properties:
        AVSResult:
          type: string
          description: The result of the Address Verification System check (only available for UK, US, and Canada).
      description: Information regarding security and anti-fraud tools.
      title: AVSResult
    ApplePayPayInResponse:
      type: object
      properties:
        Id:
          $ref: '#/components/schemas/Id'
        Tag:
          $ref: '#/components/schemas/Tag'
        CreationDate:
          $ref: '#/components/schemas/CreationDate'
        AuthorId:
          $ref: '#/components/schemas/AuthorId'
        CreditedUserId:
          $ref: '#/components/schemas/CreditedUserId'
        FlowDescriptor:
          $ref: '#/components/schemas/FlowDescriptorResponse'
        DebitedFunds:
          $ref: '#/components/schemas/ApplePayPayInResponseDebitedFunds'
          description: Information about the debited funds. The values must match those requested from Apple Pay, because they are encrypted in the `PaymentData`.
        CreditedFunds:
          $ref: '#/components/schemas/ApplePayPayInResponseCreditedFunds'
          description: Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).
        Fees:
          $ref: '#/components/schemas/ApplePayPayInResponseFees'
          description: Information about the fees.
        Status:
          $ref: '#/components/schemas/TransactionStatus'
        ResultCode:
          $ref: '#/components/schemas/ResultCode'
        ResultMessage:
          $ref: '#/components/schemas/ResultMessage'
        ExecutionDate:
          $ref: '#/components/schemas/TransactionExecutionDate'
        Type:
          $ref: '#/components/schemas/TransactionType'
        Nature:
          $ref: '#/components/schemas/TransactionNature'
        CreditedWalletId:
          type: string
          description: The unique identifier of the credited wallet.
        DebitedWalletId:
          type: string
          description: '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.'
        PaymentType:
          type: string
          description: '**Returned values:** `APPLEPAY`


            The payment type of the pay-in.'
        ExecutionType:
          type: string
          description: '**Returned values:** `DIRECT`


            The execution type of the pay-in.'
        SecureMode:
          type: string
          description: The mode applied for the 3DS2 protocol. On Apple Pay, this value is returned `null` as 3DS redirection is not applicable.
        CardId:
          type: string
          description: For Apple Pay recurring registrations, this value is returned `null`.
        SecureModeReturnURL:
          type: string
          description: '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.'
        SecureModeRedirectURL:
          type: string
          description: '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.'
        SecureModeNeeded:
          type: boolean
          description: Whether or not the `SecureMode` was used.
        Culture:
          type: string
          description: The language in which the payment page is to be displayed. On Apple Pay, `null` is returned.
        SecurityInfo:
          $ref: '#/components/schemas/AVSResult'
        StatementDescriptor:
          $ref: '#/components/schemas/StatementDescriptor_22'
        BrowserInfo:
          $ref: '#/components/schemas/ApplePayPayInResponseBrowserInfo'
          description: 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.
        IpAddress:
          type: string
          description: 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.
        Billing:
          $ref: '#/components/schemas/ApplePayPayInResponseBilling'
          description: Information about the end user billing address. On Apple Pay, `null` is returned as 3DS redirection does not apply.
        Shipping:
          $ref: '#/components/schemas/ApplePayPayInResponseShipping'
          description: Information about the end user's shipping address. On Apple Pay, `null` is returned as 3DS redirection does not apply.
        Requested3DSVersion:
          type: string
          description: '**Returned values:** `V1`, `V2_1`


            The 3DS protocol version to be applied to the transaction.'
        Applied3DSVersion:
          type: string
          description: '**Returned values:** `V1`, `V2_1`


            The 3DS protocol version applied to the transaction.'
        RecurringPayinRegistrationId:
          type: string
          description: The unique identifier of the recurring pay-in registration.
        PreferredCardNetwork:
          $ref: '#/components/schemas/PreferredCardNetwork_ApplePay'
        PaymentCategory:
          $ref: '#/components/schemas/PaymentCategory'
        CardInfo:
          $ref: '#/components/schemas/CardInfo'
        AuthenticationResult:
          $ref: '#/components/schemas/AuthenticationResult'
      description: 'A one-time Apple Pay pay-in:

        - `PaymentType` – `APPLEPAY`

        - `ExecutionType` – `DIRECT`

        - Object does not include `RecurringPayinRegistrationId`'
      title: ApplePayPayInResponse
    Tag:
      type: string
      description: '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}"`.'
      title: Tag
    CreationDate:
      type: integer
      description: Unix timestamp (UTC) of the date and time the object was created.
      title: CreationDate
    ApplePayPayInResponseBilling:
      type: object
      properties: {}
      description: Information about the end user billing address. On Apple Pay, `null` is returned as 3DS redirection does not apply.
      title: ApplePayPayInResponseBilling
    CreateAnApplePayPayInRequest:
      type: object
      properties:
        Tag:
          $ref: '#/components/schemas/Tag'
        AuthorId:
          $ref: '#/components/schemas/AuthorId'
        CreditedWalletId:
          type: string
          description: The unique identifier of the credited wallet.
        FlowDescriptor:
          $ref: '#/components/schemas/FlowDescriptorRequest'
        DebitedFunds:
          $ref: '#/components/schemas/CreateAnApplePayPayInRequestDebitedFunds'
          description: Information about the debited funds.
        Fees:
          $ref: '#/components/schemas/CreateAnApplePayPayInRequestFees'
          description: Information about the fees.
        StatementDescriptor:
          $ref: '#/components/schemas/StatementDescriptor_22'
        PaymentData:
          $ref: '#/components/schemas/PaymentData_ApplePay'
        ProfilingAttemptReference:
          $ref: '#/components/schemas/ProfilingAttemptReference'
      required:
      - AuthorId
      - CreditedWalletId
      - DebitedFunds
      - Fees
      - PaymentData
      title: CreateAnApplePayPayInRequest
    ApplePayPayInResponseDebitedFunds:
      type: object
      properties:
        Currency:
          $ref: '#/components/schemas/Currency'
        Amount:
          $ref: '#/components/schemas/Amount'
      description: Information about the debited funds. The values must match those requested from Apple Pay, because they are encrypted in the `PaymentData`.
      title: ApplePayPayInResponseDebitedFunds
    Id:
      type: string
      description: 'Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details)


        The unique identifier of the object.'
      title: Id
    ApplePayPayInResponseCreditedFunds:
      type: object
      properties:
        Currency:
          $ref: '#/components/schemas/Currency'
        Amount:
          $ref: '#/components/schemas/Amount'
      description: Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).
      title: ApplePayPayInResponseCreditedFunds
    ApplePayPayInResponseShipping:
      type: object
      properties: {}
      description: Information about the end user's shipping address. On Apple Pay, `null` is returned as 3DS redirection does not apply.
      title: ApplePayPayInResponseShipping
    ResultCode:
      type: string
      description: 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.
      title: ResultCode
    TransactionType:
      type: string
      description: '**Returned values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`


        The type of the transaction.'
      title: TransactionType
    CreateAnApplePayPayInRequestFees:
      type: object
      properties:
        Currency:
          $ref: '#/components/schemas/Currency'
        Amount:
          $ref: '#/components/schemas/Amount'
      required:
      - Currency
      - Amount
      description: Information about the fees.
      title: CreateAnApplePayPayInRequestFees
    CardInfo:
      type: object
      properties:
        BIN:
          type: string
          description: The bank identification number (BIN) of the card.
        IssuingBank:
          type: string
          description: The name of the bank that issued the card.
        IssuerCountryCode:
          type: string
          description: The country code of the card issuer.
        Type:
          type: string
          description: The type of card (for example, `CREDIT` or `DEBIT`).
        SubType:
          type:
          - string
          - 'null'
          description: The sub-type of the card, if available.
        Brand:
          type: string
          description: The card brand (for example, `VISA` or `MASTERCARD`).
      description: Information about the card used for the transaction. If the information or data is not available, `null` is returned.
      title: CardInfo
    PaymentData_ApplePay:
      type: object
      properties:
        TokenData:
          type: string
          description: The encrypted string for the payment request.
        TransactionId:
          type: string
          description: Apple Pay's unique identifier of the payment.
        Network:
          type: string
          description: '**Returned values:** MasterCard, Visa, CartesBancaires


            The payment network used for the payment request, as resolved by Apple Pay. The pay-in''s `PreferredCardNetwork` property does not apply to Apple Pay.'
      required:
      - TokenData
      - TransactionId
      - Network
      description: The data returned by Apple Pay containing information about the payment.
      title: PaymentData_ApplePay
  securitySchemes:
    oauth2:
      type: http
      scheme: bearer
      description: "Bearer authentication of the form `Bearer <token>`, where token is your auth token. \n\nIf 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."
x-provenance:
  method: harvested
  publisher: Mangopay
  source: https://docs.mangopay.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)