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
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
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 (Google Pay)
<?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 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
The unique identifier of the object.
Max. length: 255 characters
Custom 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.
The date and time at which the object was created.
The unique identifier of the user at the source of the transaction.
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 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 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 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).
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.
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.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
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 unique identifier of the credited wallet.
Returned values: GOOGLE_PAY
The type of pay-in.
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION
The type of execution for the pay-in.
Max. length: 10 characters; only alphanumeric and spaces
Custom 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.
Whether or not the SecureMode was used.
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.
The first name of the user.
Max. length: 100 characters
The last name of the user.
Information about the billing address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
Information about the end user’s shipping address. If left empty, the default values will be automatically taken into account.
The first name of the user.
Max. length: 100 characters
The last name of the user.
Information about the shipping address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
Information about the browser used by the end user (author) to perform the payment.
The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.
Whether or not the end user’s browser has the ability to execute Java.
Max. length: 6 characters
The browser language, made up of the language code and the country (e.g., “en-US”).
The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.
Max. length: 6 characters
The height of the screen in pixels.
Max. length: 6 characters
The width of the screen in pixels.
The difference in minutes between the browser’s timezone and UTC.
Max. length: 255 characters
The exact content of the HTTP User-Agent header.
Whether or not the end user’s browser has the ability to execute JavaScript.
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
Information about the card used for the transaction.
If the information or data is not available, null is returned.
The 6-digit bank identification number (BIN) of the card issuer.
The name of the card issuer.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country where the card was issued.
Returned values: DEBIT, CREDIT, CHARGE CARD.
The type of card product.
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.
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": "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);
}
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);
}
{
"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"
}
}