> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.mangopay.com/api-reference/preauthorizations/preauthorized-payin-object/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mangopay.com/_mcp/server.
# The Preauthorized PayIn object
### Description
The Preauthorized PayIn object represents a request to capture funds previously authorized with a Preauthorization object.
The preauthorized pay-in must be:
* Of an amount equal to or less than the preauthorized amount
* Done within 6.5 days of a successful authorization
> **Warning**
>
> **Caution – Idempotency key required for multi-capture**
>
> You must use an idempotency key if making multiple captures (available with Visa, Mastercard, CB,AMEX).
>
> Unless accompanied by an idempotency key, two pay-ins are considered as duplicate if they are made:
>
> * within 24 hours for the same amount and currency
> * with the same `CardId`
### Attributes
### Schema (`PreauthorizedPayInResponse`)
```yaml
components:
schemas:
Id:
type: string
description: >-
Max length: 128 characters (see [data
formats](/api-reference/overview/data-formats) for details)
The unique identifier of the object.
title: Id
Tag:
type: string
description: >-
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}"`.
title: Tag
CreationDate:
type: integer
description: Unix timestamp (UTC) of the date and time the object was created.
title: CreationDate
ResultCode:
type: string
description: >-
The code indicating the result of the operation. This information is
mostly used to handle errors or for
filtering purposes.
title: ResultCode
ResultMessage:
type: string
description: The explanation of the result code.
title: ResultMessage
AuthorId:
type: string
description: The unique identifier of the user at the source of the transaction.
title: AuthorId
CreditedUserId:
type: string
description: >-
**Default value:** The unique identifier of the owner of the credited
wallet.
The unique identifier of the user whose wallet is credited.
title: CreditedUserId
Currency:
type: string
description: >-
**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.
title: Currency
Amount:
type: integer
description: >-
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`.
title: Amount
PreauthorizedPayInResponseDebitedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: Information about the debited funds.
title: PreauthorizedPayInResponseDebitedFunds
PreauthorizedPayInResponseCreditedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: >-
Information about the credited funds (`CreditedFunds` = `DebitedFunds` -
`Fees`).
title: PreauthorizedPayInResponseCreditedFunds
PreauthorizedPayInResponseFees:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: >-
Information about the fees taken by the platform for this transaction
(and hence transferred to the Fees Wallet).
title: PreauthorizedPayInResponseFees
TransactionStatus:
type: string
description: |-
**Returned values:** `CREATED`, `SUCCEEDED`, `FAILED`
The status of the transaction.
title: TransactionStatus
TransactionExecutionDate:
type: integer
description: >-
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`.
title: TransactionExecutionDate
TransactionType:
type: string
description: |-
**Returned values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT`
The type of the transaction.
title: TransactionType
TransactionNature:
type: string
description: >-
**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.
title: TransactionNature
AuthenticationResult:
type: object
properties:
AuthenticationType:
type:
- string
- 'null'
description: >-
**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.
description: >-
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).
title: AuthenticationResult
PreauthorizedPayInResponse:
type: object
properties:
Id:
$ref: '#/components/schemas/Id'
Tag:
$ref: '#/components/schemas/Tag'
CreationDate:
$ref: '#/components/schemas/CreationDate'
ResultCode:
$ref: '#/components/schemas/ResultCode'
ResultMessage:
$ref: '#/components/schemas/ResultMessage'
AuthorId:
$ref: '#/components/schemas/AuthorId'
CreditedUserId:
$ref: '#/components/schemas/CreditedUserId'
DebitedFunds:
$ref: '#/components/schemas/PreauthorizedPayInResponseDebitedFunds'
description: Information about the debited funds.
CreditedFunds:
$ref: '#/components/schemas/PreauthorizedPayInResponseCreditedFunds'
description: >-
Information about the credited funds (`CreditedFunds` =
`DebitedFunds` - `Fees`).
Fees:
$ref: '#/components/schemas/PreauthorizedPayInResponseFees'
description: >-
Information about the fees taken by the platform for this
transaction (and hence transferred to the Fees Wallet).
Status:
$ref: '#/components/schemas/TransactionStatus'
ExecutionDate:
$ref: '#/components/schemas/TransactionExecutionDate'
Type:
$ref: '#/components/schemas/TransactionType'
Nature:
$ref: '#/components/schemas/TransactionNature'
CreditedWalletId:
type: string
description: The unique identifier of the credited wallet.
DebitedWalletId:
type: string
description: >-
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.
PaymentType:
type: string
description: |-
**Returned values:** `PREAUTHORIZED`
The payment type of the pay-in.
ExecutionType:
type: string
description: |-
**Returned values:** `DIRECT`
The execution type of the pay-in.
PreauthorizationId:
type: string
description: The unique identifier of the preauthorization.
AuthenticationResult:
$ref: '#/components/schemas/AuthenticationResult'
title: PreauthorizedPayInResponse
```
### Related resources
#### [How to](/guides/payment-methods/card/preauthorization/how-to)
How to process a 7-day card preauthorization