Create a Deposit Preauthorized PayIn

POST

/v2.01/:ClientId/payins/deposit-preauthorized/direct/full-capture

POST

/v2.01/:ClientId/payins/deposit-preauthorized/direct/full-capture

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payins/deposit-preauthorized/direct/full-capture \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "AuthorId": "user_m_01KHXAHEBRWSZXJY85TPPR56TK",
>     "CreditedWalletId": "wlt_m_01KHXAHH2NA3AAMPGE1SJPHJDJ",
>     "DebitedFunds": {
>       "Amount": 20000,
>       "Currency": "EUR"
>     },
>     "DepositId": "deposit_wt_073099a9-4e14-42b7-9bc7-d1978f65d8ba",
>     "Fees": {
>       "Amount": 1000,
>       "Currency": "EUR"
>     },
>     "Tag": "Created using Mangopay API Postman Collection"
>   }
> }'

1 {
2   "AuthorId": "user_m_01KHXAHEBRWSZXJY85TPPR56TK",
3   "CreditedUserId": "user_m_01KHXAHEBRWSZXJY85TPPR56TK",
4   "CreditedWalletId": "wlt_m_01KHXAHH2NA3AAMPGE1SJPHJDJ",
5   "DepositId": "deposit_wt_073099a9-4e14-42b7-9bc7-d1978f65d8ba",
6   "Id": "wt_28217024-04e1-400b-b902-15bc2cca8a82",
7   "CreationDate": 1771585285,
8   "ResultCode": "000000",
9   "ResultMessage": "Success",
10   "Status": "SUCCEEDED",
11   "ExecutionDate": 1771585286,
12   "Type": "PAYIN",
13   "Nature": "REGULAR",
14   "PaymentType": "PREAUTHORIZED",
15   "ExecutionType": "DIRECT",
16   "DebitedFunds": {
17     "Currency": "EUR",
18     "Amount": 20000
19   },
20   "CreditedFunds": {
21     "Currency": "EUR",
22     "Amount": 19000
23   },
24   "Fees": {
25     "Currency": "EUR",
26     "Amount": 1000
27   },
28   "Tag": "Created using Mangopay API Postman Collection",
29   "AuthenticationResult": {
30     "AuthenticationType": "CHALLENGE"
31   },
32   "StatementDescriptor": null
33 }

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 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.

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.

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). <Check icon="fa-regular fa-circle-check"> **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. </Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.

AuthorIdstringRequired

The unique identifier of the user at the source of the transaction.

CreditedWalletIdstringRequired

The unique identifier of the credited wallet.

DepositIdstringRequired

The unique identifier of the deposit preauthorization.

DebitedFundsobjectRequired

Information about the debited funds.

FeesobjectRequired

Information about the fees.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

Response

Success

AuthorIdstring

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.

CreditedUserIdstring

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.

CreditedWalletIdstring

The unique identifier of the credited wallet.

DepositIdstring

The unique identifier of the deposit preauthorization.

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

ResultCodestring

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestring

The explanation of the result code.

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ExecutionDateinteger

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.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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.

PaymentTypestring

Returned values: PREAUTHORIZED

The payment type of the pay-in.

ExecutionTypestring

Returned values: DIRECT

The execution type of the pay-in.

DebitedFundsobject

Information about the debited funds.

CreditedFundsobject

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Feesobject

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

AuthenticationResultobject

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).

StatementDescriptorstring

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.

Errors

400

Bad Request Error