Skip to main content

​
Description

The Web Card PayIn object enables you to process a card payment via a Mangopay-hosted payment page (returned in the RedirectURL), without registering the user’s card details.
Caution – TemplateURL customization feature deprecatedThe 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.

​
Attributes

​
string
The unique identifier of the object.
​
string
Max. length: 255 charactersCustom data that you can add to this object.
​
Unix timestamp
The date and time at which the object was created.
​
string
The unique identifier of the user at the source of the transaction.
​
string
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
​
object
Information about the debited funds.
​
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
object
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
​
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
​
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
​
string
The explanation of the result code.
​
Unix 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.
​
string
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.
​
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
​
string
The unique identifier of the credited wallet.
​
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.
​
string
Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.
​
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
string
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.
​
string
Max. length: 220 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
​
object
deprecated
Caution: This customization feature is deprecated and must no longer be used.The URL of the SSL page of your customized payment page.
​
string
deprecated
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.
​
string
Returned values: CB_VISA_MASTERCARD, AMEX, MAESTRO, BCMCThe type of the card.
​
string
The language in which the payment page is to be displayed.
​
string
Default value: DEFAULTThe 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.
​
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.
​
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.
​
string
Max. length: 10 characters; only alphanumeric and spacesCustom 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.
​
string
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 Create a Web Card PayIn (iDEAL) for more information. 
​
string
The unique reference generated for the profiling session, used by the fraud prevention 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 via the Dashboard for more information.