POST
/
v2.01
/
{ClientId}
/
payins
/
bankwire
/
direct
{
    "Tag": "Created using Mangopay API Postman Collection",
    "AuthorId": "user_m_01JCQYJNHFPENP1SKTCBYER0F8",
    "CreditedWalletId": "wlt_m_01JFAJS7838A32W7KPJ7NNGJ1D",
    "DeclaredDebitedFunds": {
        "Currency": "EUR",
        "Amount": 62789
    },
    "DeclaredFees": {
        "Currency": "EUR",
        "Amount": 7826
    },
}

{
    "Id": "payin_m_01JFAJSSR3VW3SHX2X74C8GW82",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1734448310,
    "ResultCode": null,
    "ResultMessage": null,
    "AuthorId": "user_m_01JCQYJNHFPENP1SKTCBYER0F8",
    "CreditedUserId": "user_m_01JCQYJNHFPENP1SKTCBYER0F8",
    "DebitedFunds": {
        "Currency": "XXX",
        "Amount": 0
    },
    "CreditedFunds": {
        "Currency": "XXX",
        "Amount": 0
    },
    "Fees": {
        "Currency": "XXX",
        "Amount": 0
    },
    "Status": "CREATED",
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JFAJS7838A32W7KPJ7NNGJ1D",
    "DebitedWalletId": null,
    "PaymentType": "BANK_WIRE",
    "ExecutionType": "DIRECT",
    "DeclaredDebitedFunds": {
        "Currency": "EUR",
        "Amount": 62789
    },
    "DeclaredFees": {
        "Currency": "EUR",
        "Amount": 7826
    },
    "WireReference": "MGgq1y8jjb",
    "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"
    },
    "TransactionDetails": []
}

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

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.

​
Body parameters

​
Tag
string

Max. length: 255 characters

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

​
AuthorId
string
required

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

​
CreditedUserId
string

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

The unique identifier of the user whose wallet is credited.

​
CreditedWalletId
string
required

The unique identifier of the credited wallet.

​
DeclaredDebitedFunds
object
required

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

​
DeclaredFees
object
required

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

​
ProfilingAttemptReference
string

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.

​
Responses

​
Id
string

The unique identifier of the object.

​
Tag
string

Max. length: 255 characters

Custom data that you can add to this object.

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

​
CreditedUserId
string

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

The unique identifier of the user whose wallet is credited.

​
DebitedFunds
object

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.

​
CreditedFunds
object

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.

​
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, FAILED

The status of the transaction.

​
ExecutionDate
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, PAYOUT

The type of the transaction.

​
Nature
string

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.
​
CreditedWalletId
string

The unique identifier of the credited wallet.

​
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_WIRE

The type of pay-in.

​
ExecutionType
string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

​
DeclaredDebitedFunds
object

Information about the declared funds to be wired by the end user 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 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.

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

​
TransactionDetails
array (object)

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.

{
    "Id": "payin_m_01JFAJSSR3VW3SHX2X74C8GW82",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1734448310,
    "ResultCode": null,
    "ResultMessage": null,
    "AuthorId": "user_m_01JCQYJNHFPENP1SKTCBYER0F8",
    "CreditedUserId": "user_m_01JCQYJNHFPENP1SKTCBYER0F8",
    "DebitedFunds": {
        "Currency": "XXX",
        "Amount": 0
    },
    "CreditedFunds": {
        "Currency": "XXX",
        "Amount": 0
    },
    "Fees": {
        "Currency": "XXX",
        "Amount": 0
    },
    "Status": "CREATED",
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JFAJS7838A32W7KPJ7NNGJ1D",
    "DebitedWalletId": null,
    "PaymentType": "BANK_WIRE",
    "ExecutionType": "DIRECT",
    "DeclaredDebitedFunds": {
        "Currency": "EUR",
        "Amount": 62789
    },
    "DeclaredFees": {
        "Currency": "EUR",
        "Amount": 7826
    },
    "WireReference": "MGgq1y8jjb",
    "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"
    },
    "TransactionDetails": []
}

{
    "Tag": "Created using Mangopay API Postman Collection",
    "AuthorId": "user_m_01JCQYJNHFPENP1SKTCBYER0F8",
    "CreditedWalletId": "wlt_m_01JFAJS7838A32W7KPJ7NNGJ1D",
    "DeclaredDebitedFunds": {
        "Currency": "EUR",
        "Amount": 62789
    },
    "DeclaredFees": {
        "Currency": "EUR",
        "Amount": 7826
    },
}

Was this page helpful?

The Bank Wire PayIn objectView a PayIn (Bank Wire)