Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Reference Recurring 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: recurringCardPayins
paths:
/v2.01/{ClientId}/payins/recurring/card/direct:
post:
operationId: recurringCardPayins_create_recurring_card_payin
summary: Create a Recurring Card PayIn (CIT or MIT)
description: 'Request a recurring card pay-in based on a `RecurringPayinRegistrationId` with `PaymentType` `CARD`, obtained from POST Create a Recurring PayIn Registration.
There are two possible paylods:
- **CIT** – Customer-initiated transaction when the user is on session, requiring them to authenticate on the `SecureModeRedirectURL` returned.
- **MIT** – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication, unless and until re-authentication is required.'
tags:
- recurringCardPayins
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/RecurringCardPayInResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/recurringCardPayins_create_recurring_card_payin_Request'
security:
- oauth2: []
components:
schemas:
SecureModeReturnURL:
type: string
description: 'Max. length: 255 characters
The URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the `SecureModeNeeded` parameter is set to `true`).'
title: SecureModeReturnURL
RecurringCardPayInResponseDebitedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: Information about the debited funds.
title: RecurringCardPayInResponseDebitedFunds
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
CreateARecurringCardPayInMitRequestDebitedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
required:
- Currency
- Amount
description: 'Information about the debited funds. This property overrides the `NextTransactionDebitedFunds` of the Registration, and is **required if** that property is empty.
**Caution:** An amount must be provided in either the Registration''s `NextTransactionDebitedFunds` or the pay-in''s `DebitedFunds`.'
title: CreateARecurringCardPayInMitRequestDebitedFunds
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
RecurringCardPayInResponseFees:
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: RecurringCardPayInResponseFees
RecurringCardPayInResponse:
type: object
properties:
Id:
$ref: '#/components/schemas/Id'
Tag:
$ref: '#/components/schemas/Tag'
CreationDate:
$ref: '#/components/schemas/CreationDate'
AuthorId:
$ref: '#/components/schemas/AuthorId'
DebitedFunds:
$ref: '#/components/schemas/RecurringCardPayInResponseDebitedFunds'
description: Information about the debited funds.
CreditedFunds:
$ref: '#/components/schemas/RecurringCardPayInResponseCreditedFunds'
description: Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).
Fees:
$ref: '#/components/schemas/RecurringCardPayInResponseFees'
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.
CreditedUserId:
$ref: '#/components/schemas/CreditedUserId'
PaymentType:
type: string
description: '**Returned values:** `CARD`
The payment type of the pay-in.'
ExecutionType:
type: string
description: '**Returned values:** `DIRECT`
The execution type of the pay-in.'
StatementDescriptor:
$ref: '#/components/schemas/StatementDescriptor_22'
Billing:
$ref: '#/components/schemas/Billing_DefaultsShippingUser_Response'
Shipping:
$ref: '#/components/schemas/Shipping_DefaultsBillingUser_Response'
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.'
SecureModeNeeded:
type: boolean
description: Whether or not the `SecureMode` was used.
SecureModeReturnURL:
$ref: '#/components/schemas/SecureModeReturnURL'
SecureModeRedirectURL:
type: string
description: 'Max. length: 255 characters
The URL to which to redirect the user to proceed to 3DS2 validation.'
SecurityInfo:
$ref: '#/components/schemas/AVSResult'
BrowserInfo:
$ref: '#/components/schemas/BrowserInfo'
IpAddress:
$ref: '#/components/schemas/IpAddress'
CardId:
type: string
description: The unique identifier of the Card object, obtained during the card registration process.
CardInfo:
$ref: '#/components/schemas/CardInfo'
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'
Culture:
type: string
description: '**Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT.
The language in which the payment page is to be displayed.'
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.'
PaymentCategory:
$ref: '#/components/schemas/PaymentCategory'
AuthenticationResult:
$ref: '#/components/schemas/AuthenticationResult'
description: 'A recurring direct card pay-in:
- `PaymentType` – `CARD`
- `ExecutionType` – `DIRECT`
- Object includes `RecurringPayinRegistrationId`'
title: RecurringCardPayInResponse
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
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
RecurringCardPayInResponseCreditedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).
title: RecurringCardPayInResponseCreditedFunds
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
TransactionStatus:
type: string
description: '**Returned values:** `CREATED`, `SUCCEEDED`, `FAILED`
The status of the transaction.'
title: TransactionStatus
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
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
recurringCardPayins_create_recurring_card_payin_Request:
oneOf:
- $ref: '#/components/schemas/CreateARecurringCardPayInCITRequest'
- $ref: '#/components/schemas/CreateARecurringCardPayInMITRequest'
title: recurringCardPayins_create_recurring_card_payin_Request
CreateARecurringCardPayInMitRequestFees:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
required:
- Currency
- Amount
description: 'Information about the fees. This property overrides the `NextTransactionFees` of the Registration, and is **required if** that property is empty.
**Caution:** An amount must be provided in either the Registration''s `NextTransactionFees` or the pay-in''s `Fees`.'
title: CreateARecurringCardPayInMitRequestFees
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
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
IpAddress:
type: string
description: The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
title: IpAddress
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
Error:
type: object
properties:
Message:
type: string
description: Description of the error.
Type:
type: string
description: 'The category of the error.
'
Id:
type: string
description: Unique identifier of the error instance, useful when contacting Mangopay for support.
Date:
type: number
format: double
description: Unix timestamp (UTC) of the date and time the error was triggered.
errors:
type:
- object
- 'null'
additionalProperties:
type: string
description: 'Object containing one or more field-level errors.
'
description: 'The error body typically returned by the Mangopay API for any non-2xx HTTP status code.
'
title: Error
CreateARecurringCardPayInCITRequest:
type: object
properties:
Tag:
$ref: '#/components/schemas/Tag'
SecureModeReturnURL:
$ref: '#/components/schemas/SecureModeReturnURL'
Culture:
type: string
description: The language in which the payment page is to be displayed. This deprecated parameter defaults to `EN`.
deprecated: true
StatementDescriptor:
$ref: '#/components/schemas/StatementDescriptor_22'
BrowserInfo:
$ref: '#/components/schemas/BrowserInfo'
IpAddress:
$ref: '#/components/schemas/IpAddress'
RecurringPayinRegistrationId:
type: string
description: The unique identifier of the recurring pay-in registration.
PreferredCardNetwork:
$ref: '#/components/schemas/PreferredCardNetwork'
PaymentCategory:
$ref: '#/components/schemas/PaymentCategory'
required:
- SecureModeReturnURL
- BrowserInfo
- IpAddress
- RecurringPayinRegistrationId
description: Request body for a card customer-initiated transcation (CIT).
title: CreateARecurringCardPayInCITRequest
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
PreferredCardNetwork:
type: string
description: '**Allowed values:** `VISA`, `MASTERCARD`, `CB`, `MAESTRO`
The card network to use, as chosen by the cardholder, in case of <a href="/guides/payment-methods/card/co-branded">co-branded cards</a>.'
title: PreferredCardNetwork
BrowserInfo:
type: object
properties:
AcceptHeader:
type: string
description: The exact content of the HTTP accept headers as sent to the platform from the end user's browser.
JavaEnabled:
type: boolean
description: Whether or not the end user's browser has the ability to execute Java.
Language:
type: string
description: 'Format: Two-letter language code (ISO 639-1 alpha-2) followed by two-letter country code (ISO 3166-1 alpha-2), separated by a hyphen (example: `en-US`; pattern:`^[a-zA-Z]{2}(-[a-zA-Z]{2})?$`)
The language of the browser.'
ColorDepth:
type: integer
description: The value representing the depth of the screen's color palette for displaying images, in bits per pixel.
ScreenHeight:
type: integer
description: The height of the screen in pixels.
ScreenWidth:
type: integer
description: The width of the screen in pixels.
TimeZoneOffset:
type: integer
description: The difference in minutes between the browser's timezone and UTC.
UserAgent:
type: string
description: The exact content of the HTTP User-Agent header.
JavascriptEnabled:
type: boolean
description: Whether or not the end user's browser has the ability to execute JavaScript.
required:
- AcceptHeader
- JavaEnabled
- Language
- ColorDepth
- ScreenHeight
- ScreenWidth
- TimeZoneOffset
- UserAgent
- JavascriptEnabled
description: Information about the browser used by the end user (author) to perform the payment.
title: BrowserInfo
CreateARecurringCardPayInMITRequest:
type: object
properties:
Tag:
$ref: '#/components/schemas/Tag'
DebitedFunds:
$ref: '#/components/schemas/CreateARecurringCardPayInMitRequestDebitedFunds'
description: 'Information about the debited funds. This property overrides the `NextTransactionDebitedFunds` of the Registration, and is **required if** that property is empty.
**Caution:** An amount must be provided in either the Registration''s `NextTransactionDebitedFunds` or the pay-in''s `DebitedFunds`.'
Fees:
$ref: '#/components/schemas/CreateARecurringCardPayInMitRequestFees'
description: 'Information about the fees. This property overrides the `NextTransactionFees` of the Registration, and is **required if** that property is empty.
**Caution:** An amount must be provided in either the Registration''s `NextTransactionFees` or the pay-in''s `Fees`.'
StatementDescriptor:
$ref: '#/components/schemas/StatementDescriptor_22'
RecurringPayinRegistrationId:
type: string
description: The unique identifier of the recurring pay-in registration.
PaymentCategory:
$ref: '#/components/schemas/PaymentCategory'
required:
- RecurringPayinRegistrationId
description: Request body for a card merchant-initiated transaction (MIT).
title: CreateARecurringCardPayInMITRequest
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
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
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)