Create a Direct Card PayIn

Body parameters

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.

AuthorId

string

required

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

CreditedUserId

string

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

DebitedFunds

object

required

Information about the debited funds.

Fees

object

required

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

CreditedWalletId

string

required

The unique identifier of the credited wallet.

SecureMode

string

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.

CardId

string

required

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

SecureModeReturnURL

string

required

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

Culture

string

deprecated

The language in which the payment page is to be displayed.

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

required

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

IpAddress

string

required

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. If left empty, the default values will be automatically taken into account.

PreferredCardNetwork

string

Allowed values: VISA, MASTERCARD, CB, MAESTRO

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

PaymentCategory

string

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

ProfilingAttemptReference

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.

Responses

string

The unique identifier of the object.

Tag

string

Max. length: 255 characters

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.

CreditedUserId

string

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

DebitedFunds

object

Information about the debited funds.

CreditedFunds

object

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

Fees

object

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

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

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.

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.

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

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. If left empty, the default values will be automatically taken into account.

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.

PaymentCategory

string

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

CardInfo

string

Information about the card used for the transaction.

If the information or data is not available, null is returned.

{
    "Message": "Error: multi-currency usage is not authorized",
    "Type": "currency_incompatibility",
    "Id": "e384d310-ab19-4455-bf27-f54822361bd3",
    "Date": 1700045351.0,
    "errors": {
        "currency": "The card's currency GBP and the debitedAmount's currency EUR must be the same"
    }
}  

{
    "Message": "Error: multi-currency usage is not authorized",
    "Type": "currency_incompatibility",
    "Id": "1f29b2ff-cf01-4185-9cfd-c0545f6cbd0c",
    "Date": 1700044992.0,
    "errors": {
        "currency": "The Wallet's currency GBP and the DebitedFunds's currency EUR must be the same"
    }
}  

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

Create a Direct Card PayIn

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses