Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
Create a Recurring PayIn (MIT)
Read more about the Recurring Card PayIn object →
Body parameters
Max. length: 255 characters
Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
Required if the registration’s NextTransactionDebitedFunds is empty.
The amount of the subsequent recurring pay-in. If this field is empty, the amount entered in the NextTransactionDebitedFunds of the Recurring PayIn Registration is taken into account.
Caution: An amount must be transmitted during either the recurring registration or pay-in (if it’s different from the registration one).
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the debited funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Required if the registration’s NextTransactionFees is empty.
The amount of the subsequent fees. If this field is empty, the amount entered in the NextTransactionFees of the Recurring PayIn Registration is taken into account.
Caution: An amount must be transmitted during either the recurring registration or pay-in (if it’s different from the registration one).
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
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.
The unique identifier of the recurring pay-in registration.
Responses
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
The date and time at which the object was created.
The unique identifier of the user at the source of the transaction.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
The amount of the subsequent recurring pay-in. If this field is empty, the amount entered in the NextTransactionDebitedFunds of the Recurring PayIn Registration is taken into account.
Caution: An amount must be transmitted during either the recurring registration or pay-in (if it’s different from the registration one).
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the debited funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the credited funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
The amount of the subsequent fees. If this field is empty, the amount entered in the NextTransactionFees of the Recurring PayIn Registration is taken into account.
Caution: An amount must be transmitted during either the recurring registration or pay-in (if it’s different from the registration one).
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT
The nature of the transaction, providing more information about the context in which the transaction occurred:
REGULAR– Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.REPUDIATION– Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).REFUND– Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).SETTLEMENT– Transfer made to the repudiation wallet by the platform to settle a lost dispute.
The unique identifier of the credited wallet.
The unique identifier of the debited wallet.
In the case of a pay-in, this value is always null since there is no debited wallet.
Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIRE
The type of pay-in.
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION
The type of execution for the pay-in.
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.
The unique identifier of the Card object, obtained during the card registration process.
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).
Max. length: 255 characters
The URL to which to redirect the user to proceed to 3DS2 validation.
Whether or not the SecureMode was used.
Returned values: One of the supported languages in the ISO 639-1 format: DE, EN, ES, FR, IT, NL, PL, PT.
The language in which the payment page is to be displayed.
Information regarding security and anti-fraud tools.
The result of the Address Verification System check (only available for UK, US, and Canada).
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.
Information about the browser used by the end user (author) to perform the payment.
The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.
Whether or not the end user’s browser has the ability to execute Java.
Max. length: 6 characters
The browser language, made up of the language code and the country (e.g., “en-US”).
The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.
Max. length: 6 characters
The height of the screen in pixels.
Max. length: 6 characters
The width of the screen in pixels.
The difference in minutes between the browser’s timezone and UTC.
Max. length: 255 characters
The exact content of the HTTP User-Agent header.
Whether or not the end user’s browser has the ability to execute JavaScript.
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
Default value: FirstName, LastName, and Address information of the Shipping object if any, otherwise the user (author).
Information about the end user billing address. If left empty, the default values will be automatically taken into account.
The first name of the user.
Max. length: 100 characters
The last name of the user.
Information about the billing address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Returned values: Two-letter country code (ISO 3166-1 alpha-2 format).
The country of the address.
Default value: FirstName, LastName, and Address information of the Billing object, if supplied, otherwise of the user (author).
Information about the end user’s shipping address. If left empty, the default values will be automatically taken into account.
The first name of the user.
Max. length: 100 characters
The last name of the user.
Information about the shipping address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Returned values: Two-letter country code (ISO 3166-1 alpha-2 format).
The country of the address.
Returned values: V1, V2_1
The 3DS protocol version to be applied to the transaction.
Returned values: V1, V2_1
The 3DS protocol version applied to the transaction.
The unique identifier of the recurring pay-in registration.
Returned values: VISA, MASTERCARD, CB, MAESTRO
The card network to use, as chosen by the cardholder, in case of co-branded cards.
Information about the card used for the transaction.
If the information or data is not available, null is returned.
The 6-digit bank identification number (BIN) of the card issuer.
The name of the card issuer.
Format: ISO 3166-1 alpha-2 two-letter country code
The country where the card was issued.
Returned values: DEBIT, CREDIT, CHARGE CARD.
The type of card product.
The card brand. Examples include: AMERICAN EXPRESS, DISCOVER, JCB, MASTERCARD, VISA, etc.
Note: The possible returned values are numerous and liable to evolve over time.
The subtype of the card product. Examples include: CLASSIC, GOLD, PLATINUM, PREPAID, etc.
Note: The possible returned values are numerous and liable to evolve over time.
Was this page helpful?