Create a Bank Wire PayIn to the Repudiation Wallet

POST

/v2.01/:ClientId/clients/payins/bankwire/direct

POST

/v2.01/:ClientId/clients/payins/bankwire/direct

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/clients/payins/bankwire/direct \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "CreditedWalletId": "CREDIT_EUR",
>     "DeclaredDebitedFunds": {
>       "Amount": 1000,
>       "Currency": "EUR"
>     }
>   }
> }'

200Successful

1 {
2   "Id": "163311508",
3   "Tag": null,
4   "CreationDate": 1677579888,
5   "ResultCode": null,
6   "ResultMessage": null,
7   "AuthorId": "ClientId",
8   "CreditedUserId": "ClientId",
9   "DebitedFunds": {
10     "Currency": "XXX",
11     "Amount": 0
12   },
13   "CreditedFunds": {
14     "Currency": "XXX",
15     "Amount": 0
16   },
17   "Fees": {
18     "Currency": "XXX",
19     "Amount": 0
20   },
21   "Status": "CREATED",
22   "ExecutionDate": null,
23   "Type": "PAYIN",
24   "Nature": "REGULAR",
25   "CreditedWalletId": "CREDIT_EUR",
26   "DebitedWalletId": null,
27   "PaymentType": "BANK_WIRE",
28   "ExecutionType": "DIRECT",
29   "DeclaredDebitedFunds": {
30     "Currency": "EUR",
31     "Amount": 1000
32   },
33   "DeclaredFees": {
34     "Currency": "EUR",
35     "Amount": 0
36   },
37   "WireReference": "MGx5nyoxdi",
38   "BankAccount": {
39     "OwnerAddress": {
40       "AddressLine1": "2 Avenue Amélie",
41       "AddressLine2": null,
42       "City": "Luxembourg",
43       "Region": null,
44       "PostalCode": "L-1125",
45       "Country": "LU"
46     },
47     "Type": "IBAN",
48     "OwnerName": "MANGOPAY SA",
49     "IBAN": "FR7630056009271234567890182",
50     "BIC": "CCFRFRPPXXX"
51   }
52 }

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.

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.

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

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

Request

This endpoint expects an object.

CreditedWalletIdstringRequired

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

DeclaredDebitedFundsobjectRequired

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

Response

Success

IdstringOptional

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateintegerOptional

Unix timestamp (UTC) of the date and time the object was created.

ResultCodestringOptional

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

ResultMessagestringOptional

The explanation of the result code.

AuthorIdstringOptional

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.

CreditedUserIdstringOptional

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.

DebitedFundsobjectOptional

Information about the debited funds.

CreditedFundsobjectOptional

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

FeesobjectOptional

Information about the fees.

StatusstringOptional

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ExecutionDateintegerOptional

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.

TypestringOptional

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

NaturestringOptional

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.

CreditedWalletIdstringOptional

DebitedWalletIdstringOptional

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.

PaymentTypestringOptional

Returned values: BANK_WIRE

The payment type of the pay-in.

ExecutionTypestringOptional

Returned values: DIRECT

The execution type of the pay-in.

DeclaredDebitedFundsobjectOptional

Information about the declared debited funds.

DeclaredFeesobjectOptional

Information about the declared fees.

WireReferencestringOptional

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.

BankAccountobjectOptional

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.