Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
View a PayIn (Banking Alias)
<?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);
}
{
"CreditedUserId": "user_m_01HSB23417BFG7YXR7E371JSEA",
"AuthorId": "user_m_01HSB23417BFG7YXR7E371JSEA",
"CreditedWalletId": "wlt_m_01HSB6DE1YT1EMTH0K7ASYPG96",
"DebitedBankAccount": {
"IBAN": "FR7630004000031234567890143",
"BIC": "BNPAFRPP",
"AccountNumber": null,
"Country": null,
"OwnerName": "Alex Smith",
"Type": "IBAN"
},
"BankingAliasId": "wltbank_m_01HSB6E769Y3ZBYDJACSP3THGA",
"Type": "PAYIN",
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"Nature": "REGULAR",
"CreationDate": 1710847216,
"ExecutionDate": 1710847216,
"WireReference": "Example123",
"PaymentType": "BANK_WIRE",
"ExecutionType": "EXTERNAL_INSTRUCTION",
"DebitedWalletId": null,
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"DebitedFunds": {
"Currency": "EUR",
"Amount": 14654
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 14654
},
"Id": "payin_m_01HSB71JKJ9FVYZ61D97ZQ1ASR",
"Tag": null
}
Note – Pay-in data retained for 13 months
An 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
The unique identifier of the pay-in.
Responses
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
The unique identifier of the user at the source of the transaction.
The unique identifier of the credited wallet.
Information about the debited bank account.
Note: This information may only be available for EU IBANs.
Max. length: 34 characters
The IBAN (international bank account number) of the bank account. It follows the CCDDBBAN format in which:
- CC represents the country code (ISO 3166-1 alpha 2)
- DD represents two check digits used by banking systems to avoid simple errors
- BBAN stands for the Basic Bank Account Number which is up to 30 alphanumeric characters that are country-specific.
Note: You will need a valid IBAN (i.e., existing in real life) when testing on a Sandbox account even if no actual payout will be processed.
The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.
The BIC can have one of the two following formats:
- BIC8 – 8-character BIC (AAAABBCC)
- BIC11 – 11-character BIC (AAAABBCCDDD)
In which: - AAAA represents the bank code: 4 characters defining the bank
- BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)
- CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country
- DDD represents the branch code: 3 optional characters defining the branch as a branch of the bank
Note: You will need a valid IBAN (i.e., existing in real life) when testing on a Sandbox account even if no actual payout will be processed.
The unique number of the bank account.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country in which the bank account is registered.
Max. length: 255 characters
The full name of the owner of the bank account. (Format: FirstName LastName)
Returned values: IBAN, US, CA, GB, OTHER
The type of the bank account.
The unique identifier of the banking alias.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
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.
The date and time at which the object was created.
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.
The reference of the bank wire received on the virtual IBAN, as provided by the user. If no reference was provided, then this value is null.
Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIRE
The type of pay-in.
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION
The type of execution for the pay-in.
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.
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
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.
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).
Information about the debited funds.
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.
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).
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
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.
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).
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
{
"CreditedUserId": "user_m_01HSB23417BFG7YXR7E371JSEA",
"AuthorId": "user_m_01HSB23417BFG7YXR7E371JSEA",
"CreditedWalletId": "wlt_m_01HSB6DE1YT1EMTH0K7ASYPG96",
"DebitedBankAccount": {
"IBAN": "FR7630004000031234567890143",
"BIC": "BNPAFRPP",
"AccountNumber": null,
"Country": null,
"OwnerName": "Alex Smith",
"Type": "IBAN"
},
"BankingAliasId": "wltbank_m_01HSB6E769Y3ZBYDJACSP3THGA",
"Type": "PAYIN",
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"Nature": "REGULAR",
"CreationDate": 1710847216,
"ExecutionDate": 1710847216,
"WireReference": "Example123",
"PaymentType": "BANK_WIRE",
"ExecutionType": "EXTERNAL_INSTRUCTION",
"DebitedWalletId": null,
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"DebitedFunds": {
"Currency": "EUR",
"Amount": 14654
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 14654
},
"Id": "payin_m_01HSB71JKJ9FVYZ61D97ZQ1ASR",
"Tag": 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);
}
Was this page helpful?
<?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);
}
{
"CreditedUserId": "user_m_01HSB23417BFG7YXR7E371JSEA",
"AuthorId": "user_m_01HSB23417BFG7YXR7E371JSEA",
"CreditedWalletId": "wlt_m_01HSB6DE1YT1EMTH0K7ASYPG96",
"DebitedBankAccount": {
"IBAN": "FR7630004000031234567890143",
"BIC": "BNPAFRPP",
"AccountNumber": null,
"Country": null,
"OwnerName": "Alex Smith",
"Type": "IBAN"
},
"BankingAliasId": "wltbank_m_01HSB6E769Y3ZBYDJACSP3THGA",
"Type": "PAYIN",
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"Nature": "REGULAR",
"CreationDate": 1710847216,
"ExecutionDate": 1710847216,
"WireReference": "Example123",
"PaymentType": "BANK_WIRE",
"ExecutionType": "EXTERNAL_INSTRUCTION",
"DebitedWalletId": null,
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"DebitedFunds": {
"Currency": "EUR",
"Amount": 14654
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 14654
},
"Id": "payin_m_01HSB71JKJ9FVYZ61D97ZQ1ASR",
"Tag": null
}