The Deposit Preauthorized PayIn object
Description
The Deposit Preauthorized PayIn object represents a request to capture funds previously authorized with a Deposit Preauthorization object.
The preauthorized pay-in must be:
- Of an amount equal to or less than the preauthorized amount
- Done within 29.5 days of a successful authorization
Attributes
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.
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.
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Unix timestamp (UTC) of the date and time the object was created.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
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.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
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.
Returned values: PREAUTHORIZED
The payment type of the pay-in.
Returned values: DIRECT
The execution type of the pay-in.
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
Max. length: 255 characters
Custom data that you can add to this object.
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).
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.