Overview
User management
User verification
Wallets
Cards
Card pay-ins
- The Deposit Preauthorization object
- POSTCreate a Deposit Preauthorization
- PUTCancel a Deposit Preauthorization
- GETView a Deposit Preauthorization
- GETList Deposit Preauthorizations for a Card
- GETList Deposit Preauthorizations for a User
- The Deposit Preauthorized PayIn object
- POSTCreate a Deposit Preauthorized PayIn
- GETView a PayIn (Deposit Preauthorized Card)
Banking pay-ins
APM pay-ins
Transfers
Refunds
Disputes
Payouts
FX conversions
Transactions
Echo
Helpers
Platform account
Copy
Ask AI
[
{
"Id": "78e82d95-bf01-4633-84d9-f433e1130eba",
"CreationDate": 1696256380,
"ExpirationDate": 1698848380,
"AuthorizationDate": 1696256388,
"AuthorId": "204068024",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 22223
},
"Status": "SUCCEEDED",
"PaymentStatus": "CANCELED",
"PayinsLinked": {
"PayinCaptureId": null,
"PayinComplementId": null
},
"ResultCode": "000000",
"ResultMessage": "Success",
"CardId": "204068248",
"PreferredCardNetwork": null,
"SecureModeReturnURL": null,
"SecureModeRedirectURL": null,
"SecureModeNeeded": null,
"PaymentType": "CARD",
"ExecutionType": "DIRECT",
"StatementDescriptor": null,
"Culture": null,
"BrowserInfo": null,
"IpAddress": null,
"Billing": null,
"Shipping": null,
"Requested3DSVersion": null,
"Applied3DSVersion": null,
"Tag": "Created using Mangopay API Postman Collection",
"CardInfo": {
"BIN": "497010",
"IssuingBank": "LA BANQUE POSTALE",
"IssuerCountryCode": "MA",
"Type": "CREDIT",
"Brand": "VISA",
"SubType": null
}
}
]
Deposit preauthorizations
List Deposit Preauthorizations for a Card
GET
/
v2.01
/
{ClientId}
/
cards
/
{CardId}
/
deposit-preauthorizations
Copy
Ask AI
[
{
"Id": "78e82d95-bf01-4633-84d9-f433e1130eba",
"CreationDate": 1696256380,
"ExpirationDate": 1698848380,
"AuthorizationDate": 1696256388,
"AuthorId": "204068024",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 22223
},
"Status": "SUCCEEDED",
"PaymentStatus": "CANCELED",
"PayinsLinked": {
"PayinCaptureId": null,
"PayinComplementId": null
},
"ResultCode": "000000",
"ResultMessage": "Success",
"CardId": "204068248",
"PreferredCardNetwork": null,
"SecureModeReturnURL": null,
"SecureModeRedirectURL": null,
"SecureModeNeeded": null,
"PaymentType": "CARD",
"ExecutionType": "DIRECT",
"StatementDescriptor": null,
"Culture": null,
"BrowserInfo": null,
"IpAddress": null,
"Billing": null,
"Shipping": null,
"Requested3DSVersion": null,
"Applied3DSVersion": null,
"Tag": "Created using Mangopay API Postman Collection",
"CardInfo": {
"BIN": "497010",
"IssuingBank": "LA BANQUE POSTALE",
"IssuerCountryCode": "MA",
"Type": "CREDIT",
"Brand": "VISA",
"SubType": null
}
}
]
Query parameters
The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.
Allowed values:
CREATED, SUCCEEDED, FAILEDThe status of the transaction. You can filter on multiple values by separating them with a comma.Allowed values:
WAITING, CANCELED, CANCEL_REQUESTED, EXPIRED, TO_BE_COMPLETED, NO_SHOW_REQUESTED, NO_SHOW, VALIDATED, FAILEDThe payment status of the deposit preauthorization object:WAITING– The deposit preauthorization can be used: the preauthorized funds can be captured (without or prior to complement); a no-show can be declared; or the preauthorization can be canceled manually.CANCELED– Value to pass to manually cancel the deposit preauthorization before use (whether for capture or no-show); indicates that the deposit preauthorization was canceled manually.CANCEL_REQUESTED– The cancellation of the deposit preauthorization has been requested but not yet processed.EXPIRED– The hold period on the preauthorized funds has ended without it being used (whether for capture or no-show).TO_BE_COMPLETED– The preauthorized funds were captured (prior to complement) but the complement has not yet been captured.NO_SHOW_REQUESTED– Value to pass to request a no-show, signaling no capture of the preauthorized funds but the intent to capture a complement.NO_SHOW– A no-show was requested but a complement not yet been captured.VALIDATED– Indicates either (i) that the preauthorized funds were captured without complement; (ii) that the preauthorized funds and a complement were captured; or (iii) that a no-show was declared and a complement was captured.FAILED– The action against the preauthorization has failed (whether capture without complement, capture prior to complement, no-show request, complement), but a retry may be possible.
Responses
200
200
List of deposit preauthorizations created by the platform.
Show properties
Show properties
The deposit preauthorization created by the platform.
Show properties
Show properties
Max. length: 255 characters
The date and time at which the object was created.
The date and time at which the hold period ends and the preauthorized funds are released.
At the expiration date, the deposit preauthorization’s
At the expiration date, the deposit preauthorization’s
PaymentStatus changes to EXPIRED if no captures were made.The date and time at which successful authorization occurred. If authorization failed, the value is
null.The unique identifier of the user at the source of the transaction.
Information about the debited funds.
Show properties
Show properties
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 (the sell currency).
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).During a conversion, (DebitedFunds.Amount - Fees) * MarketRate = CreditedFunds.Amount. Returned values:
CREATED, SUCCEEDED, FAILEDThe status of the transaction.Returned values:
WAITING, CANCELED, CANCEL_REQUESTED, EXPIRED, VALIDATED, FAILEDThe payment status of the deposit preauthorization object:WAITING– The deposit preauthorization can be used: the preauthorized funds can be captured or the preauthorization can be canceled manually.CANCELED– Value to pass to manually cancel the deposit preauthorization before use; indicates that the deposit preauthorization was canceled manually.CANCEL_REQUESTED– The cancellation of the deposit preauthorization has been requested but not yet processed.EXPIRED– The hold period on the preauthorized funds has ended without it being used.VALIDATED– Indicates that the preauthorized funds were captured.FAILED– The pay-in against the preauthorization has failed, but a retry may be possible.
Information about the deposit preauthorized pay-ins made against the deposit preauthorization.
Show child attributes
Show child attributes
The unique identifier of the preauthorized pay-in (capture) made against the deposit preauthorization to debit the preauthorized funds.
The unique identifier of the deposit preauthorized pay-in complement made against the deposit preauthorization to debit additional funds.
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 unique identifier of the Card object, which is returned after updating the Card Registration object with the
RegistrationData.Returned values:
VISA, MASTERCARD, CB, MAESTROThe card network to use, as chosen by the cardholder, in case of co-branded cards.Max. length: 255 charactersThe URL to which to redirect the user to proceed to 3DS2 validation.
Whether or not the
SecureMode was used.Returned values:
KLARNAThe type of pay-in.Returned values:
WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.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.
Returned values: One of the supported languages in the ISO 639-1 format: CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.The language in which the payment page is to be displayed.
Information about the browser used by the end user (author) to perform the payment.
Show properties
Show properties
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.
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.The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.
Max. length: 6 charactersThe height of the screen in pixels.
Max. length: 6 charactersThe width of the screen in pixels.
The difference in minutes between the browser’s timezone and UTC.
Max. length: 255 charactersThe 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.
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.
Show properties
Show properties
The first name of the user.
Max. length: 100 charactersThe last name of the user.
Information about the billing address.
Show properties
Show properties
Max. length: 255 charactersThe first line of the address.
Max. length: 255 charactersThe second line of the address.
Max. length: 255 charactersThe city of the address.
Max. length: 255 charactersThe region of the address. This field is optional except if the
Country is US, CA, or MX.Max. length: 255 charactersThe 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.
Show properties
Show properties
The first name of the user.
Max. length: 100 charactersThe last name of the user.
Information about the shipping address.
Show properties
Show properties
Max. length: 255 charactersThe first line of the address.
Max. length: 255 charactersThe second line of the address.
Max. length: 255 charactersThe city of the address.
Max. length: 255 charactersThe region of the address. This field is optional except if the
Country is US, CA, or MX.Max. length: 255 charactersThe 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.
Returned values:
V1, V2_1The 3DS protocol version to be applied to the transaction.Returned values:
V1, V2_1The 3DS protocol version applied to the transaction.Max. length: 255 charactersCustom data that you can add to this object.
For preauthorizations, you can use this parameter to identify corresponding information regarding the user or transaction on your platform.
For preauthorizations, you can use this parameter to identify corresponding information regarding the user or transaction on your platform.
Information about the card used for the transaction.If the information or data is not available,
null is returned.Show properties
Show properties
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.Copy
Ask AI
[
{
"Id": "78e82d95-bf01-4633-84d9-f433e1130eba",
"CreationDate": 1696256380,
"ExpirationDate": 1698848380,
"AuthorizationDate": 1696256388,
"AuthorId": "204068024",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 22223
},
"Status": "SUCCEEDED",
"PaymentStatus": "CANCELED",
"PayinsLinked": {
"PayinCaptureId": null,
"PayinComplementId": null
},
"ResultCode": "000000",
"ResultMessage": "Success",
"CardId": "204068248",
"PreferredCardNetwork": null,
"SecureModeReturnURL": null,
"SecureModeRedirectURL": null,
"SecureModeNeeded": null,
"PaymentType": "CARD",
"ExecutionType": "DIRECT",
"StatementDescriptor": null,
"Culture": null,
"BrowserInfo": null,
"IpAddress": null,
"Billing": null,
"Shipping": null,
"Requested3DSVersion": null,
"Applied3DSVersion": null,
"Tag": "Created using Mangopay API Postman Collection",
"CardInfo": {
"BIN": "497010",
"IssuingBank": "LA BANQUE POSTALE",
"IssuerCountryCode": "MA",
"Type": "CREDIT",
"Brand": "VISA",
"SubType": null
}
}
]
Was this page helpful?
⌘I