Skip to main content
GET
/
v2.01
/
{ClientId}
/
payins
/
{PayInId}
<?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);
}  

{
    "Id": "wt_794a782f-f6b1-4ba5-8adb-b8004323b31e",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1706097653,
    "AuthorId": "213407540",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 100
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Status": "SUCCEEDED",
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1706097666,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "213407543",
    "CreditedUserId": "213407540",
    "PaymentType": "GOOGLE_PAY",
    "ExecutionType": "DIRECT",
    "StatementDescriptor": "Mangopay",
    "SecureMode": "DEFAULT",
    "SecureModeReturnURL": "https://docs.mangopay.com/please-ignore",
    "SecureModeRedirectURL": "https://api.sandbox.whenthen.co/payment-gateway/monext/3ds/challenge/3a01e913-64d2-4724-a6f9-64ddc3a08d8a/794a782f-f6b1-4ba5-8adb-b8004323b31e",
    "SecureModeNeeded": true,
    "SecurityInfo": null,
    "BrowserInfo": {
        "AcceptHeader": "application/json,text/javascript,*/*;q=0.01<",
        "JavaEnabled": true,
        "Language": "fr",
        "ColorDepth": 32,
        "ScreenHeight": 667,
        "ScreenWidth": 375,
        "TimeZoneOffset": -120,
        "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
        "JavascriptEnabled": true
    },
    "IpAddress": "7579:9817:dac3:76c8:23d4:2fcd:94a3:b5be",
    "CardInfo": {
        "BIN": "411111",
        "IssuingBank": "JPMORGAN CHASE BANK, N.A.",
        "IssuerCountryCode": "US",
        "Type": "CREDIT",
        "SubType": null,
        "Brand": "VISA"
    }
}  
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

Id
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.
DebitedFunds
object
Information about the debited funds.
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
Fees
string
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
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.
PaymentType
string
Returned values: GOOGLE_PAYThe type of pay-in.
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
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.
SecureModeNeeded
boolean
Whether or not the SecureMode was used.
Billing
object
Default value: FirstName, LastName, and Address information of the Shipping object if supplied.Information about the end user’s billing address. If left empty, the default values will be automatically taken into account.
Shipping
string
Information about the end user’s shipping address. If left empty, the default values will be automatically taken into account.
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.
CardInfo
string
Information about the card used for the transaction.If the information or data is not available, null is returned.

{
    "Id": "wt_794a782f-f6b1-4ba5-8adb-b8004323b31e",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1706097653,
    "AuthorId": "213407540",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 100
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Status": "SUCCEEDED",
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1706097666,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "213407543",
    "CreditedUserId": "213407540",
    "PaymentType": "GOOGLE_PAY",
    "ExecutionType": "DIRECT",
    "StatementDescriptor": "Mangopay",
    "SecureMode": "DEFAULT",
    "SecureModeReturnURL": "https://docs.mangopay.com/please-ignore",
    "SecureModeRedirectURL": "https://api.sandbox.whenthen.co/payment-gateway/monext/3ds/challenge/3a01e913-64d2-4724-a6f9-64ddc3a08d8a/794a782f-f6b1-4ba5-8adb-b8004323b31e",
    "SecureModeNeeded": true,
    "SecurityInfo": null,
    "BrowserInfo": {
        "AcceptHeader": "application/json,text/javascript,*/*;q=0.01<",
        "JavaEnabled": true,
        "Language": "fr",
        "ColorDepth": 32,
        "ScreenHeight": 667,
        "ScreenWidth": 375,
        "TimeZoneOffset": -120,
        "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
        "JavascriptEnabled": true
    },
    "IpAddress": "7579:9817:dac3:76c8:23d4:2fcd:94a3:b5be",
    "CardInfo": {
        "BIN": "411111",
        "IssuingBank": "JPMORGAN CHASE BANK, N.A.",
        "IssuerCountryCode": "US",
        "Type": "CREDIT",
        "SubType": null,
        "Brand": "VISA"
    }
}  
<?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);
}