View a PayIn (Direct Card)

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

PayInId

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.

Tag

string

Max. length: 255 charactersCustom 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

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

Show properties

Currency

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.

Amount

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

CreditedFunds

object

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

Show properties

Currency

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.

Amount

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

Fees

object

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

Show properties

Currency

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.

Amount

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

Status

string

Returned values: CREATED, SUCCEEDED, FAILEDThe 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

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.

Type

string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.

Nature

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.

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_WIREThe type of pay-in.

ExecutionType

string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.

SecureMode

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.

CardId

string

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

SecureModeReturnURL

string

Max. length: 255 charactersThe 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 charactersThe 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.

Show properties

AVSResult

string

The result of the Address Verification System check (only available for UK, US, and Canada).

StatementDescriptor

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.

BrowserInfo

object

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

Show properties

AcceptHeader

string

The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.

JavaEnabled

boolean

Whether or not the end user’s browser has the ability to execute Java.

Language

string

Format: Two-letter language code (ISO 639-1 alpha-2) followed by two-letter country code (ISO 3166-1 alpha-2), separated by a hyphen (example: en-US; pattern:^[a-zA-Z]{2}(-[a-zA-Z]{2})?$)The language of the browser.

ColorDepth

integer

The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.

ScreenHeight

integer

Max. length: 6 charactersThe height of the screen in pixels.

ScreenWidth

integer

Max. length: 6 charactersThe width of the screen in pixels.

TimeZoneOffset

integer

The difference in minutes between the browser’s timezone and UTC.

UserAgent

string

Max. length: 255 charactersThe exact content of the HTTP User-Agent header.

JavascriptEnabled

boolean

Whether or not the end user’s browser has the ability to execute JavaScript.

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.

Show properties

FirstName

string

The first name of the user.

LastName

string

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

Address

object

Information about the billing address.

Show properties

AddressLine1

string

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

AddressLine2

string

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

City

string

Max. length: 255 charactersThe city of the address.

Region

string

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

PostalCode

string

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

Country

string

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

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.

Show properties

FirstName

string

The first name of the user.

LastName

string

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

Address

object

Information about the shipping address.

Show properties

AddressLine1

string

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

AddressLine2

string

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

City

string

Max. length: 255 charactersThe city of the address.

Region

string

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

PostalCode

string

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

Country

string

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

Requested3DSVersion

string

Returned values: V1, V2_1The 3DS protocol version to be applied to the transaction.

Applied3DSVersion

string

Returned values: V1, V2_1The 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, MAESTROThe card network to use, as chosen by the cardholder, in case of co-branded cards.

PaymentCategory

string

Default value: ECommerceAllowed values: ECommerce, TelephoneOrderThe 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.

Show properties

BIN

string

The 6-digit bank identification number (BIN) of the card issuer.

IssuingBank

string

The name of the card issuer.

IssuerCountryCode

string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country where the card was issued.

Type

string

Returned values: DEBIT, CREDIT, CHARGE CARD.The type of card product.

Brand

string

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.

SubType

string

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.

{
    "Id":"149625824",
    "Tag":"Custom description for this specific PayIn",
    "CreationDate":1661159886,
    "AuthorId":"146476890",
    "CreditedUserId":"146476890",
    "DebitedFunds":{
        "Currency":"EUR",
        "Amount":4500
    },
    "CreditedFunds":{
        "Currency":"EUR",
        "Amount":4455
    },
    "Fees":{
        "Currency":"EUR",
        "Amount":45
    },
    "Status":"SUCCEEDED",
    "ResultCode":"000000",
    "ResultMessage":"Success",
    "ExecutionDate":1661159887,
    "Type":"PAYIN",
    "Nature":"REGULAR",
    "CreditedWalletId":"148968396",
    "DebitedWalletId":null,
    "PaymentType":"CARD",
    "ExecutionType":"DIRECT",
    "SecureMode":"DEFAULT",
    "CardId":"149334067",
    "SecureModeReturnURL":null,
    "SecureModeRedirectURL":null,
    "SecureModeNeeded":false,
    "Culture":"EN",
    "SecurityInfo":{
        "AVSResult":"NO_CHECK"
    },
    "StatementDescriptor":"Mar2016",
    "BrowserInfo":null,
    "IpAddress":"2001:0620:0000:0000:0211:24FF:FE80:C12C",
    "Billing":{
        "FirstName":"Nat",
        "LastName":"Doe",
        "Address":{
            "AddressLine1":"Rue des plantes",
            "AddressLine2":"The Oasis",
            "City":"Paris",
            "Region":"Ile de France",
            "PostalCode":"75001",
            "Country":"FR"
        }
    },
    "Shipping":{
        "FirstName":"Nat",
        "LastName":"Doe",
        "Address":{
            "AddressLine1":"4 Oasis street",
            "AddressLine2":"The Oasis",
            "City":"Paris",
            "Region":"Ile de France",
            "PostalCode":"75001",
            "Country":"FR"
        }
    },
    "Requested3DSVersion":null,
    "Applied3DSVersion":null,
    "RecurringPayinRegistrationId":null,
    "PreferredCardNetwork":null,
    "PaymentCategory":"ECommerce",
    "CardInfo": {
        "BIN": "497010",
        "IssuingBank": "LA BANQUE POSTALE",
        "IssuerCountryCode": "MA",
        "Type": "CREDIT",
        "Brand": "VISA",
        "SubType": null
    }
}

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $payinId = 'payin_m_01HYG8DRT5FHT1FV44MV9KR1BS';

    $response = $api->PayIns->Get($payinId);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}

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

View a PayIn (Direct Card)

Path 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

Echo

Helpers

Platform account

​Path parameters

​Responses

Path parameters

Responses