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);
}  

{
    "AuthorId": "204068024",
    "CreditedUserId": "204068024",
    "CreditedWalletId": "204089031",
    "DepositId": "bda62a05-2d3d-4cd8-8763-53d8dffdab49",
    "Id": "b45fb6f7-75d4-4757-a8e5-6fe46d9edde2",
    "CreationDate": 1696583378,
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "Status": "SUCCEEDED",
    "ExecutionDate": 1696583379,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "PaymentType": "PREAUTHORIZED",
    "ExecutionType": "DIRECT",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 10000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 9000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "Tag": "Created using Mangopay API Postman Collection"
}
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

​
AuthorId
string
The unique identifier of the user at the source of the transaction.
​
CreditedUserId
string
Default value: The AuthorId of the Deposit Preauthorization object.The unique identifier of the user whose wallet is credited. On the Deposit Preauthorized PayIn, this parameter returns the same value as the AuthorId of the Deposit Preauthorization object, regardless of the value sent.
​
CreditedWalletId
string
The unique identifier of the credited wallet.
​
DepositId
string
The unique identifier of the deposit preauthorization.
​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
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.
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
​
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.
​
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.
​
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).
​
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.
{
    "AuthorId": "204068024",
    "CreditedUserId": "204068024",
    "CreditedWalletId": "204089031",
    "DepositId": "bda62a05-2d3d-4cd8-8763-53d8dffdab49",
    "Id": "b45fb6f7-75d4-4757-a8e5-6fe46d9edde2",
    "CreationDate": 1696583378,
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "Status": "SUCCEEDED",
    "ExecutionDate": 1696583379,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "PaymentType": "PREAUTHORIZED",
    "ExecutionType": "DIRECT",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 10000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 9000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "Tag": "Created using Mangopay API Postman Collection"
}  

<?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);
}