PAYPAL – Within 3 days as recommended by PayPal, but the technical limit is 29 days (not 29.5).
Note that preauthorizations may not be permitted by some issuers and for some card types.
Best practice - For PayPal, capture funds within 3 daysPayPal recommends that you capture preauthorized funds within 3 days. This is because the success of the capture is subject to risk and the availability of funds on the card (or other funding instrument) that the user has linked to their PayPal account.
Note – Multi-capture not possible with the Deposit PreauthorizationMultiple partial captures are not possible with the Deposit Preauthorization, for either CARD or PAYPAL. In both cases however, the single capture can be for an amount less than the preauthorized amount.
Attributes
Card
PayPal
string
Max. length: 255 characters
Unix timestamp
The date and time at which the object was created.
Unix timestamp
The date and time at which the hold period ends and the preauthorized funds are released.
At the expiration date, the deposit preauthorization’s PaymentStatus changes to EXPIRED if no captures were made.
string
The unique identifier of the user at the source of the transaction.
object
Information about the preauthorized funds.
Show properties
string
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.
integer
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).
string
Returned values:CREATED, SUCCEEDED, FAILEDThe status of the authorization.
string
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 (if Status is SUCCEEDED) 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.
object
Information about the deposit preauthorized pay-ins made against the deposit preauthorization.
Show child attributes
string
The unique identifier of the preauthorized pay-in (capture) made against the deposit preauthorization to debit the preauthorized funds.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
string
The explanation of the result code.
string
The unique identifier of the Card object, obtained during the card registration process.
string
Returned values:VISA, MASTERCARD, CB, MAESTROThe card network to use, as chosen by the cardholder, in case of co-branded cards.
string
Max. length: 255 charactersThe URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the SecureModeNeeded parameter is set to true).
string
Max. length: 255 charactersThe URL to which to redirect the user to proceed to 3DS2 validation.Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
boolean
Whether or not the SecureMode was used.
string
Returned values:CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.
string
Returned values:WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
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.
string
Returned values: One of the supported languages in the ISO 639-1 format: DE, EN, ES, FR, IT, NL, PL, PT.The language in which the payment page is to be displayed.
object
Information about the browser used by the end user (author) to perform the payment.
Show properties
string
The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.
boolean
Whether or not the end user’s browser has the ability to execute Java.
string
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.
integer
The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.
integer
Max. length: 6 charactersThe height of the screen in pixels.
integer
Max. length: 6 charactersThe width of the screen in pixels.
integer
The difference in minutes between the browser’s timezone and UTC.
string
Max. length: 255 charactersThe exact content of the HTTP User-Agent header.
boolean
Whether or not the end user’s browser has the ability to execute JavaScript.
string
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
object
Default value: FirstName, LastName, and Address information of the Shipping object if any, otherwise the user (author).Information about the end user billing address. If left empty, the default values will be automatically taken into account.
Show properties
string
The first name of the user.
string
Max. length: 100 charactersThe last name of the user.
object
Information about the billing address.
Show child attributes
string
Max. length: 255 charactersThe first line of the address.
string
Max. length: 255 charactersThe second line of the address.
string
Max. length: 255 charactersThe city of the address.
string
Max. length: 255 charactersRequired if Country is US, CA, or MX.The region of the address.
string
Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Default value: FirstName, LastName, and Address information of the Billing object, if supplied, otherwise of the user (author).Information about the end user’s shipping address.
Show properties
string
The first name of the user.
string
Max. length: 100 charactersThe last name of the user.
object
Information about the shipping address.
Show child attributes
string
Max. length: 255 charactersThe first line of the address.
string
Max. length: 255 charactersThe second line of the address.
string
Max. length: 255 charactersThe city of the address.
string
Max. length: 255 charactersRequired if Country is US, CA, or MX.The region of the address.
string
Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Returned values:DEBIT, CREDIT, CHARGE CARD.The type of card product.
string
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.
string
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.
object | null
Information about the authentication result, based on the request made by Mangopay and the decision of the issuer regarding the type of authentication to be enforced (if applicable).
Show properties
string | null
Response values: CHALLENGE, FRICTIONLESS, DIRECT_AUTHORIZATIONThe type of authentication:
CHALLENGE – The issuer requested SCA to be enforced (for example, using 3DS).
FRICTIONLESS – The transaction was exempted from SCA because an exemption was granted by the issuer.
DIRECT_AUTHORIZATION – The transaction was sent to the issuer for authorization without any frictionless or challenge (for example, if SCA doesn’t apply).
A null value typically indicates that authentication was not requested (for example, because the request failed before being sent) or a decision was not received.
string
The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay via the Dashboard for more information.
string
The PayPal identifier of the buyer.
string
The last name of the buyer.
string
The mobile phone number of the buyer.
string
The first name of the buyer.
string
The country of the buyer.
string
PayPal’s unique identifier for the order.
string
The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the RedirectURL.
array (object)
Shipping information of the LineItems added to the pay-in object.
Show properties
string
The shipment’s tracking number provided by the carrier.
string
The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version.
string
Default value: falseIf true, sends an email notification to the PaypalBuyerAccountEmail containing the TrackingNumber and Carrier, which allows the end user to track their shipment with the carrier.
string
Returned values:SET_PROVIDED_ADDRESS, GET_FROM_FILE, NO_SHIPPINGInformation about the shipping address behavior on the PayPal payment page:
SET_PROVIDED_ADDRESS - The Shipping parameter becomes required and its values are displayed to the end user, who is not able to modify them.
GET_FROM_FILE – The Shipping parameter is ignored and the end user can choose from registered addresses.
NO_SHIPPING – No shipping address section is displayed.
string
Max. length: 127 characters (truncated after)The platform’s order reference for the transaction.
string
The email address registered on the PayPal account used to make the payment.
string
Returned values: One of the supported languages in the ISO 639-1 format: AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.The language in which the PayPal payment page is to be displayed.
array
objectInformation about the items purchased in the transaction. The total of all line items’ UnitAmount and TaxAmount must equal the DebitedFunds amount (negative amounts not allowed).
Show properties
string
Max. length: 127 characters (truncated after)The name of the item.
integer
The quantity of the item.
integer
The cost of the item, excluding tax.
integer
The tax amount applied to the item.
string
Max. length: 127 characters (truncated after)The platform’s unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay UserId or the seller’s business name or first name and last name.
Caution: Failure to use a unique seller identifier may result in PayPal restricting your service.
string
Allowed values: PHYSICAL_GOODS, DIGITAL_GOODS, DONATIONThe category of the item:
PHYSICAL_GOODS – Tangible items that can be physically shipped and received with proof of delivery upon arrival.
DIGITAL_GOODS – Products or services that are distributed and consumed via digital platforms or devices.
DONATION – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as DONATION within a single transaction, however it is not possible to combine DONATION other line item categories within the same transaction.
object
Information about the end user’s shipping address, managed by ShippingPreference.
Show properties
string
The first name of the user.
string
Max. length: 100 charactersThe last name of the user.
object
Information about the shipping address.
Show properties
string
Max. length: 255 charactersThe first line of the address.
string
Max. length: 255 charactersThe second line of the address.
string
Max. length: 255 charactersThe city of the address.
string
Max. length: 255 charactersThe region of the address. This field is optional except if the Country is US, CA, or MX.
string
Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Returned null because the billing address is not applicable to PayPal preauth.
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.
string
The URL to which to redirect the user to complete the payment.Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
string
Max. length: 255 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
string
Returned values:WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
string
Returned values:PAYPALThe type of pay-in.
string
Returned values:CREATED, SUCCEEDED, FAILEDThe status of the transaction.
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.
string
The explanation of the result code.
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
object
Information about the deposit preauthorized pay-ins made against the deposit preauthorization.
Show child attributes
string
The unique identifier of the preauthorized pay-in (capture) made against the deposit preauthorization to debit the preauthorized funds.
string
deprecated
This deprecated parameter is always returned null.
string
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 (if Status is SUCCEEDED) 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.
string
Returned values:CREATED, SUCCEEDED, FAILEDThe status of the authorization.
string
The unique identifier of the user at the source of the transaction.
object
Information about the preauthorized funds.
Show properties
string
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.
integer
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).
Unix timestamp
The date and time at which the hold period ends and the preauthorized funds are released.
At the expiration date, the deposit preauthorization’s PaymentStatus changes to EXPIRED if no captures were made.
Unix timestamp
The date and time at which the object was created.
string
Max. length: 255 charactersThe unique identifier of the PayPal preauthorization.
Related resources
Guide
Learn more about 30-day preauthorization
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Mangopay docs","description":"Product guides and API reference for Mangopay's wallet-first payment infrastructure","colors":{"primary":"#00000E","light":"#FFFFFF","dark":"#12282F"},"logo":{"light":"https://mintcdn.com/mangopay/EHwmKiFob2p48DHF/logo/mgp-light.svg?fit=max\u0026auto=format\u0026n=EHwmKiFob2p48DHF\u0026q=85\u0026s=f2bf5f88a1d39831377b5952b46b031c","dark":"https://mintcdn.com/mangopay/EHwmKiFob2p48DHF/logo/mgp-dark.svg?fit=max\u0026auto=format\u0026n=EHwmKiFob2p48DHF\u0026q=85\u0026s=98389a9237e8b1abb2aa34b3ca686ee4"},"favicon":"https://mintcdn.com/mangopay/EHwmKiFob2p48DHF/logo/mgp-favicon.svg?fit=max\u0026auto=format\u0026n=EHwmKiFob2p48DHF\u0026q=85\u0026s=ee5912ec577e98b0b72a31c063e9325f","api":{"playground":{"display":"simple"}},"background":{"color":{"light":"#FFFFFF","dark":"#090D0D"}},"navbar":{"links":[{"href":"https://mangopay.com/contact","label":"Contact sales"}],"primary":{"type":"button","label":"Dashboard","href":"https://hub.mangopay.com"}},"seo":{"metatags":{"og:image":"/images/seo_og_image_blank.png"},"indexing":"navigable"},"fonts":{"family":"Inter"},"styling":{"eyebrows":"section","latex":false},"integrations":{"gtm":{"tagId":"GTM-PM2TV97"},"hotjar":{"hjid":"5086558","hjsv":"6"}},"contextual":{"options":["copy","view"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mangopay","hasAudioNarration":false,"actualSubdomain":"mangopay","customDomains":["docs.mangopay.com"],"gitSource":{"type":"gitlab","owner":"mangopay/dev/offer","repo":"docs","projectId":76955225,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"}},"buildId":"6ad9d6b35b6514564d510183","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API reference","count":338},{"language":"default","tag":"Guides","count":101},{"language":"default","tag":"APM pay-ins","count":59},{"language":"default","tag":"Integration","count":52},{"language":"default","tag":"Payments","count":40},{"language":"default","tag":"Disputes","count":34},{"language":"default","tag":"Banking pay-ins","count":33},{"language":"default","tag":"Card pay-ins","count":33},{"language":"default","tag":"Echo","count":32},{"language":"default","tag":"Users","count":31}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZJhiI2B.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZthiI2B.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZNhiI2B.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZxhiI2B.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZBhiI2B.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZFhiI2B.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hiA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-Cw6nSHrV.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-CwenSHrV.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-CwCnSHrV.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-CwynSHrV.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-Cw2nSHrV.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-CwOnSA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD2OwG_TA.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD_OwG_TA.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD4OwG_TA.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD0OwG_TA.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD1OwG_TA.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD7OwE.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n@font-face{font-family:\"AeonikMedium\";src:url(\"https://feature-redesign-2025--dev-mangopay.netlify.app/fonts/aeonik/aeonik-medium.woff\")\n format(\"woff\")}#chat-assistant-disclaimer-text{font-size:0.875rem!important;line-height:1.25rem!important;color:#4b5563!important}#chat-assistant-disclaimer-text .dark{color:#9ca3af!important}.pill{display:inline-flex;margin:12px 0px;padding:0px 8px;justify-content:center;align-items:center;gap:4px;border-radius:4px;font-family:\"JetBrains Mono\", monospace;font-size:14px;font-style:normal;font-weight:700;line-height:20px;text-transform:uppercase}.pill-green{background-color:#89E481;color:#12282F}.pill-orange{background-color:#FFD260;color:#12282F}.pill-red{background-color:#F5C1AE;color:#12282F}.pill-blue{background-color:#AAE0FF;color:#12282F}.pill-gray{margin:0px 12px 0px 0px;background-color:#f5f3f5;color:#2d0f37}.background-color-yellow{background-color:#12282f}.dark .background-color-yellow{background-color:#e5e5e5}.background-color-yellow:hover{background-color:#2a3e44}.dark .background-color-yellow:hover{background-color:#ffffff}.background-color-yellow:hover svg path:first-child{fill:#ffffff}.background-color-yellow:hover svg path:last-child{stroke:#ffffff}.dark .background-color-yellow svg path:first-child{fill:#00000e}.dark .background-color-yellow svg path:last-child{stroke:#00000e}.dark .background-color-yellow:hover svg path:first-child{fill:#00000e}.dark .background-color-yellow:hover svg path:last-child{stroke:#00000e}.card-header-color-yellow{color:#ffffff!important}.dark .card-header-color-yellow{color:#00000e!important}.background-color-lavander{background-color:#dbd9ff}.dark .background-color-lavander{background-color:#b6b2ff}.background-color-lavander:hover{background-color:#b6b2ff}.dark .background-color-lavander:hover{background-color:#867eff}.background-color-lavander:hover svg path:first-child{fill:#00000e}.background-color-lavander:hover svg path:last-child{stroke:#00000e}#search-bar-entry span{color:inherit}#topbar-cta-button a:hover .bg-primary-dark{--primary-dark: 65 83 89}html.dark #topbar-cta-button .bg-primary-dark{--primary-dark: 34 37 37}html.dark #topbar-cta-button a:hover .bg-primary-dark{--primary-dark: 58 61 61}:is(.dark #navbar>div:nth-child(2) .dark\\:border-primary-light){border-color:white}.flex.font-mono.text-sm .font-bold.text-primary.dark\\:text-primary-light{font-size:15px}.flex.font-mono.text-sm .font-bold.text-primary.dark\\:text-primary-light~div>div{color:rgb(var(--gray-600))}html.dark .flex.font-mono.text-sm .font-bold.text-primary.dark\\:text-primary-light~div>div{color:rgb(var(--gray-200))}.flex.font-mono.text-sm~.mt-4.prose-sm.prose-gray.dark\\:prose-invert>ul,.flex.font-mono.text-sm~.mt-4.prose-sm.prose-gray.dark\\:prose-invert>ol,.flex.font-mono.text-sm~.mt-4.prose-sm.prose-gray.dark\\:prose-invert>p{font-size:15px;line-height:1.5rem}html.dark .prose :where(a):not(:where([class~=not-prose],[class~=not-prose] *)){color:inherit;border-bottom-color:white}#page-title{font-family:\"AeonikMedium\", sans-serif;font-weight:500;font-size:48px;line-height:56px}code.language-ruby,code.language-dotnet,code.language-python,code.language-java{color:#fff}code.language-php span,code.language-ruby span{color:#fff}.prose :where(strong):not(:where([class~=\"not-prose\"] *)){color:inherit}:is(.dark .prose strong){color:inherit}#text{color:#fff}.dark .card-header h2,.dark .card-body p{color:#2d0f37}html:not(.dark) .prose{color:#2d0f37}html.dark .prose{color:white}html:not(.dark) .text-gray-600,html:not(.dark) .text-gray-700,html:not(.dark) .text-gray-800,html:not(.dark) .text-gray-900{color:#2d0f37}html.dark .dark\\:text-gray-200,html.dark .dark\\:text-gray-300{color:white}h1{font-weight:800}h2,h3,h4,h5,h6{font-weight:600!important}html.dark h1,html.dark h2,html.dark h3,html.dark h4,html.dark h5,html.dark h6{color:white}html:not(.dark) h1,html:not(.dark) h2,html:not(.dark) h3,html:not(.dark) h4,html:not(.dark) h5,html:not(.dark) h6{color:#2d0f37}.resize-text{font-size:15px}code.language-ruby,code.language-python,code.language-java{color:#fff}code.language-php span,code.language-ruby span{color:#fff}#text{color:#fff}.dark .card-header h2,.dark .card-body p{color:#2d0f37}.prose :where(ol>li):not(:where([class~=\"not-prose\"] *))::marker{color:inherit}.prose :where(blockquote):not(:where([class~=\"not-prose\"] *)){border-color:#2d0f37;color:#2d0f37}:is(.dark .prose blockquote){border-color:white;color:white}html #sidebar{text-wrap:pretty}html #sidebar li{transition:0.15s}html.dark #sidebar .dark\\:text-gray-400 p{color:rgb(159, 158, 160)}:is(.dark .prose a){color:white}:is(.dark .dark\\:decoration-gray-500){text-decoration-color:inherit}.home-card-grid{display:grid;gap:0 1rem;grid-template-columns:1fr}@media (min-width: 640px){.home-card-grid-2{grid-template-columns:repeat(2, minmax(0, 1fr))}.home-card-grid-3{grid-template-columns:repeat(3, minmax(0, 1fr))}}.card,.card *{transition-duration:150ms}.card div.h-6.w-6{width:auto;height:auto}.dark .card:not(.card-variation){background:rgb(20, 23, 23);border:none}.dark .card:not(.card-variation):hover{background-color:#2d2e2f}.card:not(.card-variation):not(.sdk-card)>div{padding:1.5rem}.card:not(.card-variation) p{font-size:16px;margin-top:1rem}.card.shadow-md{box-shadow:unset}.card-variation .card-header{display:flex;justify-content:space-between;align-items:center}.card-variation.background-color-yellow:hover .card-header>h2{color:#ffffff}.card-variation.background-color-lavander:hover .card-header>h2{color:#00000e}.card-variation .card-header>h2{font-size:1.5rem}.card-variation .card-body{margin-top:48px}.card-variation .card-body p{line-height:24px}.card-variation.background-color-yellow:hover .card-body p{color:#ffffff}.dark .card-variation.background-color-yellow:hover .card-body p{color:#00000e}.card-variation.background-color-lavander:hover .card-body p{color:#00000e}.sdk-card{background-color:#f5f5f6;border:hidden}:not(.dark).sdk-card:hover{border:hidden;background-color:#e5e5e9;color:#00000e!important}.dark .sdk-card p{color:#dfdee0}table{border:none;font-size:15px!important;line-height:1.5rem!important}.hx-inside h4{margin-top:0!important}.prose :where(thead th):not(:where([class~=\"not-prose\"] *)){color:#2d0f37}.dark .prose :where(thead th):not(:where([class~=\"not-prose\"] *)){color:white}.header{vertical-align:middle;text-align:left;padding:10px 16px;font-weight:600}.header-compact{vertical-align:middle;text-align:left;font-weight:600}.header-compact-2{padding:10px 16px 10px 0px;vertical-align:top;text-align:left;font-weight:600}.compact{white-space:nowrap}.table-content{padding:10px 16px;vertical-align:top}.table-content p{margin-top:0}.table-content p:last-child{margin-bottom:0}.table-content li{padding-left:1.5rem!important}.table-content>ul:first-child{margin-top:0px!important;margin-bottom:0px!important;vertical-align:top}.table-content>ul:first-child>li:first-child{margin-top:0px!important;margin-bottom:0px!important;vertical-align:top}td:first-child,th:first-child,.dark td:first-child,.dark th:first-child{border-left:none}td:last-child,th:last-child,.dark td:last-child,.dark th:last-child{border-right:none}th{border-right:1px solid #d0d3d0;border-left:1px solid #d0d3d0;border-bottom:1px solid #d0d3d0;border-collapse:collapse}td{border-bottom:1px solid #d0d3d0;border-right:1px solid #d0d3d0;border-left:none;border-collapse:collapse}.dark td{border-bottom:1px solid #4e5251;border-right:1px solid #4e5251;border-left:none}.dark th{border-bottom:1px solid #4e5251;border-right:1px solid #4e5251}.header-column .header{vertical-align:top;margin-top:0em!important}.row-span{border-right:none;border-left:1px solid #d0d3d0}.dark .row-span{border-right:none;border-left:1px solid #4e5251}.no-borders{border:hidden!important}.hug-content{width:1%;white-space:nowrap}.min-height-4-lines{height:7.25rem}.min-height-3-lines{height:5.75rem}.min-height-2-lines{height:4.25rem}.currenciesTable{height:80vh;border-collapse:separate;border-spacing:0}.currenciesTable td{border-bottom:1px solid #d0d3d0;border-right:1px solid #d0d3d0;border-left:none;border-collapse:collapse;color:#374151}.dark .currenciesTable td{border-bottom:1px solid #4e5251;border-right:1px solid #4e5251;color:#9ca3af}.currenciesTable .header{border:1px solid #d0d3d0;border-top:none;border-left:none;background-color:#f3f5f3!important}.dark .currenciesTable .header{border:1px solid #4e5251;border-top:none;border-left:none;background-color:#171919!important}.currenciesTable thead tr:first-child th:first-child,.currenciesTable tbody th:first-child{position:sticky;left:0;z-index:1}.currenciesTable thead{position:sticky;top:0;z-index:2}.dark .currenciesTable thead{position:sticky;top:0;z-index:2}.header-normal-weight{font-weight:normal}.hide{display:none}.release-notes-cards .card h2{margin-top:0px}.release-notes-cards .card h4{font-size:1rem;font-weight:400}.release-notes-cards .card li{font-size:1rem}.release-notes-cards .pill{margin-top:1.2em!important;margin-bottom:0em!important}.release-notes-page :where(h3):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){margin-top:0.2em!important}.release-notes-page :where(h2):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){margin-top:0.2em!important}.release-notes-page .pill{margin-top:1.2em!important}html.dark #content-area button.dark:hover\\:bg-white\\/5{background-color:rgb(20, 23, 23)}html.dark #content-area button.dark:hover\\:bg-white\\/5:hover{background-color:#2d2e2f}#content-area .dark\\:bg-codeblock>button p{font-weight:600}html.dark #content-area div[role=\"listitem\"].border{background-color:rgb(20, 23, 23);border:none}.bar-of-progress{color:#fcb069!important}.bar-of-progress .glow{box-shadow:#fcb069 3px 0px 2px 0px!important}html.dark .bar-of-progress{color:#fcb069!important}html.dark .bar-of-progress .glow{box-shadow:#fcb069 3px 0px 2px 0px!important}.bar-of-progress:after{box-shadow:0px 0px 0px 0px!important}.text-sm.prose{font-size:15px;line-height:1.5rem}:is(.dark :not(pre)>code){border-color:#2d2e2f;background-color:rgb(20, 23, 23)}.not-prose.dark\\:bg-codeblock.rounded-xl{background:rgb(20, 23, 23)}.not-prose.dark\\:bg-codeblock.rounded-xl svg.fill-gray-700{fill:rgb(var(--gray-400))}.not-prose.dark\\:bg-codeblock.rounded-xl>div:first-child{background:#2d2e2f}.not-prose.dark\\:bg-codeblock.rounded-xl>div:first-child>.flex.overflow-x-auto{overflow-y:hidden}::-webkit-scrollbar{height:8px;width:8px}::-webkit-scrollbar-thumb{border-radius:2px;background:rgba(0, 0, 0, 0.1)}html.dark ::-webkit-scrollbar-thumb{background:rgba(255, 255, 255, 0.1)}::-webkit-scrollbar-track{background:rgba(0, 0, 0, 0.1)}html.dark::-webkit-scrollbar-track{background:rgba(255, 255, 255, 0.1)}.z-50.bg-tooltip.max-w-\\[16rem\\].text-center.text-gray-50.text-xs.px-1\\.5.py-1.rounded-lg.border.border-gray-50.dark\\:border-gray-500{font-size:14px;line-height:1.5rem}.lucide-arrow-up-right{visibility:hidden}footer{visibility:hidden}.mermaid{width:100%}.currency-dropdown-container{margin-bottom:25px}.currency-dropdown-label{font-size:15px;margin-right:10px;font-weight:600;display:block;margin-bottom:8px}.currency-dropdown-select{align-items:center;height:2.25rem;line-height:1.5rem;padding-right:0.75em;padding-left:0.875em;border-radius:4px;border:1px solid #ccc;width:25%;box-sizing:border-box;margin-bottom:20px;border-radius:var(--rounded-xl, 0.75rem)}.currency-details-section{font-size:15px}.currency-routes-list{list-style-type:none;padding-left:0}"},{"filePath":"_cookie-banner.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZJhiI2B.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZthiI2B.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZNhiI2B.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZxhiI2B.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZBhiI2B.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZFhiI2B.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hiA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-Cw6nSHrV.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-CwenSHrV.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-CwCnSHrV.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-CwynSHrV.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-Cw2nSHrV.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: italic;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbX2o-flEEny0FZhsfKu5WU4xD-CwOnSA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD2OwG_TA.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD_OwG_TA.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD4OwG_TA.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD0OwG_TA.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD1OwG_TA.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'JetBrains Mono';\n font-style: normal;\n font-weight: 100 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD7OwE.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n@media (min-width: 600px){#onetrust-button-group{display:flex!important;justify-content:space-between!important}}@media (min-width: 600px){#onetrust-button-group{display:flex!important;flex-direction:row-reverse!important}}@media (min-width: 600px){#onetrust-button-group button{margin-right:12px!important}}#onetrust-pc-btn-handler,#onetrust-reject-all-handler,#onetrust-accept-btn-handler,.ot-pc-refuse-all-handler,.save-preference-btn-handler,#accept-recommended-btn-handler{border-radius:56px!important;font-size:12px!important;font-family:\"JetBrains Mono\", monospace!important;font-weight:500!important;transition:0.2s;min-width:0!important;letter-spacing:normal}#onetrust-reject-all-handler,.ot-pc-refuse-all-handler{border:1px solid #eae7eb!important;color:#12282f!important;background-color:transparent!important;padding:10px 24px!important}#onetrust-reject-all-handler:hover,.ot-pc-refuse-all-handler:hover,#onetrust-reject-all-handler:focus,.ot-pc-refuse-all-handler:focus{border-color:#eae7eb!important;background-color:#eae7eb!important;opacity:1!important}#onetrust-accept-btn-handler,.save-preference-btn-handler,#accept-recommended-btn-handler{background:#867eff!important;border:1px solid #867eff!important;color:#ffffff!important;padding:10px 24px!important}#onetrust-accept-btn-handler:hover,.save-preference-btn-handler:hover,#accept-recommended-btn-handler:hover,#onetrust-accept-btn-handler:focus,.save-preference-btn-handler:focus,#accept-recommended-btn-handler:focus{border-color:#665eff!important;background-color:#665eff!important;color:#ffffff!important;opacity:1!important}#onetrust-pc-btn-handler{border:none!important;color:#12282f!important;background-color:transparent!important;padding:10px 24px!important}#onetrust-pc-btn-handler:hover,#onetrust-pc-btn-handler:focus{color:#12282f!important;padding:10px 24px!important;border-color:#eae7eb!important;background-color:#eae7eb!important;opacity:1!important}#onetrust-consent-sdk #onetrust-pc-sdk div.ot-always-active{color:#867eff!important}#onetrust-consent-sdk #onetrust-pc-sdk .category-menu-switch-handler h3{transition:0.2s}#onetrust-consent-sdk #onetrust-pc-sdk .category-menu-switch-handler:hover h3{color:#867eff}#onetrust-consent-sdk #onetrust-pc-sdk,#onetrust-consent-sdk #onetrust-banner-sdk{border-radius:16px!important}#onetrust-consent-sdk #onetrust-pc-sdk p,#onetrust-consent-sdk #onetrust-banner-sdk p{color:#12282f!important}#onetrust-consent-sdk #onetrust-pc-sdk *:focus,#onetrust-consent-sdk #onetrust-banner-sdk *:focus{outline:none!important}#onetrust-consent-sdk #onetrust-pc-sdk:focus,#onetrust-consent-sdk #onetrust-banner-sdk:focus{outline:none!important}#onetrust-consent-sdk #onetrust-pc-sdk .privacy-notice-link{color:#2d0f37!important;text-decoration:underline!important;transition:0.2s}#onetrust-consent-sdk #onetrust-pc-sdk .privacy-notice-link:hover{color:#867eff!important;text-decoration:underline!important}#onetrust-consent-sdk #onetrust-pc-sdk .ot-active-menu{border-color:#867eff!important}#onetrust-consent-sdk #onetrust-banner-sdk{box-shadow:none!important;background-color:#ffffff!important}@media (min-width: 600px){#onetrust-consent-sdk #onetrust-banner-sdk.otCenterRounded{top:auto!important;bottom:24px!important}}#onetrust-consent-sdk #onetrust-banner-sdk #onetrust-policy-text{font-size:14px!important;line-height:24px!important}#onetrust-consent-sdk #onetrust-banner-sdk a[href]{color:#12282f!important;text-decoration:underline!important;transition:0.2s;font-weight:400!important}#onetrust-consent-sdk #onetrust-banner-sdk a[href]:hover{color:#867eff!important;text-decoration:underline!important}#onetrust-consent-sdk #onetrust-banner-sdk.ot-bnr-w-logo #onetrust-policy{margin-top:30px!important}#onetrust-consent-sdk #onetrust-banner-sdk.ot-bnr-w-logo .ot-bnr-logo{margin-left:0.875rem!important}@media (min-width: 601px){#onetrust-consent-sdk #onetrust-banner-sdk.ot-bnr-w-logo .ot-bnr-logo{margin-left:1.375rem!important}}@media (min-width: 600px){#onetrust-consent-sdk #onetrust-banner-sdk.ot-bnr-w-logo .ot-bnr-logo{margin-left:1.5rem!important}}#onetrust-consent-sdk .ot-bnr-logo{display:none!important}#onetrust-consent-sdk #onetrust-pc-sdk{overflow:hidden!important;background:#f9f8f9!important;box-shadow:0px 8px 12px rgba(45, 12, 45, 0.05),\n 0px -2px 4px rgba(45, 12, 45, 0.02), 0px 2px 4px rgba(0, 0, 0, 0.05)!important}#onetrust-consent-sdk #onetrust-pc-sdk .ot-pc-footer-logo{display:none!important}#onetrust-consent-sdk #onetrust-pc-sdk .save-preference-btn-handler,#onetrust-consent-sdk #onetrust-pc-sdk .ot-pc-refuse-all-handler,#onetrust-consent-sdk #onetrust-pc-sdk #accept-recommended-btn-handler{border-radius:1.38rem!important}#onetrust-consent-sdk #onetrust-pc-sdk .ot-always-active{color:#867eff!important}#onetrust-consent-sdk #onetrust-pc-sdk .ot-sdk-container{border-radius:0!important}#onetrust-consent-sdk #onetrust-pc-sdk #ot-pc-desc br{display:none}.footer-ot-cookie-settings-btn .ot-sdk-show-settings,.legal-page .ot-sdk-show-settings{border:none!important;padding:0!important}.footer-ot-cookie-settings-btn .ot-sdk-show-settings:hover,.legal-page .ot-sdk-show-settings:hover{background-color:transparent!important}.legal-page .ot-sdk-show-settings{color:#867eff!important;font-size:inherit!important}.legal-page .ot-sdk-show-settings:hover{color:#867eff!important}#ot-sdk-cookie-policy .ot-sdk-cookie-policy.ot-sdk-container{box-shadow:none!important}#ot-sdk-cookie-policy .ot-sdk-cookie-policy.ot-sdk-container *{color:#2d0c2d!important}#ot-sdk-cookie-policy .ot-sdk-cookie-policy.ot-sdk-container a{text-decoration:none!important;background-color:transparent!important;color:#867eff!important}#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy #cookie-policy-title,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy .ot-sdk-cookie-policy-group,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy #cookie-policy-description,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy h5,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy h6,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy li,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy p{font-size:1.25rem!important}@media only screen and (min-width: 768px){#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy #cookie-policy-title,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy .ot-sdk-cookie-policy-group,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy #cookie-policy-description,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy h5,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy h6,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy li,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy p{font-size:1.25rem!important;line-height:2rem!important}}#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy a,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy span,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy td{font-size:0.9rem!important}@media only screen and (min-width: 768px){#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy a,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy span,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy td{font-size:1.25rem!important;line-height:2rem!important}}@media only screen and (max-width: 720px){#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy table,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy thead,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy tbody,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy th,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy td,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy tr{display:block!important}}@media only screen and (min-width: 720px){#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy th,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy td{max-width:200px}}#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy table .ot-host,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy table .ot-cookies-type{width:auto!important}@media only screen and (min-width: 720px){#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy table .ot-host,#ot-sdk-cookie-policy-v2.ot-sdk-cookie-policy table .ot-cookies-type{width:25%!important}}@media only screen and (min-width: 400px){#onetrust-banner-sdk .ot-sdk-container,#onetrust-pc-sdk .ot-sdk-container,#ot-sdk-cookie-policy .ot-sdk-container{width:100%!important}}.cookie-page a{display:inline-block;word-wrap:break-word;max-width:100%!important}.cookie-page table .ot-host-td{word-wrap:break-word!important}"}],"page":{"pagePath":"api-reference/deposit-preauthorizations/deposit-preauthorization-object","slug":"/api-reference/deposit-preauthorizations/deposit-preauthorization-object","pageMetadata":{"title":"The Deposit Preauthorization object","description":null,"href":"/api-reference/deposit-preauthorizations/deposit-preauthorization-object"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,br:`br`,code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Card,Check,Expandable,Heading,Note,ParamField,ResponseField,Tab,Tabs}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Check)_missingMdxReference(`Check`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`description`,children:`Description`}),`\n`,_jsx(_components.p,{children:`The Deposit Preauthorization object enables you to reserve funds on a card so they can be captured later, using two API calls:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Authorization of the transaction, handled by the Deposit Preauthorization object`}),`\n`,_jsx(_components.li,{children:`Capture of the funds, handled by the Deposit Preauthorized PayIn object`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`The Deposit Preauthorization object is used for two payment methods, indicated by the `,_jsx(_components.code,{children:`PaymentType`}),`:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`CARD`}),` – Created using `,_jsx(_components.a,{href:`/api-reference/deposit-preauthorizations/create-card-deposit-preauthorization`,children:`POST Create a Card Deposit Preauthorization`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`PAYPAL`}),` – Created using `,_jsx(_components.a,{href:`/api-reference/deposit-preauthorizations/create-paypal-deposit-preauthorization`,children:`POST Create a PayPal Deposit Preauthorization`})]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`In both cases, the capture is made with the same endpoint, `,_jsx(_components.a,{href:`/api-reference/deposit-preauthorizations/create-deposit-preauthorized-payin`,children:`POST Create a Deposit Preauthorized PayIn`}),`:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`CARD`}),` – Within `,_jsx(_components.strong,{children:`29.5`}),` days.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`PAYPAL`}),` – Within 3 days as recommended by PayPal, but the technical limit is `,_jsx(_components.strong,{children:`29`}),` days (not 29.5).`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Note that preauthorizations may not be permitted by some issuers and for some card types.`}),`\n`,_jsxs(Check,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Best practice - For PayPal, capture funds within 3 days`})}),_jsx(_components.p,{children:`PayPal recommends that you capture preauthorized funds within 3 days. This is because the success of the capture is subject to risk and the availability of funds on the card (or other funding instrument) that the user has linked to their PayPal account.`})]}),`\n`,_jsxs(Note,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Note – Multi-capture not possible with the Deposit Preauthorization`})}),_jsxs(_components.p,{children:[`Multiple partial captures are not possible with the Deposit Preauthorization, for either `,_jsx(_components.code,{children:`CARD`}),` or `,_jsx(_components.code,{children:`PAYPAL`}),`. In both cases however, the single capture can be for an amount less than the preauthorized amount.`]})]}),`\n`,_jsx(Heading,{level:`3`,id:`attributes`,children:`Attributes`}),`\n`,_jsxs(Tabs,{children:[_jsxs(Tab,{title:`Card`,id:`card`,children:[_jsx(ParamField,{body:`Id`,type:`string`,id:`param-id`,children:_jsx(_components.p,{children:`Max. length: 255 characters`})}),_jsx(ParamField,{body:`CreationDate`,type:`Unix timestamp`,id:`param-creation-date`,children:_jsx(_components.p,{children:`The date and time at which the object was created.`})}),_jsx(ParamField,{body:`ExpirationDate`,type:`Unix timestamp`,id:`param-expiration-date`,children:_jsxs(_components.p,{children:[`The date and time at which the hold period ends and the preauthorized funds are released.`,_jsx(_components.br,{}),`\n`,`At the expiration date, the deposit preauthorization’s `,_jsx(_components.code,{children:`PaymentStatus`}),` changes to `,_jsx(_components.code,{children:`EXPIRED`}),` if no captures were made.`]})}),_jsx(ParamField,{body:`AuthorId`,type:`string`,id:`param-author-id`,children:_jsx(_components.p,{children:`The unique identifier of the user at the source of the transaction.`})}),_jsxs(ParamField,{body:`DebitedFunds`,type:`object`,id:`param-debited-funds`,children:[_jsx(_components.p,{children:`Information about the preauthorized funds.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ParamField,{body:`Currency`,type:`string`,id:`param-currency`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` The three-letter `,_jsx(_components.a,{href:`/api-reference/overview/data-formats`,target:`_blank`,children:`ISO 4217 code`}),` (EUR, GBP, etc.) of a `,_jsx(_components.a,{href:`/guides/currencies`,target:`_blank`,children:`supported currency`}),` (depends on feature, contract, and activation settings).`]}),_jsx(_components.p,{children:`The currency of the funds.`})]}),_jsx(ParamField,{body:`Amount`,type:`integer`,id:`param-amount`,children:_jsxs(_components.p,{children:[`An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `,_jsx(_components.code,{children:`1260`}),` whereas JPY 12 would be represented as just `,_jsx(_components.code,{children:`12`}),`).`]})})]})]}),_jsxs(ParamField,{body:`Status`,type:`string`,id:`param-status`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`CREATED`}),`, `,_jsx(_components.code,{children:`SUCCEEDED`}),`, `,_jsx(_components.code,{children:`FAILED`})]}),_jsx(_components.p,{children:`The status of the authorization.`})]}),_jsxs(ResponseField,{name:`PaymentStatus`,type:`string`,id:`param-payment-status`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`WAITING`}),`, `,_jsx(_components.code,{children:`CANCELED`}),`, `,_jsx(_components.code,{children:`CANCEL_REQUESTED`}),`, `,_jsx(_components.code,{children:`EXPIRED`}),`, `,_jsx(_components.code,{children:`VALIDATED`}),`, `,_jsx(_components.code,{children:`FAILED`})]}),_jsx(_components.p,{children:`The payment status of the deposit preauthorization object:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`WAITING`}),` – The deposit preauthorization can be used: the preauthorized funds can be captured (if `,_jsx(_components.code,{children:`Status`}),` is `,_jsx(_components.code,{children:`SUCCEEDED`}),`) or the preauthorization can be canceled manually.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`CANCELED`}),` – Value to pass to manually cancel the deposit preauthorization before use; indicates that the deposit preauthorization was canceled manually.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`CANCEL_REQUESTED`}),` – The cancellation of the deposit preauthorization has been requested but not yet processed.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`EXPIRED`}),` – The hold period on the preauthorized funds has ended without it being used.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`VALIDATED`}),` – Indicates that the preauthorized funds were captured.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`FAILED`}),` – The pay-in against the preauthorization has failed, but a retry may be possible.`]}),`\n`]})]}),_jsxs(ParamField,{body:`PayinsLinked`,type:`object`,id:`param-payins-linked`,children:[_jsx(_components.p,{children:`Information about the deposit preauthorized pay-ins made against the deposit preauthorization.`}),_jsxs(Expandable,{children:[_jsx(ParamField,{body:`PayinCaptureId`,type:`string`,id:`param-payin-capture-id`,children:_jsx(_components.p,{children:`The unique identifier of the preauthorized pay-in (capture) made against the deposit preauthorization to debit the preauthorized funds.`})}),_jsx(ParamField,{body:`PayinComplementId`,type:`string`,id:`param-payin-complement-id`,children:_jsxs(_components.p,{children:[`The unique identifier of the `,_jsx(_components.a,{href:`/api-reference/deposit-preauthorizations/create-deposit-preauthorized-payin-complement`,children:`deposit preauthorized pay-in complement`}),` made against the deposit preauthorization to debit additional funds.`]})})]})]}),_jsx(ParamField,{body:`ResultCode`,type:`string`,id:`param-result-code`,children:_jsxs(_components.p,{children:[`The code indicating the result of the operation. This information is mostly used to `,_jsx(_components.a,{href:`/errors/codes`,children:`handle errors`}),` or for filtering purposes.`]})}),_jsx(ParamField,{body:`ResultMessage`,type:`string`,id:`param-result-message`,children:_jsx(_components.p,{children:`The explanation of the result code.`})}),_jsx(ParamField,{body:`CardId`,type:`string`,id:`param-card-id`,children:_jsx(_components.p,{children:`The unique identifier of the Card object, obtained during the card registration process.`})}),_jsxs(ParamField,{body:`PreferredCardNetwork`,type:`string`,id:`param-preferred-card-network`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`VISA`}),`, `,_jsx(_components.code,{children:`MASTERCARD`}),`, `,_jsx(_components.code,{children:`CB`}),`, `,_jsx(_components.code,{children:`MAESTRO`})]}),_jsxs(_components.p,{children:[`The card network to use, as chosen by the cardholder, in case of `,_jsx(_components.a,{href:`/guides/payment-methods/card/co-branded`,children:`co-branded cards`}),`.`]})]}),_jsxs(ParamField,{body:`SecureModeReturnURL`,type:`string`,id:`param-secure-mode-return-url`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsxs(_components.p,{children:[`The URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the `,_jsx(_components.code,{children:`SecureModeNeeded`}),` parameter is set to `,_jsx(_components.code,{children:`true`}),`).`]})]}),_jsxs(ParamField,{body:`SecureModeRedirectURL`,type:`string`,id:`param-secure-mode-redirect-url`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The URL to which to redirect the user to proceed to 3DS2 validation.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Caution:`}),` This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.`]})]}),_jsx(ParamField,{body:`SecureModeNeeded`,type:`boolean`,id:`param-secure-mode-needed`,children:_jsxs(_components.p,{children:[`Whether or not the `,_jsx(_components.code,{children:`SecureMode`}),` was used.`]})}),_jsxs(ParamField,{body:`PaymentType`,type:`string`,id:`param-payment-type`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`CARD`}),`, `,_jsx(_components.code,{children:`DIRECT_DEBIT`}),`, `,_jsx(_components.code,{children:`PREAUTHORIZED`}),`, `,_jsx(_components.code,{children:`BANK_WIRE`})]}),_jsx(_components.p,{children:`The type of pay-in.`})]}),_jsxs(ParamField,{body:`ExecutionType`,type:`string`,id:`param-execution-type`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`WEB`}),`, `,_jsx(_components.code,{children:`DIRECT`}),`, `,_jsx(_components.code,{children:`EXTERNAL_INSTRUCTION`})]}),_jsx(_components.p,{children:`The type of execution for the pay-in.`})]}),_jsxs(ParamField,{body:`StatementDescriptor`,type:`string`,id:`param-statement-descriptor`,children:[_jsx(_components.p,{children:`Max. length: 10 characters; only alphanumeric and spaces`}),_jsxs(_components.p,{children:[`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 `,_jsx(_components.a,{href:`/bank-statements`,children:`Customizing bank statement references`}),` article for details.`]})]}),_jsxs(ParamField,{body:`Culture`,type:`string`,id:`param-culture`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` One of the supported languages in the `,_jsx(_components.a,{href:`/api-reference/overview/data-formats`,children:`ISO 639-1 format`}),`: DE, EN, ES, FR, IT, NL, PL, PT.`]}),_jsx(_components.p,{children:`The language in which the payment page is to be displayed.`})]}),_jsxs(ParamField,{body:`BrowserInfo`,type:`object`,id:`param-browser-info`,children:[_jsx(_components.p,{children:`Information about the browser used by the end user (author) to perform the payment.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`AcceptHeader`,type:`string`,id:`param-accept-header`,children:_jsx(_components.p,{children:`The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.`})}),_jsx(ParamField,{body:`JavaEnabled`,type:`boolean`,id:`param-java-enabled`,children:_jsx(_components.p,{children:`Whether or not the end user’s browser has the ability to execute Java.`})}),_jsxs(ParamField,{body:`Language`,type:`string`,id:`param-language`,children:[_jsxs(_components.p,{children:[`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: `,_jsx(_components.code,{children:`en-US`}),`; pattern:`,_jsx(_components.code,{children:`^[a-zA-Z]{2}(-[a-zA-Z]{2})?$`}),`)`]}),_jsx(_components.p,{children:`The language of the browser.`})]}),_jsx(ParamField,{body:`ColorDepth`,type:`integer`,id:`param-color-depth`,children:_jsx(_components.p,{children:`The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.`})}),_jsxs(ParamField,{body:`ScreenHeight`,type:`integer`,id:`param-screen-height`,children:[_jsx(_components.p,{children:`Max. length: 6 characters`}),_jsx(_components.p,{children:`The height of the screen in pixels.`})]}),_jsxs(ParamField,{body:`ScreenWidth`,type:`integer`,id:`param-screen-width`,children:[_jsx(_components.p,{children:`Max. length: 6 characters`}),_jsx(_components.p,{children:`The width of the screen in pixels.`})]}),_jsx(ParamField,{body:`TimeZoneOffset`,type:`integer`,id:`param-time-zone-offset`,children:_jsx(_components.p,{children:`The difference in minutes between the browser’s timezone and UTC.`})}),_jsxs(ParamField,{body:`UserAgent`,type:`string`,id:`param-user-agent`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The exact content of the HTTP User-Agent header.`})]}),_jsx(ParamField,{body:`JavascriptEnabled`,type:`boolean`,id:`param-javascript-enabled`,children:_jsx(_components.p,{children:`Whether or not the end user’s browser has the ability to execute JavaScript.`})})]})]}),_jsx(ParamField,{body:`IpAddress`,type:`string`,id:`param-ip-address`,children:_jsx(_components.p,{children:`The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.`})}),_jsxs(ParamField,{body:`Billing`,type:`object`,id:`param-billing`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Default value:`}),` FirstName, LastName, and Address information of the Shipping object if any, otherwise the user (author).`]}),_jsx(_components.p,{children:`Information about the end user billing address. If left empty, the default values will be automatically taken into account.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`FirstName`,type:`string`,id:`param-first-name`,children:_jsx(_components.p,{children:`The first name of the user.`})}),_jsxs(ParamField,{body:`LastName`,type:`string`,id:`param-last-name`,children:[_jsx(_components.p,{children:`Max. length: 100 characters`}),_jsx(_components.p,{children:`The last name of the user.`})]}),_jsxs(ParamField,{body:`Address`,type:`object`,id:`param-address`,children:[_jsx(_components.p,{children:`Information about the billing address.`}),_jsxs(Expandable,{children:[_jsxs(ParamField,{body:`AddressLine1`,type:`string`,id:`param-address-line1`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The first line of the address.`})]}),_jsxs(ParamField,{body:`AddressLine2`,type:`string`,id:`param-address-line2`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The second line of the address.`})]}),_jsxs(ParamField,{body:`City`,type:`string`,id:`param-city`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The city of the address.`})]}),_jsxs(ParamField,{body:`Region`,type:`string`,id:`param-region`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsxs(_components.p,{children:[`Required if `,_jsx(_components.code,{children:`Country`}),` is US, CA, or MX.`]}),_jsx(_components.p,{children:`The region of the address.`})]}),_jsxs(ParamField,{body:`PostalCode`,type:`string`,id:`param-postal-code`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.`})]}),_jsxs(ParamField,{body:`Country`,type:`string`,id:`param-country`,children:[_jsxs(_components.p,{children:[`Format: Two-letter country code (`,_jsx(_components.a,{href:`/api-reference/overview/data-formats`,children:`ISO 3166-1 alpha-2 format`}),`)`]}),_jsx(_components.p,{children:`The country of the address.`})]})]})]})]})]}),_jsxs(ParamField,{body:`Shipping`,type:`object`,id:`param-shipping`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Default value:`}),` FirstName, LastName, and Address information of the Billing object, if supplied, otherwise of the user (author).`]}),_jsx(_components.p,{children:`Information about the end user’s shipping address.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`FirstName`,type:`string`,id:`param-first-name-1`,children:_jsx(_components.p,{children:`The first name of the user.`})}),_jsxs(ParamField,{body:`LastName`,type:`string`,id:`param-last-name-1`,children:[_jsx(_components.p,{children:`Max. length: 100 characters`}),_jsx(_components.p,{children:`The last name of the user.`})]}),_jsxs(ParamField,{body:`Address`,type:`object`,id:`param-address-1`,children:[_jsx(_components.p,{children:`Information about the shipping address.`}),_jsxs(Expandable,{children:[_jsxs(ParamField,{body:`AddressLine1`,type:`string`,id:`param-address-line1-1`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The first line of the address.`})]}),_jsxs(ParamField,{body:`AddressLine2`,type:`string`,id:`param-address-line2-1`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The second line of the address.`})]}),_jsxs(ParamField,{body:`City`,type:`string`,id:`param-city-1`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The city of the address.`})]}),_jsxs(ParamField,{body:`Region`,type:`string`,id:`param-region-1`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsxs(_components.p,{children:[`Required if `,_jsx(_components.code,{children:`Country`}),` is US, CA, or MX.`]}),_jsx(_components.p,{children:`The region of the address.`})]}),_jsxs(ParamField,{body:`PostalCode`,type:`string`,id:`param-postal-code-1`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.`})]}),_jsxs(ParamField,{body:`Country`,type:`string`,id:`param-country-1`,children:[_jsxs(_components.p,{children:[`Format: Two-letter country code (`,_jsx(_components.a,{href:`/api-reference/overview/data-formats`,children:`ISO 3166-1 alpha-2 format`}),`)`]}),_jsx(_components.p,{children:`The country of the address.`})]})]})]})]})]}),_jsxs(ParamField,{body:`Requested3DSVersion`,type:`string`,id:`param-requested3-ds-version`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`V1`}),`, `,_jsx(_components.code,{children:`V2_1`})]}),_jsx(_components.p,{children:`The 3DS protocol version to be applied to the transaction.`})]}),_jsxs(ParamField,{body:`Applied3DSVersion`,type:`string`,id:`param-applied3-ds-version`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`V1`}),`, `,_jsx(_components.code,{children:`V2_1`})]}),_jsx(_components.p,{children:`The 3DS protocol version applied to the transaction.`})]}),_jsxs(ParamField,{body:`Tag`,type:`string`,id:`param-tag`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`Custom data that you can add to this object.`})]}),_jsxs(ParamField,{body:`CardInfo`,type:`string`,id:`param-card-info`,children:[_jsxs(_components.p,{children:[`Information about the card used for the transaction.\\xA0`,_jsx(_components.br,{}),`\n`,`If the information or data is not available, `,_jsx(_components.code,{children:`null`}),` is returned.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`BIN`,type:`string`,id:`param-bin`,children:_jsx(_components.p,{children:`The 6-digit bank identification number (BIN) of the card issuer.`})}),_jsx(ParamField,{body:`IssuingBank`,type:`string`,id:`param-issuing-bank`,children:_jsx(_components.p,{children:`The name of the card issuer.`})}),_jsxs(ParamField,{body:`IssuerCountryCode`,type:`string`,id:`param-issuer-country-code`,children:[_jsxs(_components.p,{children:[`Format: Two-letter country code (`,_jsx(_components.a,{href:`/api-reference/overview/data-formats`,children:`ISO 3166-1 alpha-2 format`}),`)`]}),_jsx(_components.p,{children:`The country where the card was issued.`})]}),_jsxs(ParamField,{body:`Type`,type:`string`,id:`param-type`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`DEBIT`}),`, `,_jsx(_components.code,{children:`CREDIT`}),`, `,_jsx(_components.code,{children:`CHARGE CARD`}),`.`]}),_jsx(_components.p,{children:`The type of card product.`})]}),_jsxs(ParamField,{body:`Brand`,type:`string`,id:`param-brand`,children:[_jsxs(_components.p,{children:[`The card brand. Examples include: `,_jsx(_components.code,{children:`AMERICAN EXPRESS`}),`, `,_jsx(_components.code,{children:`DISCOVER`}),`, `,_jsx(_components.code,{children:`JCB`}),`, `,_jsx(_components.code,{children:`MASTERCARD`}),`, `,_jsx(_components.code,{children:`VISA`}),`, etc.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Note:`}),` The possible returned values are numerous and liable to evolve over time.`]})]}),_jsxs(ParamField,{body:`SubType`,type:`string`,id:`param-sub-type`,children:[_jsxs(_components.p,{children:[`The subtype of the card product. Examples include: `,_jsx(_components.code,{children:`CLASSIC`}),`, `,_jsx(_components.code,{children:`GOLD`}),`, `,_jsx(_components.code,{children:`PLATINUM`}),`, `,_jsx(_components.code,{children:`PREPAID`}),`, etc.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Note:`}),` The possible returned values are numerous and liable to evolve over time.`]})]})]})]}),_jsxs(ResponseField,{name:`AuthenticationResult`,type:`object | null`,defaultOpen:true,id:`param-authentication-result`,children:[_jsx(_components.p,{children:`Information about the authentication result, based on the request made by Mangopay and the decision of the issuer regarding the type of authentication to be enforced (if applicable).`}),_jsx(Expandable,{title:`properties`,children:_jsxs(ResponseField,{name:`AuthenticationType`,type:`string | null`,id:`param-authentication-type`,children:[_jsxs(_components.p,{children:[`Response values: `,_jsx(_components.code,{children:`CHALLENGE`}),`, `,_jsx(_components.code,{children:`FRICTIONLESS`}),`, `,_jsx(_components.code,{children:`DIRECT_AUTHORIZATION`})]}),_jsx(_components.p,{children:`The type of authentication:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`CHALLENGE`}),` – The issuer requested SCA to be enforced (for example, using 3DS).`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`FRICTIONLESS`}),` – The transaction was exempted from SCA because an exemption was granted by the issuer.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`DIRECT_AUTHORIZATION`}),` – The transaction was sent to the issuer for authorization without any frictionless or challenge (for example, if SCA doesn’t apply).`]}),`\n`]}),_jsxs(_components.p,{children:[`A `,_jsx(_components.code,{children:`null`}),` value typically indicates that authentication was not requested (for example, because the request failed before being sent) or a decision was not received.`]})]})})]}),_jsxs(ParamField,{body:`ProfilingAttemptReference`,type:`string`,id:`param-profiling-attempt-reference`,children:[_jsxs(_components.p,{children:[`The unique reference generated for the profiling session, used by the `,_jsx(_components.a,{href:`/guides/fraud-prevention`,children:`fraud prevention`}),` solution to produce recommendations for the transaction using the profiling data.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Note:`}),` Parameter not returned by the API. Profiling feature available on request – contact Mangopay `,_jsx(`a`,{href:`https://hub.mangopay.com/`,target:`_blank`,children:`via the Dashboard`}),` for more information.`]})]})]}),_jsxs(Tab,{title:`PayPal`,id:`paypal`,children:[_jsx(ResponseField,{name:`PaypalPayerID`,type:`string`,id:`param-paypal-payer-id`,children:_jsx(_components.p,{children:`The PayPal identifier of the buyer.`})}),_jsx(ResponseField,{name:`BuyerLastname`,type:`string`,id:`param-buyer-lastname`,children:_jsx(_components.p,{children:`The last name of the buyer.`})}),_jsx(ResponseField,{name:`BuyerPhone`,type:`string`,id:`param-buyer-phone`,children:_jsx(_components.p,{children:`The mobile phone number of the buyer.`})}),_jsx(ResponseField,{name:`BuyerFirstname`,type:`string`,id:`param-buyer-firstname`,children:_jsx(_components.p,{children:`The first name of the buyer.`})}),_jsx(ResponseField,{name:`BuyerCountry`,type:`string`,id:`param-buyer-country`,children:_jsx(_components.p,{children:`The country of the buyer.`})}),_jsx(ResponseField,{name:`PaypalOrderID`,type:`string`,id:`param-paypal-order-id`,children:_jsx(_components.p,{children:`PayPal’s unique identifier for the order.`})}),_jsx(ResponseField,{name:`CancelURL`,type:`string`,id:`param-cancel-url`,children:_jsx(_components.p,{children:`The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the RedirectURL.`})}),_jsxs(ResponseField,{name:`Trackings`,type:`array (object)`,id:`param-trackings`,children:[_jsxs(_components.p,{children:[`Shipping information of the `,_jsx(_components.code,{children:`LineItems`}),` added to the pay-in object.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`TrackingNumber`,type:`string`,id:`param-tracking-number`,children:_jsx(_components.p,{children:`The shipment’s tracking number provided by the carrier.`})}),_jsx(ResponseField,{name:`Carrier`,type:`string`,id:`param-carrier`,children:_jsx(_components.p,{children:`The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version.`})}),_jsxs(ResponseField,{name:`NotifyBuyer`,type:`string`,id:`param-notify-buyer`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Default value:`}),` false`]}),_jsxs(_components.p,{children:[`If `,_jsx(_components.code,{children:`true`}),`, sends an email notification to the `,_jsx(_components.code,{children:`PaypalBuyerAccountEmail`}),` containing the `,_jsx(_components.code,{children:`TrackingNumber`}),` and `,_jsx(_components.code,{children:`Carrier`}),`, which allows the end user to track their shipment with the carrier.`]})]})]})]}),_jsxs(ResponseField,{name:`ShippingPreference`,type:`string`,id:`param-shipping-preference`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`SET_PROVIDED_ADDRESS`}),`, `,_jsx(_components.code,{children:`GET_FROM_FILE`}),`, `,_jsx(_components.code,{children:`NO_SHIPPING`})]}),_jsx(_components.p,{children:`Information about the shipping address behavior on the PayPal payment page:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`SET_PROVIDED_ADDRESS`}),` - The `,_jsx(_components.code,{children:`Shipping`}),` parameter becomes required and its values are displayed to the end user, who is not able to modify them.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`GET_FROM_FILE`}),` – The `,_jsx(_components.code,{children:`Shipping`}),` parameter is ignored and the end user can choose from registered addresses.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`NO_SHIPPING`}),` – No shipping address section is displayed.`]}),`\n`]})]}),_jsxs(ResponseField,{name:`Reference`,type:`string`,id:`param-reference`,children:[_jsx(_components.p,{children:`Max. length: 127 characters (truncated after)`}),_jsx(_components.p,{children:`The platform’s order reference for the transaction.`})]}),_jsx(ResponseField,{name:`PaypalBuyerAccountEmail`,type:`string`,id:`param-paypal-buyer-account-email`,children:_jsx(_components.p,{children:`The email address registered on the PayPal account used to make the payment.`})}),_jsxs(ResponseField,{name:`Culture`,type:`string`,id:`param-culture-1`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` One of the supported languages in the `,_jsx(_components.a,{href:`/api-reference/overview/data-formats`,children:`ISO 639-1 format`}),`: AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.`]}),_jsx(_components.p,{children:`The language in which the PayPal payment page is to be displayed.`})]}),_jsxs(ResponseField,{name:`LineItems`,type:`array`,id:`param-line-items`,children:[_jsx(_components.p,{children:`object`}),_jsxs(_components.p,{children:[`Information about the items purchased in the transaction. The total of all line items’ `,_jsx(_components.code,{children:`UnitAmount`}),` and `,_jsx(_components.code,{children:`TaxAmount`}),` must equal the `,_jsx(_components.code,{children:`DebitedFunds`}),` amount (negative amounts not allowed).`]}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`Name`,type:`string`,id:`param-name`,children:[_jsx(_components.p,{children:`Max. length: 127 characters (truncated after)`}),_jsx(_components.p,{children:`The name of the item.`})]}),_jsx(ResponseField,{name:`Quantity`,type:`integer`,id:`param-quantity`,children:_jsx(_components.p,{children:`The quantity of the item.`})}),_jsx(ResponseField,{name:`UnitAmount`,type:`integer`,id:`param-unit-amount`,children:_jsx(_components.p,{children:`The cost of the item, excluding tax.`})}),_jsx(ResponseField,{name:`TaxAmount`,type:`integer`,id:`param-tax-amount`,children:_jsx(_components.p,{children:`The tax amount applied to the item.`})}),_jsxs(ResponseField,{name:`Description`,type:`string`,id:`param-description`,children:[_jsx(_components.p,{children:`Max. length: 127 characters (truncated after)`}),_jsxs(_components.p,{children:[`The platform’s unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `,_jsx(_components.code,{children:`UserId`}),` or the seller’s business name or first name and last name.`,_jsx(_components.br,{}),`\n`,`Caution: Failure to use a unique seller identifier may result in PayPal restricting your service.`]})]}),_jsxs(ResponseField,{name:`Category`,type:`string`,id:`param-category`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Allowed values:`}),` PHYSICAL_GOODS, DIGITAL_GOODS, DONATION`]}),_jsx(_components.p,{children:`The category of the item:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`PHYSICAL_GOODS`}),` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`DIGITAL_GOODS`}),` – Products or services that are distributed and consumed via digital platforms or devices.\\xA0`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`DONATION`}),` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `,_jsx(_components.code,{children:`DONATION`}),` within a single transaction, however it is not possible to combine `,_jsx(_components.code,{children:`DONATION`}),` other line item categories within the same transaction.`]}),`\n`]})]})]})]}),_jsxs(ResponseField,{name:`Shipping`,type:`object`,id:`param-shipping-1`,children:[_jsxs(_components.p,{children:[`Information about the end user’s shipping address, managed by `,_jsx(_components.code,{children:`ShippingPreference`}),`.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`FirstName`,type:`string`,id:`param-first-name-2`,children:_jsx(_components.p,{children:`The first name of the user.`})}),_jsxs(ResponseField,{name:`LastName`,type:`string`,id:`param-last-name-2`,children:[_jsx(_components.p,{children:`Max. length: 100 characters`}),_jsx(_components.p,{children:`The last name of the user.`})]}),_jsxs(ResponseField,{name:`Address`,type:`object`,id:`param-address-2`,children:[_jsx(_components.p,{children:`Information about the shipping address.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`AddressLine1`,type:`string`,id:`param-address-line1-2`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The first line of the address.`})]}),_jsxs(ResponseField,{name:`AddressLine2`,type:`string`,id:`param-address-line2-2`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The second line of the address.`})]}),_jsxs(ResponseField,{name:`City`,type:`string`,id:`param-city-2`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The city of the address.`})]}),_jsxs(ResponseField,{name:`Region`,type:`string`,id:`param-region-2`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsxs(_components.p,{children:[`The region of the address. This field is optional except if the `,_jsx(_components.code,{children:`Country`}),` is US, CA, or MX.`]})]}),_jsxs(ResponseField,{name:`PostalCode`,type:`string`,id:`param-postal-code-2`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.`})]}),_jsxs(ResponseField,{name:`Country`,type:`string`,id:`param-country-2`,children:[_jsxs(_components.p,{children:[`Format: Two-letter country code (`,_jsx(_components.a,{href:`/api-reference/overview/data-formats`,children:`ISO 3166-1 alpha-2 format`}),`)`]}),_jsx(_components.p,{children:`The country of the address.`})]})]})]})]})]}),_jsx(ResponseField,{name:`Billing`,type:`object`,null:true,id:`param-billing-1`,children:_jsxs(_components.p,{children:[`Returned `,_jsx(_components.code,{children:`null`}),` because the billing address is not applicable to PayPal preauth.`]})}),_jsxs(ResponseField,{name:`StatementDescriptor`,type:`string`,id:`param-statement-descriptor-1`,children:[_jsx(_components.p,{children:`Max. length: 10 characters; only alphanumeric and spaces`}),_jsxs(_components.p,{children:[`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 `,_jsx(_components.a,{href:`/bank-statements`,children:`Customizing bank statement references`}),` article for details.`]})]}),_jsxs(ResponseField,{name:`RedirectURL`,type:`string`,id:`param-redirect-url`,children:[_jsx(_components.p,{children:`The URL to which to redirect the user to complete the payment.`}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Caution:`}),` This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.`]})]}),_jsxs(ResponseField,{name:`ReturnURL`,type:`string`,id:`param-return-url`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The URL to which the user is returned after the payment, whether the transaction is successful or not.`})]}),_jsxs(ResponseField,{name:`ExecutionType`,type:`string`,id:`param-execution-type-1`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`WEB`}),`, `,_jsx(_components.code,{children:`DIRECT`}),`, `,_jsx(_components.code,{children:`EXTERNAL_INSTRUCTION`})]}),_jsx(_components.p,{children:`The type of execution for the pay-in.`})]}),_jsxs(ResponseField,{name:`PaymentType`,type:`string`,id:`param-payment-type-1`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`PAYPAL`})]}),_jsx(_components.p,{children:`The type of pay-in.`})]}),_jsxs(ResponseField,{name:`Status`,type:`string`,id:`param-status-1`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`CREATED`}),`, `,_jsx(_components.code,{children:`SUCCEEDED`}),`, `,_jsx(_components.code,{children:`FAILED`})]}),_jsx(_components.p,{children:`The status of the transaction.`})]}),_jsxs(ResponseField,{name:`Tag`,type:`string`,id:`param-tag-1`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsxs(_components.p,{children:[`Custom data that you can add to this object.`,_jsx(_components.br,{}),`\n`,`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.`]})]}),_jsx(ResponseField,{name:`ResultMessage`,type:`string`,id:`param-result-message-1`,children:_jsx(_components.p,{children:`The explanation of the result code.`})}),_jsx(ResponseField,{name:`ResultCode`,type:`string`,id:`param-result-code-1`,children:_jsxs(_components.p,{children:[`The code indicating the result of the operation. This information is mostly used to `,_jsx(_components.a,{href:`/errors/codes`,children:`handle errors`}),` or for filtering purposes.`]})}),_jsxs(ResponseField,{name:`PayinsLinked`,type:`object`,id:`param-payins-linked-1`,children:[_jsx(_components.p,{children:`Information about the deposit preauthorized pay-ins made against the deposit preauthorization.`}),_jsxs(Expandable,{children:[_jsx(ResponseField,{name:`PayinCaptureId`,type:`string`,id:`param-payin-capture-id-1`,children:_jsx(_components.p,{children:`The unique identifier of the preauthorized pay-in (capture) made against the deposit preauthorization to debit the preauthorized funds.`})}),_jsx(ResponseField,{name:`PayinComplementId`,type:`string`,deprecated:true,id:`param-payin-complement-id-1`,children:_jsxs(_components.p,{children:[`This deprecated parameter is always returned `,_jsx(_components.code,{children:`null`}),`.`]})})]})]}),_jsxs(ResponseField,{name:`PaymentStatus`,type:`string`,id:`param-payment-status-1`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`WAITING`}),`, `,_jsx(_components.code,{children:`CANCELED`}),`, `,_jsx(_components.code,{children:`CANCEL_REQUESTED`}),`, `,_jsx(_components.code,{children:`EXPIRED`}),`, `,_jsx(_components.code,{children:`VALIDATED`}),`, `,_jsx(_components.code,{children:`FAILED`})]}),_jsx(_components.p,{children:`The payment status of the deposit preauthorization object:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`WAITING`}),` – The deposit preauthorization can be used: the preauthorized funds can be captured (if `,_jsx(_components.code,{children:`Status`}),` is `,_jsx(_components.code,{children:`SUCCEEDED`}),`) or the preauthorization can be canceled manually.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`CANCELED`}),` – Value to pass to manually cancel the deposit preauthorization before use; indicates that the deposit preauthorization was canceled manually.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`CANCEL_REQUESTED`}),` – The cancellation of the deposit preauthorization has been requested but not yet processed.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`EXPIRED`}),` – The hold period on the preauthorized funds has ended without it being used.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`VALIDATED`}),` – Indicates that the preauthorized funds were captured.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`FAILED`}),` – The pay-in against the preauthorization has failed, but a retry may be possible.`]}),`\n`]})]}),_jsxs(ResponseField,{name:`Status`,type:`string`,id:`param-status-2`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` `,_jsx(_components.code,{children:`CREATED`}),`, `,_jsx(_components.code,{children:`SUCCEEDED`}),`, `,_jsx(_components.code,{children:`FAILED`})]}),_jsx(_components.p,{children:`The status of the authorization.`})]}),_jsx(ResponseField,{name:`AuthorId`,type:`string`,id:`param-author-id-1`,children:_jsx(_components.p,{children:`The unique identifier of the user at the source of the transaction.`})}),_jsxs(ResponseField,{name:`DebitedFunds`,type:`object`,id:`param-debited-funds-1`,children:[_jsx(_components.p,{children:`Information about the preauthorized funds.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`Currency`,type:`string`,id:`param-currency-1`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Returned values:`}),` The three-letter `,_jsx(_components.a,{href:`/api-reference/overview/data-formats`,target:`_blank`,children:`ISO 4217 code`}),` (EUR, GBP, etc.) of a `,_jsx(_components.a,{href:`/guides/currencies`,target:`_blank`,children:`supported currency`}),` (depends on feature, contract, and activation settings).`]}),_jsx(_components.p,{children:`The currency of the funds.`})]}),_jsx(ResponseField,{name:`Amount`,type:`integer`,id:`param-amount-1`,children:_jsxs(_components.p,{children:[`An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `,_jsx(_components.code,{children:`1260`}),` whereas JPY 12 would be represented as just `,_jsx(_components.code,{children:`12`}),`).`]})})]})]}),_jsx(ResponseField,{name:`ExpirationDate`,type:`Unix timestamp`,id:`param-expiration-date-1`,children:_jsxs(_components.p,{children:[`The date and time at which the hold period ends and the preauthorized funds are released.`,_jsx(_components.br,{}),`\n`,`At the expiration date, the deposit preauthorization’s `,_jsx(_components.code,{children:`PaymentStatus`}),` changes to `,_jsx(_components.code,{children:`EXPIRED`}),` if no captures were made.`]})}),_jsx(ResponseField,{name:`CreationDate`,type:`Unix timestamp`,id:`param-creation-date-1`,children:_jsx(_components.p,{children:`The date and time at which the object was created.`})}),_jsxs(ResponseField,{name:`Id`,type:`string`,id:`param-id-1`,children:[_jsx(_components.p,{children:`Max. length: 255 characters`}),_jsx(_components.p,{children:`The unique identifier of the PayPal preauthorization.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`related-resources`,children:`Related resources`}),`\n`,_jsx(Card,{title:`Guide`,href:`/guides/payment-methods/card/deposit-preauthorization`,children:_jsx(_components.p,{children:`Learn more about 30-day preauthorization`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"The Deposit Preauthorization object","description":null,"href":"/api-reference/deposit-preauthorizations/deposit-preauthorization-object"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Description","slug":"description","depth":3,"children":[]},{"title":"Attributes","slug":"attributes","depth":3,"children":[]},{"title":"Related resources","slug":"related-resources","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/mangopay/bbdec5e85a0c0aa0/script.js"],"subdomain":"mangopay","siteName":"Mangopay docs","title":"The Deposit Preauthorization object - Mangopay docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-17T15:36:00.818Z","originalFileLocation":"api-reference/deposit-preauthorizations/deposit-preauthorization-object.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Mangopay docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mangopay/56CZuSSE4eb-08HU/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/mangopay/56CZuSSE4eb-08HU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mangopay/56CZuSSE4eb-08HU/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mangopay/56CZuSSE4eb-08HU/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mangopay/56CZuSSE4eb-08HU/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mangopay/56CZuSSE4eb-08HU/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mangopay/56CZuSSE4eb-08HU/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mangopay/56CZuSSE4eb-08HU/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mangopay/56CZuSSE4eb-08HU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"The Deposit Preauthorization object - Mangopay docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Mangopay docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorization-object\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mangopay.mintlify.site/images/seo_og_image_blank.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"The Deposit Preauthorization object - Mangopay docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mangopay.mintlify.site/images/seo_og_image_blank.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/mangopay/56CZuSSE4eb-08HU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Mangopay docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00000E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorization-object\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/deposit-preauthorizations/deposit-preauthorization-object.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.mangopay.com/#organization\",\"name\":\"Mangopay docs\",\"url\":\"https://docs.mangopay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mangopay/EHwmKiFob2p48DHF/logo/mgp-light.svg?fit=max\u0026auto=format\u0026n=EHwmKiFob2p48DHF\u0026q=85\u0026s=f2bf5f88a1d39831377b5952b46b031c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.mangopay.com#website\",\"name\":\"Mangopay docs\",\"url\":\"https://docs.mangopay.com\",\"publisher\":{\"@id\":\"https://docs.mangopay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorization-object#webpage\",\"url\":\"https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorization-object\",\"name\":\"The Deposit Preauthorization object\",\"dateModified\":\"2026-06-17T15:36:00.818Z\",\"isPartOf\":{\"@id\":\"https://docs.mangopay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorization-object#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorization-object#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Card pay-ins\",\"item\":\"https://docs.mangopay.com/api-reference/direct-card-payins/direct-card-payin-object\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"The Deposit Preauthorization object\",\"item\":\"https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorization-object\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorization-object#article\",\"headline\":\"The Deposit Preauthorization object\",\"name\":\"The Deposit Preauthorization object\",\"url\":\"https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorization-object\",\"mainEntityOfPage\":{\"@id\":\"https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorization-object#webpage\"},\"image\":\"https://docs.mangopay.com/images/seo_og_image_blank.png\",\"dateModified\":\"2026-06-17T15:36:00.818Z\",\"publisher\":{\"@id\":\"https://docs.mangopay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.mangopay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Mangopay docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Mangopay docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/deposit-preauthorizations/deposit-preauthorization-object.md","siteName":"Mangopay docs","nav":{"global":null,"tabs":[{"tab":"Integration","pages":[{"title":"Integration","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/e-wallet-system"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"Introduction","mode":"wide","href":"/api-reference/overview/introduction"},{"group":"API keys","pages":[{"title":"Managing API keys","sidebarTitle":"Management","href":"/api-reference/overview/api-keys"},{"title":"Permission scopes","sidebarTitle":"Scopes","href":"/api-reference/overview/api-keys/scopes"}]},{"group":"Authentication","pages":[{"title":"Authentication","sidebarTitle":"Overview","href":"/api-reference/overview/authentication"},{"api":"POST /v2.01/oauth/token","title":"Create OAuth bearer token","href":"/api-reference/overview/authentication/create-oauth-token"},{"api":"POST /v2.01/oauth/token/embedded/recipient","title":"Create an access token for the Recipients embedded experience","href":"/api-reference/overview/authentication/create-access-token-recipient"},{"api":"POST /v2.01/oauth/token/embedded/recipient","title":"Create an access token for Checkout SDK features","href":"/api-reference/overview/authentication/create-access-token-checkout"}]},{"title":"Rate limiting","href":"/api-reference/overview/rate-limiting"},{"title":"Filtering and sorting","href":"/api-reference/overview/filtering-sorting"},{"title":"Pagination","href":"/api-reference/overview/pagination"},{"title":"Idempotency","href":"/api-reference/overview/idempotency"},{"title":"Data formats","href":"/api-reference/overview/data-formats"},{"title":"Data availability periods","href":"/api-reference/overview/data-availability-periods"}]},{"group":"User management","pages":[{"group":"Users","pages":[{"title":"The Natural User object (SCA)","href":"/api-reference/users/natural-user-object-sca"},{"title":"Create a Natural User (SCA)","api":"POST /v2.01/{ClientId}/sca/users/natural","href":"/api-reference/users/create-natural-user-sca"},{"title":"Update a Natural User (SCA)","api":"PUT /v2.01/{ClientId}/sca/users/natural/{UserId}","href":"/api-reference/users/update-natural-user-sca"},{"title":"Categorize a Natural User","api":"PUT /v2.01/{ClientId}/sca/users/natural/{UserId}/category","href":"/api-reference/users/categorize-natural-user"},{"title":"The Legal User object (SCA)","href":"/api-reference/users/legal-user-object-sca"},{"title":"Create a Legal User (SCA)","api":"POST /v2.01/{ClientId}/sca/users/legal","href":"/api-reference/users/create-legal-user-sca"},{"title":"Update a Legal User (SCA)","api":"PUT /v2.01/{ClientId}/sca/users/legal/{UserId}","href":"/api-reference/users/update-legal-user-sca"},{"title":"Categorize a Legal User","api":"PUT /v2.01/{ClientId}/sca/users/legal/{UserId}/category","href":"/api-reference/users/categorize-legal-user"},{"title":"Enroll a User in SCA","api":"POST /v2.01/{ClientId}/sca/users/{UserId}/enrollment","href":"/api-reference/users/enroll-user"},{"title":"Manage proxy consent for a User","api":"POST /v2.01/{ClientId}/sca/users/{UserId}/consent","href":"/api-reference/users/manage-proxy-consent"},{"title":"View the SCA status of a User","api":"GET /v2.01/{ClientId}/sca/users/{UserId}/sca-status","href":"/api-reference/users/view-user-sca-status"},{"title":"View a User (SCA)","api":"GET /v2.01/{ClientId}/sca/users/{UserId}","href":"/api-reference/users/view-user-sca"},{"title":"List all Users","api":"GET /v2.01/{ClientId}/users","href":"/api-reference/users/list-users"},{"title":"Close a Natural User","api":"DELETE /v2.01/{ClientId}/users/natural/{UserId}","href":"/api-reference/users/close-natural-user"},{"title":"Close a Legal User","api":"DELETE /v2.01/{ClientId}/users/legal/{UserId}","href":"/api-reference/users/close-legal-user"},{"group":"Non-SCA endpoints","tag":"DEPRECATED","pages":[{"title":"The Natural User object","mode":"wide","tag":"DEPRECATED","href":"/api-reference/users/natural-user-object"},{"title":"Create a Natural User","api":"POST /v2.01/{ClientId}/users/natural","tag":"DEPRECATED","href":"/api-reference/users/create-natural-user"},{"title":"Update a Natural User","api":"PUT /v2.01/{ClientId}/users/natural/{UserId}","tag":"DEPRECATED","href":"/api-reference/users/update-natural-user"},{"title":"The Legal User object","tag":"DEPRECATED","href":"/api-reference/users/legal-user-object"},{"title":"Create a Legal User","api":"POST /v2.01/{ClientId}/users/legal","tag":"DEPRECATED","href":"/api-reference/users/create-legal-user"},{"title":"Update a Legal User","api":"PUT /v2.01/{ClientId}/users/legal/{UserId}","tag":"DEPRECATED","href":"/api-reference/users/update-legal-user"},{"title":"View a User","api":"GET /v2.01/{ClientId}/users/{UserId}","tag":"DEPRECATED","href":"/api-reference/users/view-user"}]}]},{"group":"User regulatory status","pages":[{"title":"The User Regulatory Status object","href":"/api-reference/user-regulatory-status/user-regulatory-status-object"},{"title":"View a User Regulatory Status","api":"GET /v2.01/{ClientId}/users/{UserId}/regulatory","href":"/api-reference/user-regulatory-status/view-user-regulatory-status"}]},{"group":"User e-money","pages":[{"title":"The User EMoney object","href":"/api-reference/user-emoney/user-emoney-object"},{"title":"View User EMoney","api":"GET /v2.01/{ClientId}/users/{UserId}/emoney/{Year}/{Month}","href":"/api-reference/user-emoney/view-user-emoney"}]}]},{"group":"User verification","pages":[{"group":"IDV sessions","pages":[{"title":"The IDV Session object","href":"/api-reference/idv-sessions/idv-session-object"},{"title":"Create an IDV Session","api":"POST /v2.01/{ClientId}/users/{UserId}/identity-verifications","href":"/api-reference/idv-sessions/create-idv-session"},{"title":"View an IDV Session","api":"GET /v2.01/{ClientId}/identity-verifications/{IdvSessionId}","href":"/api-reference/idv-sessions/view-idv-session"},{"title":"List IDV Sessions for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/identity-verifications","href":"/api-reference/idv-sessions/list-idv-sessions-user"}]},{"group":"User data format","pages":[{"title":"The User Data Format object","href":"/api-reference/user-data-format/user-data-format-object"},{"title":"Validate the format of User data","api":"POST /v2.01/{ClientId}/users/data-formats/validation","href":"/api-reference/user-data-format/validate-user-data-format"}]},{"group":"KYC documents","pages":[{"title":"The KYC Document object","href":"/api-reference/kyc-documents/kyc-document-object"},{"title":"Create a KYC Document","api":"POST /v2.01/{ClientId}/users/{UserId}/kyc/documents","href":"/api-reference/kyc-documents/create-kyc-document"},{"title":"Create a KYC Document Page","api":"POST /v2.01/{ClientId}/users/{UserId}/kyc/documents/{KycDocumentId}/pages","href":"/api-reference/kyc-documents/create-kyc-document-page"},{"title":"Submit a KYC Document","api":"PUT /v2.01/{ClientId}/users/{UserId}/kyc/documents/{KycDocumentId}","href":"/api-reference/kyc-documents/submit-kyc-document"},{"title":"View a KYC Document","api":"GET /v2.01/{ClientId}/kyc/documents/{KycDocumentId}","href":"/api-reference/kyc-documents/view-kyc-document"},{"title":"List KYC Documents for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/kyc/documents","href":"/api-reference/kyc-documents/list-kyc-documents-user"},{"title":"List all KYC Documents","api":"GET /v2.01/{ClientId}/kyc/documents","href":"/api-reference/kyc-documents/list-kyc-documents"}]},{"group":"UBO declarations","pages":[{"title":"The UBO Declaration object","href":"/api-reference/ubo-declarations/ubo-declaration-object"},{"title":"Create a UBO Declaration","api":"POST /v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations","href":"/api-reference/ubo-declarations/create-ubo-declaration"},{"title":"The UBO object","href":"/api-reference/ubo-declarations/ubo-object"},{"title":"Create a UBO","api":"POST /v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations/{UboDeclarationId}/ubos","href":"/api-reference/ubo-declarations/create-ubo"},{"title":"Submit a UBO Declaration","api":"PUT /v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations/{UboDeclarationId}","href":"/api-reference/ubo-declarations/submit-ubo-declaration"},{"title":"Update a UBO","api":"PUT /v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations/{UboDeclarationId}/ubos/{UboId}","href":"/api-reference/ubo-declarations/update-ubo"},{"title":"View a UBO Declaration","api":"GET /v2.01/{ClientId}/kyc/ubodeclarations/{UboDeclarationId}","href":"/api-reference/ubo-declarations/view-ubo-declaration"},{"title":"View a UBO","api":"GET /v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations/{UboDeclarationId}/ubos/{UboId}","href":"/api-reference/ubo-declarations/view-ubo"},{"title":"List UBO Declarations for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations","href":"/api-reference/ubo-declarations/list-ubo-declarations-user"}]}]},{"group":"Wallets","pages":[{"group":"User wallets","pages":[{"title":"The Wallet object","href":"/api-reference/wallets/wallet-object"},{"title":"Create a Wallet","api":"POST /v2.01/{ClientId}/wallets","href":"/api-reference/wallets/create-wallet"},{"title":"Update a Wallet","api":"PUT /v2.01/{ClientId}/wallets/{WalletId}","href":"/api-reference/wallets/update-wallet"},{"title":"View a Wallet","api":"GET /v2.01/{ClientId}/wallets/{WalletId}","href":"/api-reference/wallets/view-wallet"},{"title":"List Wallets for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/wallets","href":"/api-reference/wallets/list-wallets-user"}]},{"group":"Client wallets","pages":[{"title":"The Client Wallet object","href":"/api-reference/client-wallets/client-wallet-object"},{"title":"View a Client Wallet","api":"GET /v2.01/{ClientId}/clients/wallets/{FundsType}/{Currency}","href":"/api-reference/client-wallets/view-client-wallet"},{"title":"List all Client Wallets","api":"GET /v2.01/{ClientId}/clients/wallets","href":"/api-reference/client-wallets/list-client-wallets"},{"title":"List Client Wallets by FundsType","api":"GET /v2.01/{ClientId}/clients/wallets/{FundsType}","href":"/api-reference/client-wallets/list-client-wallets-fundstype"}]}]},{"group":"Cards","pages":[{"group":"Card registrations","pages":[{"title":"The Card Registration object","href":"/api-reference/card-registrations/card-registration-object"},{"title":"Create a Card Registration","api":"POST /v2.01/{ClientId}/cardregistrations","href":"/api-reference/card-registrations/create-card-registration"},{"title":"Tokenize the card","api":"POST {CardRegistrationURL}","href":"/api-reference/card-registrations/tokenize-card"},{"title":"Update a Card Registration","api":"PUT /v2.01/{ClientId}/cardregistrations/{CardRegistrationId}","href":"/api-reference/card-registrations/update-card-registration"},{"title":"View a Card Registration","api":"GET /v2.01/{ClientId}/cardregistrations/{CardRegistrationId}","href":"/api-reference/card-registrations/view-card-registration"}]},{"group":"Cards","pages":[{"title":"The Card object","href":"/api-reference/cards/card-object"},{"title":"Deactivate or edit a Card","api":"PUT /v2.01/{ClientId}/cards/{CardId}","href":"/api-reference/cards/deactivate-edit-card"},{"title":"View a Card","api":"GET /v2.01/{ClientId}/cards/{CardId}","href":"/api-reference/cards/view-card"},{"title":"List Cards for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/cards","href":"/api-reference/cards/list-cards-user"},{"title":"List Cards for a Fingerprint","api":"GET /v2.01/{ClientId}/cards/fingerprints/{Fingerprint}","href":"/api-reference/cards/list-cards-fingerprint"}]},{"group":"Metadata","pages":[{"title":"The Payment Method Metadata object","href":"/api-reference/payment-method-metadata/payment-method-metadata-object"},{"title":"Look up metadata for a payment method","api":"POST /v2.01/{ClientId}/payment-methods/metadata","href":"/api-reference/payment-method-metadata/lookup-payment-method-metadata"}]},{"group":"Card validations","pages":[{"title":"The Card Validation object","href":"/api-reference/card-validations/card-validation-object"},{"title":"Create a Card Validation","api":"POST /V2.01/{ClientId}/cards/{CardId}/validation","href":"/api-reference/card-validations/create-card-validation"},{"title":"View a Card Validation","api":"GET /V2.01/{ClientId}/cards/{CardId}/validation/{ValidationId}","href":"/api-reference/card-validations/view-card-validation"}]}]},{"group":"Card pay-ins","pages":[{"group":"Direct card pay-ins","pages":[{"title":"The Direct Card PayIn object","href":"/api-reference/direct-card-payins/direct-card-payin-object"},{"title":"Create a Direct Card PayIn","api":"POST /v2.01/{ClientId}/payins/card/direct","href":"/api-reference/direct-card-payins/create-direct-card-payin"},{"title":"View a PayIn (Direct Card)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/direct-card-payins/view-payin-direct-card"}]},{"group":"Recurring card pay-ins","pages":[{"title":"The Recurring PayIn Registration object","href":"/api-reference/recurring-payin-registrations/recurring-payin-registration-object"},{"title":"Create a Recurring PayIn Registration (Card)","api":"POST /v2.01/{ClientId}/recurringpayinregistrations","href":"/api-reference/recurring-payin-registrations/create-recurring-payin-registration"},{"title":"Update a Recurring PayIn Registration","api":"PUT /v2.01/{ClientId}/recurringpayinregistrations/{RecurringPayinRegistrationId}","href":"/api-reference/recurring-payin-registrations/update-recurring-payin-registration"},{"title":"View a Recurring PayIn Registration","api":"GET /v2.01/{ClientId}/recurringpayinregistrations/{RecurringPayinRegistrationId}","href":"/api-reference/recurring-payin-registrations/view-recurring-payin-registration"},{"title":"The Recurring PayIn object","href":"/api-reference/recurring-card-payins/recurring-payin-object"},{"title":"Create a Recurring PayIn (CIT)","api":"POST /v2.01/{ClientId}/payins/recurring/card/direct","href":"/api-reference/recurring-card-payins/create-recurring-payin-cit"},{"title":"Create a Recurring PayIn (MIT)","api":"POST /v2.01/{ClientId}/payins/recurring/card/direct","href":"/api-reference/recurring-card-payins/create-recurring-payin-mit"},{"title":"View a PayIn (Recurring Card)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/recurring-card-payins/view-payin-recurring"}]},{"group":"Preauthorizations","pages":[{"title":"The Preauthorization object","href":"/api-reference/preauthorizations/preauthorization-object"},{"title":"Create a Preauthorization","api":"POST /v2.01/{ClientId}/preauthorizations/card/direct","href":"/api-reference/preauthorizations/create-preauthorization"},{"title":"Cancel or validate a Preauthorization","api":"PUT /v2.01/{ClientId}/preauthorizations/{PreauthorizationId}","href":"/api-reference/preauthorizations/cancel-validate-preauthorization"},{"title":"View a Preauthorization","api":"GET /v2.01/{ClientId}/preauthorizations/{PreauthorizationId}/","href":"/api-reference/preauthorizations/view-preauthorization"},{"title":"List Preauthorizations for a Card","api":"GET /v2.01/{ClientId}/cards/{CardId}/preauthorizations","href":"/api-reference/preauthorizations/list-preauthorizations-card"},{"title":"List Preauthorizations for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/preauthorizations","href":"/api-reference/preauthorizations/list-preauthorizations-user"},{"title":"The Preauthorized PayIn object","href":"/api-reference/preauthorizations/preauthorized-payin-object"},{"title":"Create a Preauthorized PayIn","api":"POST /v2.01/{ClientId}/payins/preauthorized/direct","href":"/api-reference/preauthorizations/create-preauthorized-payin"},{"title":"View a PayIn (Preauthorized Card)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","description":null,"href":"/api-reference/preauthorizations/view-payin-preauthorized"}]},{"group":"Deposit preauthorizations","pages":[{"title":"The Deposit Preauthorization object","href":"/api-reference/deposit-preauthorizations/deposit-preauthorization-object"},{"title":"Create deposit preauthorization","href":"/api-reference/deposit-preauthorizations/create-deposit-preauthorization"},{"title":"Cancel a Deposit Preauthorization","api":"PUT /v2.01/{ClientId}/deposit-preauthorizations/{DepositId}","href":"/api-reference/deposit-preauthorizations/cancel-deposit-preauthorization"},{"title":"View a Deposit Preauthorization (Card, PayPal)","api":"GET /v2.01/{ClientId}/deposit-preauthorizations/{DepositId}","href":"/api-reference/deposit-preauthorizations/view-deposit-preauthorization"},{"title":"List Deposit Preauthorizations for a Card","api":"GET /v2.01/{ClientId}/cards/{CardId}/deposit-preauthorizations","href":"/api-reference/deposit-preauthorizations/list-deposit-preauthorizations-card"},{"title":"List Deposit Preauthorizations for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/deposit-preauthorizations","href":"/api-reference/deposit-preauthorizations/list-deposit-preauthorizations-user"},{"title":"The Deposit Preauthorized PayIn object","href":"/api-reference/deposit-preauthorizations/deposit-preauthorized-payin-object"},{"title":"Create a Deposit Preauthorized PayIn","api":"POST /v2.01/{ClientId}/payins/deposit-preauthorized/direct/full-capture","href":"/api-reference/deposit-preauthorizations/create-deposit-preauthorized-payin"},{"title":"View a PayIn (Deposit Preauthorized Card)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/deposit-preauthorizations/view-payin-deposit-preauthorized"}]},{"group":"Web card pay-ins","pages":[{"title":"The Web Card PayIn object","href":"/api-reference/web-card-payins/web-card-payin-object"},{"title":"Create a Web Card PayIn","api":"POST /v2.01/{ClientId}/payins/card/web","href":"/api-reference/web-card-payins/create-web-card-payin"},{"title":"View a PayIn (Web Card)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/web-card-payins/view-payin-web-card"},{"title":"The Extended Web Card PayIn object","href":"/api-reference/web-card-payins/extended-web-card-payin-object"},{"title":"View card details for a Web Card PayIn","api":"GET /v2.01/{ClientId}/payins/card/web/{PayInId}/extended","href":"/api-reference/web-card-payins/view-card-details-web-card-payin"}]}]},{"group":"Banking pay-ins","pages":[{"group":"Bank wires","pages":[{"title":"The Bank Wire PayIn object","href":"/api-reference/bank-wire-payins/bank-wire-payin-object"},{"title":"Create a Bank Wire PayIn","api":"POST /v2.01/{ClientId}/payins/bankwire/direct/","href":"/api-reference/bank-wire-payins/create-bank-wire-payin"},{"title":"View a PayIn (Bank Wire)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/bank-wire-payins/view-payin-bank-wire"}]},{"group":"Pay by bank","pages":[{"title":"The Pay by Bank PayIn object","href":"/api-reference/pay-by-bank/pay-by-bank-payin-object"},{"title":"View supported banks for Pay by Bank","api":"GET /v2.01/{ClientId}/payment-methods/openbanking/metadata/supported-banks","href":"/api-reference/pay-by-bank/view-supported-banks-pay-by-bank"},{"title":"Create a Pay by Bank PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/openbanking","href":"/api-reference/pay-by-bank/create-pay-by-bank-payin"},{"title":"View a PayIn (Pay by Bank)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/pay-by-bank/view-payin-pay-by-bank"}]},{"group":"Virtual IBAN","pages":[{"title":"The Virtual Account object","href":"/api-reference/virtual-accounts/virtual-account-object"},{"title":"View Virtual Account availabilities","api":"GET /v2.01/{ClientId}/virtual-accounts/availability","href":"/api-reference/virtual-accounts/view-virtual-account-availabilities"},{"title":"Create a Virtual Account","api":"POST /v2.01/{ClientId}/wallets/{WalletId}/virtual-accounts","href":"/api-reference/virtual-accounts/create-virtual-account"},{"title":"Deactivate a Virtual Account","api":"PUT /v2.01/{ClientId}/wallets/{WalletId}/virtual-accounts/{VirtualAccountId}","href":"/api-reference/virtual-accounts/deactivate-virtual-account"},{"title":"View a Virtual Account","api":"GET /v2.01/{ClientId}/wallets/{WalletId}/virtual-accounts/{VirtualAccountId}","href":"/api-reference/virtual-accounts/view-virtual-account"},{"title":"List Virtual Accounts for a Wallet","api":"GET /v2.01/{ClientId}/wallets/{WalletId}/virtual-accounts","href":"/api-reference/virtual-accounts/list-virtual-accounts-wallet"},{"group":"Banking alias","pages":[{"title":"The Banking Alias object","tag":"DEPRECATED","href":"/api-reference/banking-aliases/banking-alias-object"},{"title":"Create an IBAN Banking Alias","api":"POST /v2.01/{ClientId}/wallets/{WalletId}/bankingaliases/iban","tag":"DEPRECATED","href":"/api-reference/banking-aliases/create-iban-banking-alias"},{"title":"Deactivate a Banking Alias","api":"PUT /v2.01/{ClientId}/bankingaliases/{BankingAliasId}","tag":"DEPRECATED","href":"/api-reference/banking-aliases/deactivate-banking-alias"},{"title":"View a Banking Alias","api":"GET /v2.01/{ClientId}/bankingaliases/{BankingAliasId}","tag":"DEPRECATED","href":"/api-reference/banking-aliases/view-banking-alias"},{"title":"View a Banking Alias for a Wallet","api":"GET /v2.01/{ClientId}/wallets/{WalletId}/bankingaliases","tag":"DEPRECATED","href":"/api-reference/banking-aliases/view-banking-alias-wallet"}]},{"title":"The External Instruction Bank Wire PayIn object","href":"/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object"},{"title":"View a PayIn (External Instruction)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/virtual-accounts/view-payin-external-instruction"}]},{"group":"Direct debits","pages":[{"title":"The Mandate object","href":"/api-reference/mandates/mandate-object"},{"title":"Create a Mandate","api":"POST /v2.01/{ClientId}/mandates/directdebit/web","href":"/api-reference/mandates/create-mandate"},{"title":"Cancel a Mandate","api":"PUT /v2.01/{ClientId}/mandates/{MandateId}/cancel","href":"/api-reference/mandates/cancel-mandate"},{"title":"View a Mandate","api":"GET /v2.01/{ClientId}/mandates/{MandateId}","href":"/api-reference/mandates/view-mandate"},{"title":"List all Mandates","api":"GET /v2.01/{ClientId}/mandates","href":"/api-reference/mandates/list-mandates"},{"title":"List Mandates for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/mandates","href":"/api-reference/mandates/list-mandates-user"},{"title":"List Mandates for a Bank Account","api":"GET /v2.01/{ClientId}/users/{UserId}/bankaccounts/{BankAccountId}/mandates","href":"/api-reference/mandates/list-mandates-bank-account"},{"title":"The Direct Debit PayIn object","href":"/api-reference/direct-debit-payins/direct-debit-payin-object"},{"title":"Create a Direct Debit PayIn","api":"POST /v2.01/{ClientId}/payins/directdebit/direct","href":"/api-reference/direct-debit-payins/create-direct-debit-payin"},{"title":"View a PayIn (Direct Debit)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/direct-debit-payins/view-payin-direct-debit"}]},{"group":"Web direct debits","pages":[{"title":"[Deprecated] The Web Direct-Debit PayIn object","href":"/api-reference/web-direct-debit-payins/web-direct-debit-payin-object"},{"title":"[Deprecated] Create a Web Direct-Debit PayIn","api":"POST /v2.01/{ClientId}/payins/directdebit/web","href":"/api-reference/web-direct-debit-payins/create-web-direct-debit-payin"},{"title":"View a PayIn","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/web-direct-debit-payins/view-payin-web-direct-debit"}]}]},{"group":"APM pay-ins","pages":[{"group":"Apple Pay","pages":[{"title":"The Apple Pay PayIn object","href":"/api-reference/apple-pay/apple-pay-payin-object"},{"title":"Create an Apple Pay PayIn","api":"POST /v2.01/{ClientId}/payins/applepay/direct","href":"/api-reference/apple-pay/create-apple-pay-payin"},{"title":"View a PayIn (Apple Pay)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/apple-pay/view-payin-apple-pay"}]},{"group":"Bancontact","pages":[{"title":"The Bancontact PayIn object","href":"/api-reference/bancontact/bancontact-payin-object"},{"title":"Create a Bancontact PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/bancontact","href":"/api-reference/bancontact/create-bancontact-payin"},{"title":"View a PayIn (Bancontact)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/bancontact/view-payin-bancontact"}]},{"group":"Bizum","pages":[{"title":"The Bizum PayIn object","href":"/api-reference/bizum/bizum-payin-object"},{"title":"Create a Bizum PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/bizum","href":"/api-reference/bizum/create-bizum-payin"},{"title":"View a PayIn (Bizum)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/bizum/view-payin-bizum"}]},{"group":"BLIK","pages":[{"title":"The BLIK PayIn object","href":"/api-reference/blik/blik-payin-object"},{"title":"Create a BLIK PayIn (with code)","api":"POST /v2.01/{ClientId}/payins/payment-methods/blik","href":"/api-reference/blik/create-blik-payin-with-code"},{"title":"Create a BLIK PayIn (without code)","api":"POST /v2.01/{ClientId}/payins/payment-methods/blik","href":"/api-reference/blik/create-blik-payin-without-code"},{"title":"View a PayIn (BLIK)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/blik/view-payin-blik"}]},{"group":"Giropay","pages":[{"title":"[Deprecated] The Giropay PayIn object","href":"/api-reference/giropay/giropay-payin-object"},{"title":"[Deprecated] Create a Giropay PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/giropay","href":"/api-reference/giropay/create-giropay-payin"},{"title":"View a PayIn (Giropay)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/giropay/view-payin-giropay"}]},{"group":"Google Pay","pages":[{"title":"The Google Pay PayIn object","href":"/api-reference/google-pay/google-pay-payin-object"},{"title":"Create a Google Pay PayIn","api":"POST /V2.01/{ClientId}/payins/payment-methods/googlepay","href":"/api-reference/google-pay/create-google-pay-payin"},{"title":"View a PayIn (Google Pay)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/google-pay/view-payin-google-pay"}]},{"group":"iDEAL","pages":[{"title":"The iDEAL PayIn object","href":"/api-reference/ideal/ideal-payin-object"},{"title":"Create an iDEAL PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/ideal","href":"/api-reference/ideal/create-ideal-payin"},{"title":"View a PayIn (iDEAL)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/ideal/view-payin-ideal"},{"title":"[Deprecated] Create a Web Card PayIn (iDEAL)","api":"POST /v2.01/{ClientId}/payins/card/web","href":"/api-reference/ideal/create-web-card-payin-ideal"}]},{"group":"Klarna","pages":[{"title":"The Klarna PayIn object","href":"/api-reference/klarna/klarna-payin-object"},{"title":"Create a Klarna PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/klarna","href":"/api-reference/klarna/create-klarna-payin"},{"title":"View a PayIn (Klarna)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/klarna/view-payin-klarna"}]},{"group":"MB WAY","pages":[{"title":"The MB WAY PayIn object","href":"/api-reference/mb-way/mb-way-payin-object"},{"title":"Create an MB WAY PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/mbway","href":"/api-reference/mb-way/create-mb-way-payin"},{"title":"View a PayIn (MB WAY)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/mb-way/view-payin-mb-way"}]},{"group":"Multibanco","pages":[{"title":"The Multibanco PayIn object","href":"/api-reference/multibanco/multibanco-payin-object"},{"title":"Create an Multibanco PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/multibanco","href":"/api-reference/multibanco/create-multibanco-payin"},{"title":"View a PayIn (Multibanco)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/multibanco/view-payin-multibanco"}]},{"group":"Payconiq","pages":[{"title":"The Payconiq PayIn object","tag":"DEPRECATED","href":"/api-reference/payconiq/payconiq-payin-object"},{"title":"Create a Payconiq PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/payconiq","tag":"DEPRECATED","href":"/api-reference/payconiq/create-payconiq-payin"},{"title":"View a PayIn (Payconiq)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","tag":"DEPRECATED","href":"/api-reference/payconiq/view-payin-payconiq"}]},{"group":"PayPal","pages":[{"title":"Submit data for a PayPal PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/paypal/data-collection","href":"/api-reference/paypal/submit-data-paypal-payin"},{"title":"View data submitted for a PayPal PayIn","api":"GET /v2.01/{ClientId}/payins/payment-methods/paypal/data-collection/{DataCollectionId}","href":"/api-reference/paypal/view-data-paypal-payin"},{"group":"One-time payment","pages":[{"title":"The PayPal PayIn object","href":"/api-reference/paypal/paypal-payin-object"},{"title":"Create a PayPal PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/paypal","href":"/api-reference/paypal/create-paypal-payin"},{"title":"[Deprecated] Create a PayPal PayIn","api":"POST /v2.01/{ClientId}/payins/paypal/web","href":"/api-reference/paypal/create-paypal-payin-web"}]},{"group":"Recurring payments","pages":[{"title":"The Recurring PayIn Registration object (PayPal)","href":"/api-reference/recurring-payin-registrations/recurring-payin-registration-object-paypal"},{"title":"Create a Recurring PayIn Registration (PayPal)","api":"POST /v2.01/{ClientId}/recurringpayinregistrations","href":"/api-reference/recurring-payin-registrations/create-recurring-payin-registration-paypal"},{"title":"Update a Recurring PayIn Registration (PayPal)","api":"PUT /v2.01/{ClientId}/recurringpayinregistrations/{RecurringPayinRegistrationId}","href":"/api-reference/recurring-payin-registrations/update-recurring-payin-registration-paypal"},{"title":"View a Recurring PayIn Registration (PayPal)","api":"GET /v2.01/{ClientId}/recurringpayinregistrations/{RecurringPayinRegistrationId}","href":"/api-reference/recurring-payin-registrations/view-recurring-payin-registration-paypal"},{"title":"The Recurring PayPal PayIn object","href":"/api-reference/paypal/recurring-paypal-payin-object"},{"title":"Create a Recurring PayPal PayIn (CIT)","api":"POST /v2.01/{ClientId}/payins/payment-methods/paypal/recurring","href":"/api-reference/paypal/create-recurring-paypal-payin-cit"},{"title":"Create a Recurring PayPal PayIn (MIT)","api":"POST /v2.01/{ClientId}/payins/payment-methods/paypal/recurring","href":"/api-reference/paypal/create-recurring-paypal-payin-mit"}]},{"group":"Preauthorized payments","pages":[{"title":"Create a PayPal Deposit Preauthorization","api":"POST /v2.01/{ClientId}/deposit-preauthorizations/payment-methods/paypal","href":"/api-reference/deposit-preauthorizations/create-paypal-deposit-preauthorization"}]},{"title":"View a PayIn (PayPal)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/paypal/view-payin-paypal"},{"title":"Add tracking information to a PayPal PayIn","api":"PUT /v2.01/{ClientId}/payins/{PayInId}/trackings","href":"/api-reference/paypal/add-tracking-paypal-payin"}]},{"group":"Satispay","pages":[{"title":"The Satispay PayIn object","href":"/api-reference/satispay/satispay-payin-object"},{"title":"Create a Satispay PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/satispay","href":"/api-reference/satispay/create-satispay-payin"},{"title":"View a PayIn (Satispay)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/satispay/view-payin-satispay"}]},{"group":"Swish","pages":[{"title":"The Swish PayIn object","href":"/api-reference/swish/swish-payin-object"},{"title":"Create a Swish PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/swish","href":"/api-reference/swish/create-swish-payin"},{"title":"View a PayIn (Swish)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/swish/view-payin-swish"}]},{"group":"TWINT","pages":[{"title":"The TWINT PayIn object","href":"/api-reference/twint/twint-payin-object"},{"title":"Create a TWINT PayIn","api":"POST /v2.01/{ClientId}/payins/payment-methods/twint","href":"/api-reference/twint/create-twint-payin"},{"title":"View a PayIn (TWINT)","api":"GET /v2.01/{ClientId}/payins/{PayInId}","href":"/api-reference/twint/view-payin-twint"}]}]},{"group":"Transfers","pages":[{"group":"Transfers","pages":[{"title":"The Transfer object","href":"/api-reference/transfers/transfer-object"},{"title":"Create a Transfer","api":"POST /v2.01/{ClientId}/transfers","href":"/api-reference/transfers/create-transfer"},{"title":"View a Transfer","api":"GET /v2.01/{ClientId}/transfers/{TransferId}","href":"/api-reference/transfers/view-transfer"}]}]},{"group":"Refunds","pages":[{"group":"Refunds","pages":[{"title":"The Refund object","href":"/api-reference/refunds/refund-object"},{"title":"Create a Refund for a PayIn","api":"POST /v2.01/{ClientId}/payins/{PayInId}/refunds","href":"/api-reference/refunds/create-refund-payin"},{"title":"Create a Refund for a Transfer","api":"POST /v2.01/{ClientId}/transfers/{TransferId}/refunds","href":"/api-reference/refunds/create-refund-transfer"},{"title":"View a Refund","api":"GET /v2.01/{ClientId}/refunds/{RefundId}","href":"/api-reference/refunds/view-refund"},{"title":"List Refunds for a PayIn","api":"GET /v2.01/{ClientId}/payins/{PayInId}/refunds","href":"/api-reference/refunds/list-refunds-payin"},{"title":"List Refunds for a Transfer","api":"GET /v2.01/{ClientId}/transfers/{TransferId}/refunds","href":"/api-reference/refunds/list-refunds-transfer"},{"title":"List Refunds for a Payout","api":"GET /v2.01/{ClientId}/payouts/{PayoutId}/refunds","href":"/api-reference/refunds/list-refunds-payout"},{"title":"List Refunds for a Repudiation","api":"GET /v2.01/{ClientId}/repudiations/{RepudiationId}/refunds","href":"/api-reference/refunds/list-refunds-repudiation"}]}]},{"group":"Disputes","pages":[{"group":"Disputes","pages":[{"title":"The Dispute object","href":"/api-reference/disputes/dispute-object"},{"title":"View a Dispute","api":"GET /v2.01/{ClientId}/disputes/{DisputeId}","href":"/api-reference/disputes/view-dispute"},{"title":"Submit a Dispute","api":"PUT /v2.01/{ClientId}/disputes/{DisputeId}/submit","href":"/api-reference/disputes/submit-dispute"},{"title":"Update a Dispute","api":"PUT /v2.01/{ClientId}/disputes/{DisputeId}","href":"/api-reference/disputes/update-dispute"},{"title":"Close a Dispute","api":"PUT /v2.01/{ClientId}/disputes/{DisputeId}/close","href":"/api-reference/disputes/close-dispute"},{"title":"List all Disputes","api":"GET /v2.01/{ClientId}/disputes","href":"/api-reference/disputes/list-disputes"},{"title":"List Disputes pending settlement","api":"GET /v2.01/{ClientId}/disputes/pendingsettlement","href":"/api-reference/disputes/list-disputes-settlement"},{"title":"List Disputes for a PayIn","api":"GET /v2.01/{ClientId}/payins/{PayInId}/disputes","href":"/api-reference/disputes/list-disputes-payin"},{"title":"List Disputes for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/disputes","href":"/api-reference/disputes/list-disputes-user"},{"title":"List Disputes for a Wallet","api":"GET /v2.01/{ClientId}/wallets/{WalletId}/disputes","href":"/api-reference/disputes/list-disputes-wallet"}]},{"group":"Dispute documents","pages":[{"title":"The Dispute Document object","href":"/api-reference/dispute-documents/dispute-document-object"},{"title":"Create a Dispute Document","api":"POST /v2.01/{ClientId}/disputes/{DisputeId}/documents","href":"/api-reference/dispute-documents/create-dispute-document"},{"title":"View a Dispute Document","api":"GET /v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}","href":"/api-reference/dispute-documents/view-dispute-document"},{"title":"Submit a Dispute Document","api":"PUT /v2.01/{ClientId}/disputes/{DisputeId}/documents/{DisputeDocumentId}","href":"/api-reference/dispute-documents/submit-dispute-document"},{"title":"List all Dispute Documents","api":"GET /v2.01/{ClientId}/dispute-documents","href":"/api-reference/dispute-documents/list-dispute-documents"},{"title":"Create a Dispute Document Page","api":"POST /v2.01/{ClientId}/disputes/{DisputeId}/documents/{DisputeDocumentId}/pages","href":"/api-reference/dispute-documents/create-dispute-document-page"},{"title":"Create a weblink to view the Pages of a Dispute Document","api":"POST /v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}/consult","href":"/api-reference/dispute-documents/create-weblink-to-view-dispute-document-pages"},{"title":"List Documents for a Dispute","api":"GET /v2.01/{ClientId}/disputes/{DisputeId}/documents","href":"/api-reference/dispute-documents/list-documents-dispute"}]},{"group":"Repudiations","pages":[{"title":"The Repudiation object","href":"/api-reference/repudiations/repudiation-object"},{"title":"View a Repudiation","api":"GET /v2.01/{ClientId}/repudiations/{RepudiationId}","href":"/api-reference/repudiations/view-repudiation"}]},{"group":"Dispute settlement","pages":[{"title":"The Settlement Transfer object","href":"/api-reference/dispute-settlement/settlement-transfer-object"},{"title":"Create a Settlement Transfer","api":"POST /v2.01/{ClientId}/repudiations/{RepudiationId}/settlementtransfer","href":"/api-reference/dispute-settlement/create-settlement-transfer"},{"title":"View a Settlement Transfer","api":"GET /v2.01/{ClientId}/settlements/{SettlementId}","href":"/api-reference/dispute-settlement/view-settlement-transfer"},{"title":"Create a Bank Wire PayIn to the Repudiation Wallet","api":"POST /v2.01/{ClientId}/clients/payins/bankwire/direct/","href":"/api-reference/dispute-settlement/create-bank-wire-payin-to-repudiation-wallet"}]}]},{"group":"Payouts","pages":[{"group":"Recipients","pages":[{"title":"The Recipient object","href":"/api-reference/recipients/recipient-object"},{"title":"View payout methods","api":"GET /v2.01/{ClientId}/recipients/payout-methods","href":"/api-reference/recipients/view-payout-methods"},{"title":"View the schema for a Recipient","api":"GET /v2.01/{ClientId}/recipients/schema","href":"/api-reference/recipients/view-recipient-schema"},{"title":"Validate data for a Recipient","api":"POST /v2.01/{ClientId}/users/{UserId}/recipients/validate","href":"/api-reference/recipients/validate-recipient-data"},{"title":"Create a Recipient","api":"POST /v2.01/{ClientId}/users/{UserId}/recipients","href":"/api-reference/recipients/create-recipient"},{"title":"Deactivate a Recipient","api":"PUT /v2.01/{ClientId}/recipients/{RecipientId}","href":"/api-reference/recipients/deactivate-recipient"},{"title":"View a Recipient","api":"GET /v2.01/{ClientId}/recipients/{RecipientId}","href":"/api-reference/recipients/view-recipient"},{"title":"List Recipients for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/recipients","href":"/api-reference/recipients/list-recipients-user"}]},{"group":"Bank accounts","pages":[{"title":"The Bank Account object","href":"/api-reference/bank-accounts/bank-account-object"},{"title":"Create an IBAN Bank Account","api":"POST /v2.01/{ClientId}/users/{UserId}/bankaccounts/iban","href":"/api-reference/bank-accounts/create-iban-bank-account"},{"title":"Create a US Bank Account","api":"POST /v2.01/{ClientId}/users/{UserId}/bankaccounts/us","href":"/api-reference/bank-accounts/create-us-bank-account"},{"title":"Create a CA Bank Account","api":"POST /v2.01/{ClientId}/users/{UserId}/bankaccounts/ca","href":"/api-reference/bank-accounts/create-ca-bank-account"},{"title":"Create a GB Bank Account","api":"POST /v2.01/{ClientId}/users/{UserId}/bankaccounts/gb","href":"/api-reference/bank-accounts/create-gb-bank-account"},{"title":"Create an OTHER Bank Account","api":"POST /v2.01/{ClientId}/users/{UserId}/bankaccounts/other","href":"/api-reference/bank-accounts/create-other-bank-account"},{"title":"Deactivate a Bank Account","api":"PUT /v2.01/{ClientId}/users/{UserId}/bankaccounts/{BankAccountId}","href":"/api-reference/bank-accounts/deactivate-bank-account"},{"title":"View a Bank Account","api":"GET /v2.01/{ClientId}/users/{UserId}/bankaccounts/{BankAccountId}","href":"/api-reference/bank-accounts/view-bank-account"},{"title":"List Bank Accounts for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/bankaccounts","href":"/api-reference/bank-accounts/list-bank-accounts-user"}]},{"group":"Payouts","pages":[{"title":"The Payout object","href":"/api-reference/payouts/payout-object"},{"title":"Create a Payout","api":"POST /v2.01/{ClientId}/payouts/bankwire","href":"/api-reference/payouts/create-payout"},{"title":"Check Instant Payout eligibility","api":"POST /v2.01/{ClientId}/payouts/reachability","href":"/api-reference/payouts/check-instant-payout-eligibility"},{"title":"View a Payout","api":"GET /v2.01/{ClientId}/payouts/{PayoutId}","href":"/api-reference/payouts/view-payout"},{"title":"View a Payout and check mode applied","api":"GET /v2.01/{ClientId}/payouts/bankwire/{PayOutId}","href":"/api-reference/payouts/view-payout-check-mode-applied"}]}]},{"group":"FX conversions","pages":[{"group":"Conversion rates","pages":[{"title":"The Conversion Rate object (FX)","href":"/api-reference/conversion-rates/conversion-rate-object"},{"title":"View an indicative Conversion Rate","api":"GET /v2.01/{ClientId}/conversions/rate/{DebitedCurrency}/{CreditedCurrency}","href":"/api-reference/conversion-rates/view-conversion-rate"}]},{"group":"Quotes","pages":[{"title":"The Quote object (Guaranteed FX)","href":"/api-reference/quotes/quote-object"},{"title":"Create a Quote","api":"POST /v2.01/{ClientId}/conversions/quote","href":"/api-reference/quotes/create-quote"},{"title":"View a Quote","api":"GET /v2.01/{ClientId}/conversions/quote/{QuoteId}","href":"/api-reference/quotes/view-quote"}]},{"group":"Conversions","pages":[{"title":"The Conversion object (FX)","href":"/api-reference/conversions/conversion-object"},{"title":"Create a Quoted Conversion between user Wallets","api":"POST /v2.01/{ClientId}/conversions/quoted-conversion","href":"/api-reference/conversions/create-quoted-conversion-user-wallets"},{"title":"Create an Instant Conversion between user Wallets","api":"POST /v2.01/{ClientId}/conversions/instant-conversion","href":"/api-reference/conversions/create-instant-conversion-user-wallets"},{"title":"Create a Quoted Conversion between Client Wallets","api":"POST /v2.01/{ClientId}/clients/conversions/quoted-conversion","href":"/api-reference/conversions/create-quoted-conversion-client-wallets"},{"title":"Create an Instant Conversion between Client Wallets","api":"POST /v2.01/{ClientId}/clients/conversions/instant-conversion","href":"/api-reference/conversions/create-instant-conversion-client-wallets"},{"title":"View a Conversion","api":"GET /v2.01/{ClientId}/conversions/{ConversionId}","href":"/api-reference/conversions/view-conversion"}]}]},{"group":"Transactions","pages":[{"group":"Transactions","pages":[{"title":"The Transaction object","href":"/api-reference/transactions/transaction-object"},{"title":"List Transactions for a User","api":"GET /v2.01/{ClientId}/users/{UserId}/transactions","href":"/api-reference/transactions/list-transactions-user"},{"title":"List Transactions for a Wallet","api":"GET /v2.01/{ClientId}/wallets/{WalletId}/transactions","href":"/api-reference/transactions/list-transactions-wallet"},{"title":"List Transactions for a Client Wallet","api":"GET /v2.01/{ClientId}/clients/wallets/{FundsType}/{Currency}/transactions","href":"/api-reference/transactions/list-transactions-client-wallet"},{"title":"List Transactions for a Card","api":"GET /v2.01/{ClientId}/cards/{CardId}/transactions","href":"/api-reference/transactions/list-transactions-card"},{"title":"List Transactions for a Card Fingerprint","api":"GET /v2.01/{ClientId}/cards/fingerprints/{Fingerprint}/transactions","href":"/api-reference/transactions/list-transactions-card-fingerprint"},{"title":"List Transactions for a Preauthorization","api":"GET /v2.01/{ClientId}/preauthorizations/{PreauthorizationId}/transactions","href":"/api-reference/transactions/list-transactions-preauthorization"},{"title":"List Transactions for a Deposit Preauthorization","api":"GET /v2.01/{ClientId}/deposit-preauthorizations/{DepositId}/transactions ","href":"/api-reference/transactions/list-transactions-deposit-preauthorization"},{"title":"List Transactions for a Bank Account","api":"GET /v2.01/{ClientId}/bankaccounts/{BankAccountId}/transactions","href":"/api-reference/transactions/list-transactions-bank-account"},{"title":"List Transactions for a Mandate","api":"GET /v2.01/{ClientId}/mandates/{MandateId}/transactions","href":"/api-reference/transactions/list-transactions-mandate"},{"title":"List Transactions for a Dispute","api":"GET /v2.01/{ClientId}/disputes/{DisputeId}/transactions","href":"/api-reference/transactions/list-transactions-dispute"}]}]},{"group":"Echo","pages":[{"title":"Supported providers","sidebarTitle":"Supported PSPs","href":"/api-reference/echo/supported-providers"},{"title":"Supported payment methods","sidebarTitle":"Payment methods","href":"/api-reference/echo/supported-payment-methods"},{"group":"Intents","pages":[{"title":"The Intent object","href":"/api-reference/intents/intent-object"},{"title":"Create an Intent","api":"POST /v3.0/{ClientId}/payins/intents","href":"/api-reference/intents/create-intent"},{"title":"View an Intent","api":"GET /v3.0/{ClientId}/payins/intents/{IntentId}","href":"/api-reference/intents/view-intent"},{"title":"Cancel an Intent","api":"POST /v3.0/{ClientId}/payins/intents/{IntentId}/cancel","href":"/api-reference/intents/cancel-intent"},{"title":"Create an Intent Capture","api":"POST /v3.0/{ClientId}/payins/intents/{IntentId}/captures","href":"/api-reference/intents/create-intent-capture"},{"title":"Create an Intent Refund","api":"POST /v3.0/{ClientId}/payins/intents/{IntentId}/refunds","href":"/api-reference/intents/create-intent-refund"},{"title":"Reverse an Intent Refund","api":"POST /v3.0/{ClientId}/payins/intents/{IntentId}/refunds/{RefundId}/reverse","href":"/api-reference/intents/reverse-intent-refund"},{"title":"Create an Intent Dispute","api":"POST /v3.0/{ClientId}/payins/intents/{IntentId}/capture/{CaptureId}/disputes","href":"/api-reference/intents/create-intent-dispute"},{"title":"Update an Intent Dispute","api":"PUT /v3.0/{ClientId}/payins/intents/{IntentId}/capture/{CaptureId}/disputes/{DisputeId}/decision","href":"/api-reference/intents/update-intent-dispute"}]},{"group":"Intent splits","pages":[{"title":"Create an Intent Split","api":"POST /v3.0/{ClientId}/payins/intents/{IntentId}/splits","href":"/api-reference/intents/create-intent-split"},{"title":"Update an Intent Split","api":"PUT /v3.0/{ClientId}/payins/intents/{IntentId}/splits/{SplitId}","href":"/api-reference/intents/update-intent-split"},{"title":"Execute an Intent Split","api":"POST /v3.0/{ClientId}/payins/intents/{IntentId}/splits/{SplitId}/execute","href":"/api-reference/intents/execute-intent-split"},{"title":"Reverse an Intent Split","api":"POST /v3.0/{ClientId}/payins/intents/{IntentId}/splits/{SplitId}/reverse","href":"/api-reference/intents/reverse-intent-split"},{"title":"View an Intent Split","api":"GET /v3.0/{ClientId}/payins/intents/{IntentId}/splits/{SplitId}","href":"/api-reference/intents/view-intent-split"}]},{"group":"Settlements","pages":[{"title":"Settlement file format requirements","sidebarTitle":"Settlement file format","href":"/api-reference/settlements/settlement-file"},{"title":"The Settlement Object","href":"/api-reference/settlements/settlement-object"},{"title":"Create a Settlement and generate a secure URL for file upload","api":"POST /v3.0/{ClientId}/payins/intents/settlements","href":"/api-reference/settlements/create-settlement"},{"title":"Upload settlement file to secure URL","api":"PUT {UploadUrl}","href":"/api-reference/settlements/upload-settlement-file"},{"title":"Update a Settlement and generate a new upload URL","api":"PUT /v3.0/{ClientId}/payins/intents/settlements/{SettlementId}","href":"/api-reference/settlements/update-settlement"},{"title":"Cancel a Settlement","api":"POST /v3.0/{ClientId}/payins/intents/settlements/{SettlementId}/cancel","href":"/api-reference/settlements/cancel-settlement"},{"title":"View a Settlement","api":"GET /v3.0/{ClientId}/payins/intents/settlements/{SettlementId}","href":"/api-reference/settlements/view-settlement"},{"title":"View validation errors for a Settlement","api":"GET /v3.0/{ClientId}/payins/intents/settlements/{SettlementId}/validations","href":"/api-reference/settlements/view-settlement-validations"}]}]},{"group":"Helpers","pages":[{"group":"API responses","pages":[{"title":"The API Response object","href":"/api-reference/api-responses/api-response-object"},{"title":"View an API Response","api":"GET /v2.01/{ClientId}/responses/{IdempotencyKey}","href":"/api-reference/api-responses/view-api-response"}]},{"group":"Country authorizations","pages":[{"title":"The Country Authorizations object","href":"/api-reference/country-authorizations/country-authorizations-object"},{"title":"View Authorizations for a country","api":"GET /v2.01/countries/{CountryCode}/authorizations","href":"/api-reference/country-authorizations/view-authorizations-country"},{"title":"List Authorizations for all countries","api":"GET /v2.01/countries/authorizations","href":"/api-reference/country-authorizations/list-authorizations-countries"}]},{"group":"Webhooks","pages":[{"title":"The Hook object","href":"/api-reference/webhooks/hook-object"},{"title":"Create a Hook","api":"POST /v2.01/{ClientId}/hooks","href":"/api-reference/webhooks/create-hook"},{"title":"Update a Hook","api":"PUT /v.2.01/{ClientId}/hooks/{HookId}","href":"/api-reference/webhooks/update-hook"},{"title":"View a Hook","api":"GET /v2.01/{ClientId}/hooks/{HookId}","href":"/api-reference/webhooks/view-hook"},{"title":"List all Hooks","api":"GET /v2.01/{CliendId}/hooks","href":"/api-reference/webhooks/list-hooks"}]},{"group":"Events","pages":[{"title":"The Event object","href":"/api-reference/events/event-object"},{"title":"List all Events","api":"GET /v2.01/{ClientId}/events","href":"/api-reference/events/list-events"}]},{"group":"Reports","pages":[{"title":"The Report object","href":"/api-reference/reporting/report-object"},{"title":"Create a Report","api":"POST /v2.01/{ClientId}/reporting/reports","href":"/api-reference/reporting/create-report"},{"title":"View a Report","api":"GET /v2.01/{ClientId}/reporting/reports/{ReportingId}","href":"/api-reference/reporting/view-report"},{"title":"List all Reports","api":"GET /v2.01/{ClientId}/reporting/reports","href":"/api-reference/reporting/list-reports"},{"group":"Legacy reports","pages":[{"title":"The legacy Report object","href":"/api-reference/reports/report-object"},{"title":"Create a Transactions Report","api":"POST /v2.01/{ClientId}/reports/transactions","href":"/api-reference/reports/create-transactions-report"},{"title":"Create a Wallets Report","api":"POST /v2.01/{ClientId}/reports/wallets","href":"/api-reference/reports/create-wallets-report"},{"title":"View a Report","api":"GET /v2.01/{ClientId}/reports/{ReportId}","href":"/api-reference/reports/view-report"},{"title":"List all Reports","api":"GET /v2.01/{ClientId}/reports","href":"/api-reference/reports/list-reports"}]}]}]},{"group":"Platform account","pages":[{"group":"Client","pages":[{"title":"The Client object","href":"/api-reference/client/client-object"},{"title":"Update a Client","api":"PUT /v2.01/{ClientId}/clients","href":"/api-reference/client/update-client"},{"title":"Upload a Client logo","api":"PUT /v2.01/{ClientId}/clients/logo","href":"/api-reference/client/upload-client-logo"},{"title":"View a Client","api":"GET /v2.01/{ClientId}/clients","href":"/api-reference/client/view-client"}]}]}]}]},"basePath":"","title":"The Deposit Preauthorization object - Mangopay docs","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":[],"chunks":[]}