Sign in

v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
bankWirePayins

Create a Bank Wire PayIn

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

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

Path parameters

ClientIdstring required

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

Headers

Authorizationstring required

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.

Request body

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

AuthorIdstring required

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.

CreditedWalletIdstring required

The unique identifier of the credited wallet.

ProfilingAttemptReferencestring

The unique reference generated for the profiling session, used by the <a href="/guides/fraud-prevention">fraud prevention</a> 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 <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> 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 <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.

CreditedUserIdstring

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

The unique identifier of the user whose wallet is credited.

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.

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.