Create a Bank Wire PayIn to the Repudiation Wallet

{
    "CreditedWalletId": "CREDIT_EUR",
    "DeclaredDebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    }
}  

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.mangopay.MangoPayApi;
import com.mangopay.core.Money;
import com.mangopay.core.enumerations.CurrencyIso;
import com.mangopay.entities.ClientBankWireDirect;
import com.mangopay.entities.PayIn;

public class CreateDirectBankWirePayInToRepudiationWallet {
  public static void main(String[] args) throws Exception {
      MangoPayApi mangopay = new MangoPayApi();
      mangopay.getConfig().setClientId("your-client-id");
      mangopay.getConfig().setClientPassword("your-api-key");

      ClientBankWireDirect bankwireDirectPayIn = new ClientBankWireDirect("CREDIT_EUR", new Money(CurrencyIso.EUR, 100));

      PayIn createPayIn = mangopay.getClientApi().createBankWireDirect(bankwireDirectPayIn);

      Gson prettyPrint = new GsonBuilder().setPrettyPrinting().create();
      String prettyJson = prettyPrint.toJson(createPayIn);

      System.out.println(prettyJson);
  }
}

{
    "Id": "163311508",
    "Tag": null,
    "CreationDate": 1677579888,
    "ResultCode": null,
    "ResultMessage": null,
    "AuthorId": "ClientId",
    "CreditedUserId": "ClientId",
    "DebitedFunds": {
        "Currency": "XXX",
        "Amount": 0
    },
    "CreditedFunds": {
        "Currency": "XXX",
        "Amount": 0
    },
    "Fees": {
        "Currency": "XXX",
        "Amount": 0
    },
    "Status": "CREATED",
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "CREDIT_EUR",
    "DebitedWalletId": null,
    "PaymentType": "BANK_WIRE",
    "ExecutionType": "DIRECT",
    "DeclaredDebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "DeclaredFees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "WireReference": "MGx5nyoxdi",
    "BankAccount": {
        "OwnerAddress": {
            "AddressLine1": "2 Avenue Amélie",
            "AddressLine2": null,
            "City": "Luxembourg",
            "Region": null,
            "PostalCode": "L-1125",
            "Country": "LU"
        },
        "Type": "IBAN",
        "OwnerName": "MANGOPAY SA",
        "IBAN": "FR7630056009271234567890182",
        "BIC": "CCFRFRPPXXX"
    }
}  

POST

v2.01

{ClientId}

clients

payins

bankwire

direct

{
    "CreditedWalletId": "CREDIT_EUR",
    "DeclaredDebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    }
}  

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.mangopay.MangoPayApi;
import com.mangopay.core.Money;
import com.mangopay.core.enumerations.CurrencyIso;
import com.mangopay.entities.ClientBankWireDirect;
import com.mangopay.entities.PayIn;

public class CreateDirectBankWirePayInToRepudiationWallet {
  public static void main(String[] args) throws Exception {
      MangoPayApi mangopay = new MangoPayApi();
      mangopay.getConfig().setClientId("your-client-id");
      mangopay.getConfig().setClientPassword("your-api-key");

      ClientBankWireDirect bankwireDirectPayIn = new ClientBankWireDirect("CREDIT_EUR", new Money(CurrencyIso.EUR, 100));

      PayIn createPayIn = mangopay.getClientApi().createBankWireDirect(bankwireDirectPayIn);

      Gson prettyPrint = new GsonBuilder().setPrettyPrinting().create();
      String prettyJson = prettyPrint.toJson(createPayIn);

      System.out.println(prettyJson);
  }
}

{
    "Id": "163311508",
    "Tag": null,
    "CreationDate": 1677579888,
    "ResultCode": null,
    "ResultMessage": null,
    "AuthorId": "ClientId",
    "CreditedUserId": "ClientId",
    "DebitedFunds": {
        "Currency": "XXX",
        "Amount": 0
    },
    "CreditedFunds": {
        "Currency": "XXX",
        "Amount": 0
    },
    "Fees": {
        "Currency": "XXX",
        "Amount": 0
    },
    "Status": "CREATED",
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "CREDIT_EUR",
    "DebitedWalletId": null,
    "PaymentType": "BANK_WIRE",
    "ExecutionType": "DIRECT",
    "DeclaredDebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "DeclaredFees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "WireReference": "MGx5nyoxdi",
    "BankAccount": {
        "OwnerAddress": {
            "AddressLine1": "2 Avenue Amélie",
            "AddressLine2": null,
            "City": "Luxembourg",
            "Region": null,
            "PostalCode": "L-1125",
            "Country": "LU"
        },
        "Type": "IBAN",
        "OwnerName": "MANGOPAY SA",
        "IBAN": "FR7630056009271234567890182",
        "BIC": "CCFRFRPPXXX"
    }
}  

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.

Warning – Ensure you use the correct reference and bank accountThe 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.

Body parameters

string

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).

object

required

Information about the declared funds to be wired by the platform to the returned bank account.

Show properties

string

required

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 funds.

integer

required

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Responses

200 - Status is CREATED

string

Max length: 128 characters (see data formats for details)The unique identifier of the object.

string

Max. length: 255 charactersCustom 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.

Unix timestamp

The date and time at which the object was created.

string

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

string

The explanation of the result code.

string

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.

string

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.

object

Information about the debited funds.

Show properties

string

Returned 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 debited funds.

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

object

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

Show properties

string

Returned 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 credited funds.

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

object

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).For a direct bank wire pay-in, the Fees displays placeholder values (currency XXX and amount 0) until the Status changes to SUCCEEDED.

Show properties

string

Returned 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 fees.

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

string

Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.

Unix 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.

string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.

string

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.

string

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.

string

Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.

string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.

object

Information about the declared funds to be wired by the platform to the returned bank account.

Show properties

string

Returned 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 funds.

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

object

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

Show properties

string

Returned 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 fees.

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

string

Max. length: 255 charactersThe 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.

object

Information about the bank account to which the bank wire must be made by the end user.Caution: Do not hardcode the returned values. Mangopay may change the underlying bank details without prior notice.

Show properties

object

Information about the address of residence of the bank account owner.

Show properties

string

Max. length: 255 charactersThe first line of the address.

string

Max. length: 255 charactersThe second line of the address.

string

Max. length: 255 charactersThe city of the address.

string

Max. length: 255 charactersThe region of the address. This field is optional except if the Country is US, CA, or MX.

string

Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of the address.

string

Returned values: IBAN, US, CA, GB, OTHERThe type of the bank account.

string

Max. length: 255 charactersThe full name of the owner of the bank account.

string

The IBAN (international bank account number) for the bank account.

string

The BIC (international identifier of the bank) for the bank account.

{
    "Id": "163311508",
    "Tag": null,
    "CreationDate": 1677579888,
    "ResultCode": null,
    "ResultMessage": null,
    "AuthorId": "ClientId",
    "CreditedUserId": "ClientId",
    "DebitedFunds": {
        "Currency": "XXX",
        "Amount": 0
    },
    "CreditedFunds": {
        "Currency": "XXX",
        "Amount": 0
    },
    "Fees": {
        "Currency": "XXX",
        "Amount": 0
    },
    "Status": "CREATED",
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "CREDIT_EUR",
    "DebitedWalletId": null,
    "PaymentType": "BANK_WIRE",
    "ExecutionType": "DIRECT",
    "DeclaredDebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "DeclaredFees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "WireReference": "MGx5nyoxdi",
    "BankAccount": {
        "OwnerAddress": {
            "AddressLine1": "2 Avenue Amélie",
            "AddressLine2": null,
            "City": "Luxembourg",
            "Region": null,
            "PostalCode": "L-1125",
            "Country": "LU"
        },
        "Type": "IBAN",
        "OwnerName": "MANGOPAY SA",
        "IBAN": "FR7630056009271234567890182",
        "BIC": "CCFRFRPPXXX"
    }
}  

{
    "CreditedWalletId": "CREDIT_EUR",
    "DeclaredDebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    }
}  

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.mangopay.MangoPayApi;
import com.mangopay.core.Money;
import com.mangopay.core.enumerations.CurrencyIso;
import com.mangopay.entities.ClientBankWireDirect;
import com.mangopay.entities.PayIn;

public class CreateDirectBankWirePayInToRepudiationWallet {
  public static void main(String[] args) throws Exception {
      MangoPayApi mangopay = new MangoPayApi();
      mangopay.getConfig().setClientId("your-client-id");
      mangopay.getConfig().setClientPassword("your-api-key");

      ClientBankWireDirect bankwireDirectPayIn = new ClientBankWireDirect("CREDIT_EUR", new Money(CurrencyIso.EUR, 100));

      PayIn createPayIn = mangopay.getClientApi().createBankWireDirect(bankwireDirectPayIn);

      Gson prettyPrint = new GsonBuilder().setPrettyPrinting().create();
      String prettyJson = prettyPrint.toJson(createPayIn);

      System.out.println(prettyJson);
  }
}

View a Settlement Transfer The Recipient object

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Echo

Helpers

Platform account

Create a Bank Wire PayIn to the Repudiation Wallet

Body parameters

Responses

​Body parameters

​Responses

Body parameters

Responses