Create a Deposit Preauthorized PayIn prior to complement

Overview

User management

Users
User regulatory status
User e-money

User verification

User data format
KYC documents
UBO declarations

Wallets

User wallets
Client wallets

Cards

Card registrations
Cards
Metadata
Card validations

Card pay-ins

Banking pay-ins

Bank wires
Virtual IBAN
Direct debits
Web direct debits

APM pay-ins

Apple Pay
Bancontact
BLIK
Giropay
Google Pay
iDEAL
Klarna
MB WAY
Multibanco
Payconiq
PayPal
Satispay
Swish
TWINT

Transfers

Transfers

Refunds

Refunds

Disputes

Disputes
Dispute documents
Repudiations
Dispute settlement

Payouts

Bank accounts
Payouts

FX conversions

Conversion rates
Quotes
Conversions

Transactions

Transactions

Helpers

API responses
Country authorizations
Webhooks
Events
Reports

Platform account

Client
Dashboard permissions

POST

v2.01

{ClientId}

payins

deposit-preauthorized

direct

capture-with-complement

This endpoint allows you to capture the preauthorized funds without closing the preauthorization deposit object. It can be used prior to capturing additional funds with the Create a Deposit Preauthorized PayIn complement endpoint.

Note – Pay-in prior to complement must be full capture

The pay-in requested on this endpoint (prior to complement) must be a full capture of the preauthorized amount - it can’t be partial.

Body parameters

AuthorId

string

required

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

CreditedWalletId

string

required

The unique identifier of the credited wallet.

DebitedFunds

object

required

Information about the debited funds.

Fees

object

required

Information about the fees.

DepositId

string

required

The unique identifier of the deposit preauthorization.

Tag

string

Max. length: 255 characters

Custom data that you can add to this object.
For preauthorizations, you can use this parameter to identify corresponding information regarding the user or transaction on your platform.

Responses

AuthorId

string

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

CreditedUserId

string

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

The unique identifier of the user whose wallet is credited.

CreditedWalletId

string

The unique identifier of the credited wallet.

DepositId

string

The unique identifier of the deposit preauthorization.

string

The unique identifier of the object.

CreationDate

timestamp

The date and time at which the object was created.

ResultCode

string

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

ResultMessage

string

The explanation of the result code.

Status

string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ExecutionDate

timestamp

The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Type

string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Nature

string

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.

PaymentType

string

Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIRE

The type of pay-in.

ExecutionType

string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

DebitedFunds

object

Information about the debited funds.

CreditedFunds

object

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

Fees

object

Information about the fees.

Tag

string

Max. length: 255 characters

Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.

StatementDescriptor

string

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.

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "c15a0451-5f23-46b9-b6ec-74f3a74f18c6",
    "Date": 1699263395,
    "errors": {
        "DebitedFunds": "The value should be equal to 20000"
    }
}  

Was this page helpful?

Create a Deposit Preauthorized PayIn without complement Create a Deposit Preauthorized PayIn complement

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses