--- title: "Create a Deposit Preauthorized PayIn" method: POST path: "/v2.01/{ClientId}/payins/deposit-preauthorized/direct/full-capture" tags: ["depositPreauthorizations"] --- # Create a Deposit Preauthorized PayIn `POST /v2.01/{ClientId}/payins/deposit-preauthorized/direct/full-capture` This endpoint lets you capture funds against a `DepositId` that was preauthorized on a card or a PayPal account. The payment method is indicated by the `PaymentType` of the [Deposit Preauthorization](/api-reference/deposit-preauthorizations/cancel-deposit-preauthorization) object: - `CARD` – Single capture possible within 29.5 days - `PAYPAL` – Single capture recommended within 3 days, but possible up to 29 days (not 29.5) The shape of the pay-in object is the same – specific data points for card or PayPal authorizations are available via [GET View a Deposit Preauthorization](/api-reference/deposit-preauthorizations/view-deposit-preauthorization). **Best practice - For PayPal, capture funds within 3 days** 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. **Note – Disclaimer about terminology** The use of the term "deposit" in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution. ## Path parameters - `ClientId` string, required ## Headers - `Authorization` string, required ## Request body - CreateADepositPreauthorizedPayInRequest - `AuthorId` string, required — The unique identifier of the user at the source of the transaction. - `CreditedWalletId` string, required — The unique identifier of the credited wallet. - `DepositId` string, required — The unique identifier of the deposit preauthorization. - `DebitedFunds` CreateADepositPreauthorizedPayInRequestDebitedFunds, required — Information about the debited funds. - `Currency` string, required — **Allowed 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 amount. - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`. - `Fees` CreateADepositPreauthorizedPayInRequestFees, required — Information about the fees. - `Currency` string, required — **Allowed 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 amount. - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`. - `Tag` string — Max. length: 255 characters Custom data that you can add to this object. ## Response `200` Success - DepositPreauthorizedPayInResponse — A 29-day deposit preauthorized pay-in: - `PaymentType` – `PREAUTHORIZED` - `ExecutionType` – `DIRECT` - Object includes `DepositId` The payment method is determined by the Deposit Preauthorization's `PaymentType`: `CARD_DIRECT` or `PAPAY`. - `AuthorId` string — **Default values:** The `AuthorId` of the Deposit Preauthorization object. The unique identifier of the user at the source of the transaction. On the Deposit Preauthorized PayIn, this parameter returns the same value as the `AuthorId` of the Deposit Preauthorization object, regardless of the value sent. - `CreditedUserId` string — **Default value:** The `AuthorId` of the Deposit Preauthorization object. The unique identifier of the user whose wallet is credited. On the Deposit Preauthorized PayIn, this parameter returns the same value as the `AuthorId` of the Deposit Preauthorization object, regardless of the value sent. - `CreditedWalletId` string — The unique identifier of the credited wallet. - `DepositId` string — The unique identifier of the deposit preauthorization. - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. - `ResultMessage` string — The explanation of the result code. - `Status` string — **Returned values:** `CREATED`, `SUCCEEDED`, `FAILED` The status of the transaction. - `ExecutionDate` integer — Unix timestamp (UTC) of the date and time the status changed to `SUCCEEDED`, indicating that the transaction occurred. The statuses `CREATED` and `FAILED` return an `ExecutionDate` of `null`. - `Type` string — **Returned values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT` The type of the transaction. - `Nature` string — **Returned values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT` The nature of the transaction, providing more information about the context in which the transaction occurred: - `REGULAR` – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow. - `REPUDIATION` – Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback). - `REFUND` – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay). - `SETTLEMENT` – Transfer made to the repudiation wallet by the platform to settle a lost dispute. - `PaymentType` string — **Returned values:** `PREAUTHORIZED` The payment type of the pay-in. - `ExecutionType` string — **Returned values:** `DIRECT` The execution type of the pay-in. - `DebitedFunds` DepositPreauthorizedPayInResponseDebitedFunds — Information about the debited funds. - `Currency` string — **Allowed 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 amount. - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`. - `CreditedFunds` DepositPreauthorizedPayInResponseCreditedFunds — Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`). - `Currency` string — **Allowed 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 amount. - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`. - `Fees` DepositPreauthorizedPayInResponseFees — Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet). - `Currency` string — **Allowed 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 amount. - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`. - `Tag` string — Max. length: 255 characters Custom data that you can add to this object. - `AuthenticationResult` AuthenticationResult — 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). - `AuthenticationType` string, nullable — **Returned values:** `CHALLENGE`, `FRICTIONLESS`, `DIRECT_AUTHORIZATION` The 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. 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. - `StatementDescriptor` string — Max. length: 10 characters; only alphanumeric and spaces Custom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details. ## Other responses - `400` — Bad Request --- [API](https://skmtc.net/mangopay/apis/api-reference.md) · [All operations](https://skmtc.net/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mangopay/api-reference/revisions/795281070285/schema)