Description

The Recurring PayIn object represents a card pay-in linked to a Recurring PayIn Registration object. 

There are two types of recurring pay-ins:

  • Customer-initiated transaction (CIT) – First pay-in of the series, which requires the cardholder to authenticate via the 3DS protocol.
  • Merchant-initiated transaction (MIT) – All the pay-ins occurring after a successful CIT, which are executed in the absence of the cardholder.

Note – Max. 99 pay-ins possible against each registration

A maximum of 99 pay-ins, CIT and MIT included, can be made against each Recurring PayIn Registration. Once you reach this limit, the 100th pay-in will fail with the error 205001.

You need to create a new registration object to restart the recurrence (with a CIT).

Attributes

Id
string

The unique identifier of the object.

Tag
string

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.

CreationDate
timestamp

The date and time at which the object was created.

AuthorId
string

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

DebitedFunds
object

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

CreditedFunds
object

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

Fees
object

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

Status
string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCode
string

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

ResultMessage
string

The explanation of the result code.

ExecutionDate
timestamp

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.

Type
string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Nature
string

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.
CreditedWalletId
string

The unique identifier of the credited wallet.

DebitedWalletId
string

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
string

Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIRE

The type of pay-in.

ExecutionType
string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

SecureMode
string

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.
CardId
string

The unique identifier of the Card object, obtained during the card registration process.

SecureModeReturnURL
string

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

SecureModeRedirectURL
string

Max. length: 255 characters

The URL to which to redirect the user to proceed to 3DS2 validation.

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.

SecureModeNeeded
boolean

Whether or not the SecureMode was used.

Culture
string

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.

SecurityInfo
object

Information regarding security and anti-fraud tools.

StatementDescriptor
string

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.

BrowserInfo
object

Information about the browser used by the end user (author) to perform the payment.

IpAddress
string

The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.

Billing
object

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.

Shipping
object

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.

Requested3DSVersion
string

Returned values: V1, V2_1

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

Applied3DSVersion
string

Returned values: V1, V2_1

The 3DS protocol version applied to the transaction.

RecurringPayinRegistrationId
string

The unique identifier of the recurring pay-in registration.

PreferredCardNetwork
string

Returned values: VISA, MASTERCARD, CB, MAESTRO

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

CardInfo
string

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

Guide

Learn more about recurring card payments