Create a Bank Wire PayIn

POST

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

POST

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

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/{ClientId}/payins/bankwire/direct \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Successful

1 {
2   "Id": "payin_m_01JFAJSSR3VW3SHX2X74C8GW82",
3   "Tag": "Created using Mangopay API Postman Collection",
4   "CreationDate": 1734448310,
5   "ResultCode": null,
6   "ResultMessage": null,
7   "AuthorId": "user_m_01JCQYJNHFPENP1SKTCBYER0F8",
8   "CreditedUserId": "user_m_01JCQYJNHFPENP1SKTCBYER0F8",
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": "wlt_m_01JFAJS7838A32W7KPJ7NNGJ1D",
26   "DebitedWalletId": null,
27   "PaymentType": "BANK_WIRE",
28   "ExecutionType": "DIRECT",
29   "DeclaredDebitedFunds": {
30     "Currency": "EUR",
31     "Amount": 62789
32   },
33   "DeclaredFees": {
34     "Currency": "EUR",
35     "Amount": 7826
36   },
37   "WireReference": "MGgq1y8jjb",
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   "TransactionDetails": []
53 }

Caution – Retrieve the returned bank details dynamically

In addition to the WireReference, ensure you implement the BankAccount object parameter dynamically so the IBAN, BIC, and other response values appear as returned in for each pay-in.

Mangopay may change the underlying bank account without prior notice and mismatched data my lead to delays. See the bank wire pay-in guide for more details.

Create a Bank Wire PayIn

This call declares the payment to be made by the end user and returns the BankAccount details and WireReference they must use.

<Warning icon="fa-regular fa-triangle-exclamation"> **Caution – Retrieve the returned bank details dynamically** In addition to the `WireReference`, ensure you implement the `BankAccount` object parameter dynamically so the `IBAN`, `BIC`, and other response values appear as returned in for each pay-in. Mangopay may change the underlying bank account without prior notice and mismatched data my lead to delays. See the <a href="/guides/payment-methods/banking/bank-wire">bank wire pay-in</a> guide for more details. </Warning> Create a Bank Wire PayIn This call declares the payment to be made by the end user and returns the `BankAccount` details and `WireReference` they must use.

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.

AuthorIdstringRequired

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

CreditedWalletIdstringRequired

The unique identifier of the credited wallet.

DeclaredDebitedFundsobjectRequired

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

DeclaredFeesobjectRequired

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

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

CreditedUserIdstringOptional

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

The unique identifier of the user whose wallet is credited.

ProfilingAttemptReferencestringOptional

The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.

Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay via the Dashboard for more information.

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.

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 handle errors or for filtering purposes.

ResultMessagestring

The explanation of the result code.

AuthorIdstring

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

CreditedUserIdstring

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

The unique identifier of the user whose wallet is credited.

DebitedFundsobject

Information about the debited funds.

For a direct bank wire pay-in, the DebitedFunds displays placeholder values (currency XXX and amount 0) until the Status changes to SUCCEEDED.

CreditedFundsobject

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

For a direct bank wire pay-in, the CreditedFunds displays placeholder values (currency XXX and amount 0) until the Status changes to SUCCEEDED.

Feesobject

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

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.

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.

DeclaredDebitedFundsobject

Information about the declared debited funds.

DeclaredFeesobject

Information about the declared fees.

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.

BankAccountobject

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.

TransactionDetailslist of objects

Max. length: 50 characters

Information received from banking partners for the transaction, based on the cash management (Camt) messages of ISO 20022.

This information is only returned when the pay-in Status becomes SUCCEEDED.

If data is not available then an empty array, null, or nulled fields are returned.

If multiple wire payments are received for a single pay-in, then multiple objects are returned.