Mangopay Web Card Payins API

The webCardPayins API from Mangopay — 2 operation(s) for webcardpayins.

Operations 2

POST /v2.01/{ClientId}/payins/card/web Create a Web Card PayIn #
GET /v2.01/{ClientId}/payins/card/web/{PayInId}/extended View card details for a Web Card PayIn #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/mangopay:mangopay-webcardpayins-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mangopay-webcardpayins-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Reference Web Card Payins 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: webCardPayins
paths:
  /v2.01/{ClientId}/payins/card/web:
    post:
      operationId: webCardPayins_create_web_card_payin
      summary: Create a Web Card PayIn
      description: '**Note – Timeout after 15 minutes**


        The hosted payment page session on the `RedirectURL` lasts 15 minutes, at which point the pay-in fails automatically with result code 101109 if it is not completed by the user.


        **Caution – TemplateURL customization feature deprecated**


        The `TemplateURL` response parameter is deprecated and must no longer be used to redirect the user. You must redirect the user on the `RedirectURL`.


        The `TemplateURLOptions` body parameter is also deprecated as the feature allowing minor customization of the hosted page is no longer supported.


        Read more about the Web Card PayIn object →


        **Note:** The legacy iDEAL integration also uses this endpoint with `CardType` set to `IDEAL`. New integrations of iDEAL should use the Create an iDEAL PayIn endpoint.'
      tags:
      - webCardPayins
      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/WebCardPayInResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAWebCardPayInRequest'
      security:
      - oauth2: []
  /v2.01/{ClientId}/payins/card/web/{PayInId}/extended:
    get:
      operationId: webCardPayins_view_card_details_web_card_payin
      summary: View card details for a Web Card PayIn
      tags:
      - webCardPayins
      parameters:
      - name: ClientId
        in: path
        description: Platform's API account identifier, associated with the API key.
        required: true
        schema:
          type: string
      - name: PayInId
        in: path
        description: The unique identifier of the pay-in.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewCardDetailsForAWebCardPayInResponse'
      security:
      - oauth2: []
components:
  schemas:
    CreateAWebCardPayInRequestFees:
      type: object
      properties:
        Currency:
          $ref: '#/components/schemas/Currency'
        Amount:
          $ref: '#/components/schemas/Amount'
      required:
      - Currency
      - Amount
      description: Information about the fees.
      title: CreateAWebCardPayInRequestFees
    WebCardPayInResponseDebitedFunds:
      type: object
      properties:
        Currency:
          $ref: '#/components/schemas/Currency'
        Amount:
          $ref: '#/components/schemas/Amount'
      description: Information about the debited funds.
      title: WebCardPayInResponseDebitedFunds
    Address_SubPropsRequired:
      type: object
      properties:
        AddressLine1:
          type: string
          description: The first line of the address.
        AddressLine2:
          type: string
          description: The second line of the address.
        City:
          type: string
          description: The city of the address.
        Region:
          type: string
          description: Required if `Country` is US, CA, or MX. The region of the address.
        PostalCode:
          type: string
          description: 'The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.'
        Country:
          type: string
          description: 'Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))


            The country of the address.'
      required:
      - AddressLine1
      - City
      - PostalCode
      - Country
      description: The postal address.
      title: Address_SubPropsRequired
    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
    ViewCardDetailsForAWebCardPayInResponse:
      type: object
      properties:
        Id:
          $ref: '#/components/schemas/Id'
        PaymentType:
          type: string
          description: '**Returned values:** `CARD`


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


            The execution type of the pay-in.'
        ExpirationDate:
          type: string
          description: 'Format: “MMYY”


            The expiration date of the card.'
        Alias:
          type: string
          description: The card number, partially obfuscated.
        CardType:
          type: string
          description: '**Returned values:** `CB_VISA_MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`


            **Default value:** `CB_VISA_MASTERCARD`


            The type of the card. If not supplied, the default value will be taken into account.'
        Country:
          type: string
          description: 'Format: ISO-3166-1 alpha-3 three-letter country code (e.g., “FRA”)


            The country of the card (which is the same as the country of the issuer).'
        Fingerprint:
          type: string
          description: The unique representation of the card number. This string can be used to track the card behavior while keeping the card information confidential.
      title: ViewCardDetailsForAWebCardPayInResponse
    WebCardPayInResponse:
      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/WebCardPayInResponseDebitedFunds'
          description: Information about the debited funds.
        CreditedFunds:
          $ref: '#/components/schemas/WebCardPayInResponseCreditedFunds'
          description: Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).
        Fees:
          $ref: '#/components/schemas/WebCardPayInResponseFees'
          description: Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
        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:** `CARD`


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


            The execution type of the pay-in.'
        RedirectURL:
          type: string
          description: 'The URL to which to redirect the user to complete the payment.


            **Caution:** This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.'
        ReturnURL:
          $ref: '#/components/schemas/ReturnURL_220'
        TemplateURL:
          type: string
          description: '**Caution:** This customization feature is deprecated and must no longer be used. You must redirect on the `RedirectURL` instead.


            The customized URL to which to redirect the user to complete the payment.'
        CardType:
          type: string
          description: '**Returned values:** `CB_VISA_MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`


            The type of the card.'
        Culture:
          type: string
          description: '**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.


            The language in which the payment page is to be displayed.'
        SecureMode:
          type: string
          description: '**Returned values:** `DEFAULT`, `FORCE`, `NO_CHOICE`


            The mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:

            - `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.

            - `FORCE` – Requests SCA.

            - `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA.'
        Billing:
          $ref: '#/components/schemas/Billing_DefaultsShippingUser_Response'
        Shipping:
          $ref: '#/components/schemas/Shipping_DefaultsBillingUser_Response'
        StatementDescriptor:
          $ref: '#/components/schemas/StatementDescriptor_22'
        BankName:
          type: string
          description: The user's bank, if the `CardType` is `IDEAL`, as defined by the `Bic` parameter sent in the call. This parameter is `null` for other card types or if the BIC was not sent on the legacy iDEAL implementation. See <a href="/api-reference/ideal/create-web-card-payin-ideal">Create a Web Card PayIn (iDEAL)</a> for more information.
        AuthenticationResult:
          $ref: '#/components/schemas/AuthenticationResult'
      description: 'A web card pay-in:

        - `PaymentType` – `CARD`

        - `ExecutionType` – `WEB`'
      title: WebCardPayInResponse
    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
    AuthorId:
      type: string
      description: The unique identifier of the user at the source of the transaction.
      title: AuthorId
    CreateAWebCardPayInRequestTemplateUrlOptions:
      type: object
      properties:
        PAYLINEV2:
          type: string
          description: '**Caution:** This customization feature is deprecated and must no longer be used.


            The URL of the corresponding template with the Javascript widget.'
      description: '**Caution:** This customization feature is deprecated and must no longer be used.


        The URL of the SSL page of your customized payment page.'
      title: CreateAWebCardPayInRequestTemplateUrlOptions
    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
    Shipping_DefaultsBillingUser_Response:
      type: object
      properties:
        FirstName:
          type: string
          description: The first name of the user.
        LastName:
          type: string
          description: The last name of the user.
        Address:
          $ref: '#/components/schemas/Address_SubPropsRequired'
      description: '**Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present).


        Information about the shipping address. '
      title: Shipping_DefaultsBillingUser_Response
    WebCardPayInResponseCreditedFunds:
      type: object
      properties:
        Currency:
          $ref: '#/components/schemas/Currency'
        Amount:
          $ref: '#/components/schemas/Amount'
      description: Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).
      title: WebCardPayInResponseCreditedFunds
    CreateAWebCardPayInRequestDebitedFunds:
      type: object
      properties:
        Currency:
          $ref: '#/components/schemas/Currency'
        Amount:
          $ref: '#/components/schemas/Amount'
      required:
      - Currency
      - Amount
      description: Information about the debited funds.
      title: CreateAWebCardPayInRequestDebitedFunds
    TransactionStatus:
      type: string
      description: '**Returned values:** `CREATED`, `SUCCEEDED`, `FAILED`


        The status of the transaction.'
      title: TransactionStatus
    Billing_DefaultsShippingUser_Request:
      type: object
      properties:
        FirstName:
          type: string
          description: The first name of the user.
        LastName:
          type: string
          description: The last name of the user.
        Address:
          $ref: '#/components/schemas/Address_SubPropsRequired'
      description: '**Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present).


        Information about the billing address. '
      title: Billing_DefaultsShippingUser_Request
    WebCardPayInResponseFees:
      type: object
      properties:
        Currency:
          $ref: '#/components/schemas/Currency'
        Amount:
          $ref: '#/components/schemas/Amount'
      description: Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
      title: WebCardPayInResponseFees
    Shipping_DefaultsBillingUser_Request:
      type: object
      properties:
        FirstName:
          type: string
          description: The first name of the user.
        LastName:
          type: string
          description: The last name of the user.
        Address:
          $ref: '#/components/schemas/Address_SubPropsRequired'
      description: '**Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present).


        Information about the shipping address. '
      title: Shipping_DefaultsBillingUser_Request
    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
    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
    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
    ResultMessage:
      type: string
      description: The explanation of the result code.
      title: ResultMessage
    Address:
      type: object
      properties:
        AddressLine1:
          type: string
          description: The first line of the address.
        AddressLine2:
          type: string
          description: The second line of the address.
        City:
          type: string
          description: The city of the address.
        Region:
          type: string
          description: Required if `Country` is US, CA, or MX. The region of the address.
        PostalCode:
          type: string
          description: 'The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.'
        Country:
          type: string
          description: 'Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))


            The country of the address.'
      description: The postal address.
      title: Address
    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
    CreateAWebCardPayInRequest:
      type: object
      properties:
        Tag:
          $ref: '#/components/schemas/Tag'
        AuthorId:
          $ref: '#/components/schemas/AuthorId'
        CreditedUserId:
          $ref: '#/components/schemas/CreditedUserId'
        DebitedFunds:
          $ref: '#/components/schemas/CreateAWebCardPayInRequestDebitedFunds'
          description: Information about the debited funds.
        Fees:
          $ref: '#/components/schemas/CreateAWebCardPayInRequestFees'
          description: Information about the fees.
        CreditedWalletId:
          type: string
          description: The unique identifier of the credited wallet.
        FlowDescriptor:
          $ref: '#/components/schemas/FlowDescriptorRequest'
        ReturnURL:
          type: string
          description: 'Max length: 220 characters.


            The URL to which the user is returned after the payment, whether the transaction is successful or not.'
        TemplateURLOptions:
          $ref: '#/components/schemas/CreateAWebCardPayInRequestTemplateUrlOptions'
          description: '**Caution:** This customization feature is deprecated and must no longer be used.


            The URL of the SSL page of your customized payment page.'
        CardType:
          type: string
          description: '**Allowed values:** `CB_VISA_MASTERCARD`, `AMEX`, `MAESTRO`, `BCMC`.


            The type of the card.'
        Culture:
          type: string
          description: '**Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.


            The language in which the payment page is to be displayed.'
        SecureMode:
          type: string
          description: '**Allowed values:** `DEFAULT`, `FORCE`, `NO_CHOICE`


            **Default value:** `DEFAULT`


            The mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:

            - `DEFAULT` – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.

            - `FORCE` – Requests SCA.

            - `NO_CHOICE` – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA.'
        Billing:
          $ref: '#/components/schemas/Billing_DefaultsShippingUser_Request'
        Shipping:
          $ref: '#/components/schemas/Shipping_DefaultsBillingUser_Request'
        StatementDescriptor:
          $ref: '#/components/schemas/StatementDescriptor_22'
        ProfilingAttemptReference:
          $ref: '#/components/schemas/ProfilingAttemptReference'
        Bic:
          type:
          - string
          - 'null'
          description: '**Deprecated.** **Allowed values:** The BIC of a <a href="/guides/payment-methods/ideal">bank supported by iDEAL</a>.


            The bank identifier code (BIC) of the user''s bank. If provided, the user is redirected to the bank''s interface to log in and authenticate the payment. If not provided, the user is redirected to an intermediary page where they must choose their bank.


            This field was used by legacy iDEAL integrations and is still accepted by the API for backwards compatibility. New integrations should use the dedicated <a href="/api-reference/ideal/create-ideal-payin">Create an iDEAL PayIn</a> endpoint instead.


            **Note:** Parameter not returned – the `BankName` is returned instead.'
          deprecated: true
      required:
      - AuthorId
      - DebitedFunds
      - Fees
      - CreditedWalletId
      - ReturnURL
      - CardType
      - Culture
      title: CreateAWebCardPayInRequest
    Billing_DefaultsShippingUser_Response:
      type: object
      properties:
        FirstName:
          type: string
          description: The first name of the user.
        LastName:
          type: string
          description: The last name of the user.
        Address:
          $ref: '#/components/schemas/Address'
      description: '**Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present).


        Information about the billing address. '
      title: Billing_DefaultsShippingUser_Response
    CreationDate:
      type: integer
      description: Unix timestamp (UTC) of the date and time the object was created.
      title: CreationDate
    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
    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
    ReturnURL_220:
      type: string
      description: 'Max. length: 220 characters


        The URL to which the user is returned after the payment, whether the transaction is successful or not.'
      title: ReturnURL_220
    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
  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)