Skip to main content
POST
/
v2.01
/
{ClientId}
/
clients
/
payins
/
bankwire
/
direct
{
    "CreditedWalletId": "CREDIT_EUR",
    "DeclaredDebitedFunds": {
        "Currency": "EUR",
        "Amount": 1000
    }
}  

{
    "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

​
CreditedWalletId
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).
​
DeclaredDebitedFunds
object
required
Information about the declared funds to be wired by the platform to the returned bank account.

​
Responses

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
Tag
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.
​
CreationDate
Unix 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.
​
AuthorId
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.
​
CreditedUserId
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.
​
DebitedFunds
object
Information about the debited funds.
​
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
Fees
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.
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
​
ExecutionDate
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.
​
Type
string
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.
​
Nature
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.
​
CreditedWalletId
string
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).
​
DebitedWalletId
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.
​
PaymentType
string
Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
DeclaredDebitedFunds
object
Information about the declared funds to be wired by the platform to the returned bank account.
​
DeclaredFees
object
Information about the fees to be taken by the platform for this transaction (and hence transferred to the Fees Wallet).
​
WireReference
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.
​
BankAccount
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.
{
    "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
    }
}