View a PayIn (Web Card)

// GET has no body parameters

{
    "Id": "payin_m_01JHQVV446832CA5QAXRYCWV58",
    "Tag": "Example with customized payment page",
    "CreationDate": 1662454775,
    "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "CreditedUserId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 2000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1900
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
    "DebitedWalletId": null,
    "PaymentType": "CARD",
    "ExecutionType": "WEB",
    "RedirectURL": "https://api.sandbox.mangopay.com/Content/PaylineTemplateWidget?rp=f40de6033b7847659387970d98477848&transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58&token=161eekDgqtEVMXbhR3431662108348469",
    "ReturnURL": "http://www.example.com?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "TemplateURL": "https://api.sandbox.mangopay.com/Content/PaylineTemplateWidget?rp=f40de6033b7847659387970d98477848&transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "CardType": "CB_VISA_MASTERCARD",
    "Culture": "EN",
    "SecureMode": "DEFAULT",
    "Billing": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Shipping": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "StatementDescriptor": "Platform",
    "BankName": null
}  

{
    "Id": "payin_m_01JHQVV446832CA5QAXRYCWV58",
    "Tag": "Example with customized payment page",
    "CreationDate": 1662454775,
    "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "CreditedUserId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 2000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1900
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
    "DebitedWalletId": null,
    "PaymentType": "CARD",
    "ExecutionType": "WEB",
    "RedirectURL": "https://www.example.com/template/?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58&token=1jLXHAjyfjxGiJJQv2971662454776237",
    "ReturnURL": "http://www.example.com?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "TemplateURL": "https://www.example.com/template/?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "CardType": "CB_VISA_MASTERCARD",
    "Culture": "EN",
    "SecureMode": "DEFAULT",
    "Billing": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Shipping": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "StatementDescriptor": "Platform",
    "BankName": null
}

GET

v2.01

{ClientId}

payins

{PayInId}

// GET has no body parameters

{
    "Id": "payin_m_01JHQVV446832CA5QAXRYCWV58",
    "Tag": "Example with customized payment page",
    "CreationDate": 1662454775,
    "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "CreditedUserId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 2000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1900
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
    "DebitedWalletId": null,
    "PaymentType": "CARD",
    "ExecutionType": "WEB",
    "RedirectURL": "https://api.sandbox.mangopay.com/Content/PaylineTemplateWidget?rp=f40de6033b7847659387970d98477848&transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58&token=161eekDgqtEVMXbhR3431662108348469",
    "ReturnURL": "http://www.example.com?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "TemplateURL": "https://api.sandbox.mangopay.com/Content/PaylineTemplateWidget?rp=f40de6033b7847659387970d98477848&transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "CardType": "CB_VISA_MASTERCARD",
    "Culture": "EN",
    "SecureMode": "DEFAULT",
    "Billing": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Shipping": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "StatementDescriptor": "Platform",
    "BankName": null
}  

{
    "Id": "payin_m_01JHQVV446832CA5QAXRYCWV58",
    "Tag": "Example with customized payment page",
    "CreationDate": 1662454775,
    "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "CreditedUserId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 2000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1900
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
    "DebitedWalletId": null,
    "PaymentType": "CARD",
    "ExecutionType": "WEB",
    "RedirectURL": "https://www.example.com/template/?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58&token=1jLXHAjyfjxGiJJQv2971662454776237",
    "ReturnURL": "http://www.example.com?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "TemplateURL": "https://www.example.com/template/?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "CardType": "CB_VISA_MASTERCARD",
    "Culture": "EN",
    "SecureMode": "DEFAULT",
    "Billing": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Shipping": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "StatementDescriptor": "Platform",
    "BankName": null
}

Note – Pay-in data retained for 13 monthsAn API call to retrieve a pay-in whose CreationDate is older than 13 months may return 404 Not Found.For more information, see the Data availability periods article.

Path parameters

string

required

The unique identifier of the pay-in.

Responses

200

string

Max length: 128 characters (see data formats for details)The unique identifier of the 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.

Show properties

string

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.

integer

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

object

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

Show properties

string

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.

integer

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

object

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

Show properties

string

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.

integer

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

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.

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

Returned values: One of the supported languages in the ISO 639-1 format: CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.The language in which the payment page is to be displayed.

string

Returned values: DEFAULT, FORCE, NO_CHOICEThe 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.

Show properties

string

The first name of the user.

string

Max. length: 100 charactersThe last name of the user.

object

Information about the billing address.

Show properties

string

Max. length: 255 charactersThe first line of the address.

string

Max. length: 255 charactersThe second line of the address.

string

Max. length: 255 charactersThe city of the address.

string

Max. length: 255 charactersThe region of the address. This field is optional except if the Country is US, CA, or MX.

string

Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of the address.

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.

Show properties

string

The first name of the user.

string

Max. length: 100 charactersThe last name of the user.

object

Information about the shipping address.

Show properties

string

Max. length: 255 charactersThe first line of the address.

string

Max. length: 255 charactersThe second line of the address.

string

Max. length: 255 charactersThe city of the address.

string

Max. length: 255 charactersThe region of the address. This field is optional except if the Country is US, CA, or MX.

string

Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of the 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.

{
    "Id": "payin_m_01JHQVV446832CA5QAXRYCWV58",
    "Tag": "Example with customized payment page",
    "CreationDate": 1662454775,
    "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "CreditedUserId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 2000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1900
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
    "DebitedWalletId": null,
    "PaymentType": "CARD",
    "ExecutionType": "WEB",
    "RedirectURL": "https://api.sandbox.mangopay.com/Content/PaylineTemplateWidget?rp=f40de6033b7847659387970d98477848&transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58&token=161eekDgqtEVMXbhR3431662108348469",
    "ReturnURL": "http://www.example.com?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "TemplateURL": "https://api.sandbox.mangopay.com/Content/PaylineTemplateWidget?rp=f40de6033b7847659387970d98477848&transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "CardType": "CB_VISA_MASTERCARD",
    "Culture": "EN",
    "SecureMode": "DEFAULT",
    "Billing": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Shipping": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "StatementDescriptor": "Platform",
    "BankName": null
}  

{
    "Id": "payin_m_01JHQVV446832CA5QAXRYCWV58",
    "Tag": "Example with customized payment page",
    "CreationDate": 1662454775,
    "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "CreditedUserId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 2000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1900
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
    "DebitedWalletId": null,
    "PaymentType": "CARD",
    "ExecutionType": "WEB",
    "RedirectURL": "https://www.example.com/template/?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58&token=1jLXHAjyfjxGiJJQv2971662454776237",
    "ReturnURL": "http://www.example.com?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "TemplateURL": "https://www.example.com/template/?transactionId=payin_m_01JHQVV446832CA5QAXRYCWV58",
    "CardType": "CB_VISA_MASTERCARD",
    "Culture": "EN",
    "SecureMode": "DEFAULT",
    "Billing": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Shipping": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "StatementDescriptor": "Platform",
    "BankName": null
}

// GET has no body parameters

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Echo

Helpers

Platform account

Path parameters

Responses

​Path parameters

​Responses

Path parameters

Responses