Skip to navigation
Card pay-insPreauthorizations

Create a Preauthorized PayIn

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.

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, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

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
IdstringOptional

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

The unique identifier of the object.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

CreationDateintegerOptional

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

ResultCodestringOptional

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

ResultMessagestringOptional
The explanation of the result code.
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.

DebitedFundsobjectOptional
Information about the debited funds.
CreditedFundsobjectOptional

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

FeesobjectOptional

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

StatusstringOptional

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ExecutionDateintegerOptional

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.

TypestringOptional

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

NaturestringOptional

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.
CreditedWalletIdstringOptional
The unique identifier of the credited wallet.
DebitedWalletIdstringOptional

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.

PaymentTypestringOptional

Returned values: PREAUTHORIZED

The payment type of the pay-in.

ExecutionTypestringOptional

Returned values: DIRECT

The execution type of the pay-in.

PreauthorizationIdstringOptional
The unique identifier of the preauthorization.
AuthenticationResultobjectOptional

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