Create a Preauthorized PayIn

POST

/v2.01/:ClientId/payins/preauthorized/direct

POST

/v2.01/:ClientId/payins/preauthorized/direct

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payins/preauthorized/direct \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "CreditedWalletId": "204089031",
>     "DebitedFunds": {
>       "Currency": "EUR",
>       "Amount": 2000
>     },
>     "Fees": {
>       "Currency": "EUR",
>       "Amount": 200
>     },
>     "PreauthorizationId": "preauth_m_01HYG88W1QWJNNBGJJG0KQGX42"
>   }
> }'

1 {
2   "Id": "wt_8da11453-4231-4628-85c8-f8f8674b4ab8",
3   "Tag": null,
4   "CreationDate": 1771580679,
5   "ResultCode": "000000",
6   "ResultMessage": "Success",
7   "AuthorId": "user_m_01KHRMAQT1ZPVBWK2KYM6S0N7M",
8   "CreditedUserId": "user_m_01KH8RY4CGEYM6B5TA6JGKSYDJ",
9   "DebitedFunds": {
10     "Currency": "EUR",
11     "Amount": 10000
12   },
13   "CreditedFunds": {
14     "Currency": "EUR",
15     "Amount": 9000
16   },
17   "Fees": {
18     "Currency": "EUR",
19     "Amount": 1000
20   },
21   "Status": "SUCCEEDED",
22   "ExecutionDate": 1771580680,
23   "Type": "PAYIN",
24   "Nature": "REGULAR",
25   "CreditedWalletId": "wlt_m_01KH8RY6BKXD2ZT7F76XH2TS7Z",
26   "DebitedWalletId": null,
27   "PaymentType": "PREAUTHORIZED",
28   "ExecutionType": "DIRECT",
29   "PreauthorizationId": "preauth_wt_064022a9-3640-4ed1-a4bd-3488426428fa",
30   "AuthenticationResult": {
31     "AuthenticationType": "CHALLENGE"
32   }
33 }

Create a Preauthorized PayIn

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.

DebitedFundsobjectRequired

Information about the debited funds.

FeesobjectRequired

Information about the fees.

CreditedWalletIdstringRequired

The unique identifier of the credited wallet.

PreauthorizationIdstringRequired

The unique identifier of the preauthorization.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

AuthorIdstringOptional

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

CreditedUserIdstringOptional

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

Response

Success

Idstring

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

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this 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.

AuthorIdstring

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

CreditedUserIdstring

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

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

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.

CreditedWalletIdstring

The unique identifier of the credited wallet.

DebitedWalletIdstring

The unique identifier of the debited wallet.

In the case of a pay-in, this value is always null since there is no debited wallet.

PaymentTypestring

Returned values: PREAUTHORIZED

The payment type of the pay-in.

ExecutionTypestring

Returned values: DIRECT

The execution type of the pay-in.

PreauthorizationIdstring

The unique identifier of the preauthorization.

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

Errors

400

Bad Request Error