disputeSettlement

Create a Bank Wire PayIn to the Repudiation Wallet

Changed on
<Warning icon="fa-regular fa-triangle-exclamation"> **Warning – Ensure you use the correct reference and bank account**

The direct bank wire relies on independent action from the platform. You must use the WireReference and wire the funds to the bank account identified by the IBAN and BIC.
Otherwise, the crediting of your Repudiation Wallet may be delayed or unsuccessful.
</Warning>

Create a Bank Wire PayIn to the Repudiation Wallet

This endpoint allows the platform to make a Direct Bank Wire PayIn, instead of a Settlement Transfer, to their Repudiation Wallet in order to settle the negative balance due to a LOST dispute.

The object expires 1 month after creation if no funds are received.

post/v2.01/{ClientId}/clients/payins/bankwire/direct

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/clients/payins/bankwire/direct
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

Request body

CreditedWalletIdstring required

The unique identifier of the credited wallet. In the case of the direct bank wire to the Repudiation Wallet, this value has the format CREDIT_CCY where CCY is the currency of the Client Wallet to be credited (e.g., CREDIT_EUR).

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, 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}".

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 <a href="/errors/codes">handle errors</a> or for filtering purposes.

ResultMessagestring

The explanation of the result code.

AuthorIdstring

The unique identifier of the user at the source of the transaction. In the case of the direct bank wire to the Repudiation Wallet, the AuthorId is automatically set to the platform's ClientId.

CreditedUserIdstring

The unique identifier of the user whose wallet is credited. In the case of the direct bank wire to the Repudiation Wallet, the CreditedUserId is automatically set to the platform's ClientId.

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. In the case of the direct bank wire to the Repudiation Wallet, this value has the format CREDIT_CCY where CCY is the currency of the Client Wallet to be credited (e.g., CREDIT_EUR).

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: BANK_WIRE

The payment type of the pay-in.

ExecutionTypestring

Returned values: DIRECT

The execution type of the pay-in.

WireReferencestring

Max. length: 255 characters

The reference which the end user must provide when making the bank wire. The WireReference is used to reconcile the funds that arrive on the bank account with the DeclaredDebitedFunds in the Direct Bank Wire PayIn object. Caution: This reference is specific to each payment and must be retrieved dynamically.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id create_bank_wire_payin_to_repudiation_wallet removed and replaced with disputeSettlement_create_bank_wire_payin_to_repudiation_wallet