Skip to main content
POST
/
v2.01
/
{ClientId}
/
payins
/
payment-methods
/
bancontact
{
  "Tag": "Created using the Mangopay API Postman collection",
  "AuthorId": "user_m_01HZSK5MX04KS9Q7SQSSRGQQ4Q",
  "DebitedFunds": {
    "Currency": "EUR",
    "Amount": 1627
  },
  "Fees": {
    "Currency": "EUR",
    "Amount": 163
  },
  "CreditedWalletId": "wlt_m_01HW8AS48VH6MRXVT44RKK5RW1",
  "ReturnURL": "https://www.mangopay.com/docs/please-ignore",
  "StatementDescriptor" : "Example123",
  "Recurring" : false,
  "Culture" : "EN",
  "PaymentFlow": "APP"
}  

{
    "Id": "wt_45b42782-5fb1-4083-9c77-43b573af7deb",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1718721483,
    "AuthorId": "user_m_01HZSK5MX04KS9Q7SQSSRGQQ4Q",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1627
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1464
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 163
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01HW8AS48VH6MRXVT44RKK5RW1",
    "CreditedUserId": "user_m_01HSDQD2RPPQ8NMM36EDGYBMEY",
    "PaymentType": "BCMC",
    "ExecutionType": "WEB",
    "ReturnURL": "https://www.mangopay.com/docs/please-ignore?transactionId=wt_45b42782-5fb1-4083-9c77-43b573af7deb",
    "RedirectURL": "https://r3.girogate.de/ti/simbcmc?tx=2222192564&rs=NXyX461Ol79WBMuNVLDUQFDQrkgKDOte&cs=05e30e859ba461b405ff6696796caf4df5b277178484337a85bfa098049467a6",
    "StatementDescriptor": "Example123",
    "Recurring": false,
    "Culture": "EN",
    "PaymentFlow": "APP",
    "DeepLinkURL": "BEP://1BC.GIROGATE.DE/BCMC/123456789$ICAE3BUIH5P9U53Y5HKA9CRT"
}
Note – Timeout after 1 hourThe Bancontact payment session lasts for 1 hour, at which point the pay-in fails automatically if no action has been taken by the user.

​
Body parameters

​
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.
​
AuthorId
string
required
The unique identifier of the user at the source of the transaction.
​
DebitedFunds
object
required
Information about the debited funds.
​
Fees
object
required
Information about the fees.
​
CreditedWalletId
string
required
The unique identifier of the credited wallet.
​
ReturnURL
string
required
Max. length: 255 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
​
StatementDescriptor
string
Max. length: 10 characters; only alphanumeric and spacesCustom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.
​
Recurring
boolean
Whether or not the pay-in forms part of a Bancontact recurring payment flow (not yet available).
​
Culture
string
Allowed values: One of the supported languages in the ISO 639-1 format: DE, EN, FR, NLDefault value: FRThe language in which the Bancontact payment page is to be displayed.
​
PaymentFlow
string
Allowed values: WEB, APPDefault value: WEBThe platform environment of the post-payment flow. The PaymentFlow value combines with the ReturnURL to manage the redirection behavior after payment:
  • Set the value to APP to send the user to your platform’s mobile app
  • Set the value to WEB to send the user to a web browser
In both cases you need to provide the relevant ReturnURL, whether to your app or website.

​
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.
​
AuthorId
string
The unique identifier of the user at the source of the transaction.
​
DebitedFunds
object
Information about the debited funds.
​
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
Fees
object
Information about the fees.
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
​
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.
​
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.
​
CreditedUserId
string
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
​
PaymentType
string
Returned values: BCMCThe type of pay-in.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
ReturnURL
string
Max. length: 255 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
​
RedirectURL
string
The URL to which to redirect the user to complete the payment.Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
​
StatementDescriptor
string
Max. length: 10 characters; only alphanumeric and spacesCustom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.
​
Recurring
boolean
Whether or not the pay-in forms part of a Bancontact recurring payment flow (not yet available).
​
Culture
string
Allowed values: One of the supported languages in the ISO 639-1 format: DE, EN, FR, NLDefault value: FRThe language in which the Bancontact payment page is to be displayed.
​
PaymentFlow
string
Allowed values: WEB, APPDefault value: WEBThe platform environment of the post-payment flow. The PaymentFlow value combines with the ReturnURL to manage the redirection behavior after payment:
  • Set the value to APP to send the user to your platform’s mobile app
  • Set the value to WEB to send the user to a web browser
In both cases you need to provide the relevant ReturnURL, whether to your app or website.
​
DeepLinkURL
string
The mobile URL to which to redirect the user to complete the payment in an app-to-app flow.Note: In Sandbox, this value is a placeholder: the RedirectURL must be used to complete the payment using Mangopay’s web-based simulator.
{
    "Id": "wt_45b42782-5fb1-4083-9c77-43b573af7deb",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1718721483,
    "AuthorId": "user_m_01HZSK5MX04KS9Q7SQSSRGQQ4Q",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1627
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1464
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 163
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01HW8AS48VH6MRXVT44RKK5RW1",
    "CreditedUserId": "user_m_01HSDQD2RPPQ8NMM36EDGYBMEY",
    "PaymentType": "BCMC",
    "ExecutionType": "WEB",
    "ReturnURL": "https://www.mangopay.com/docs/please-ignore?transactionId=wt_45b42782-5fb1-4083-9c77-43b573af7deb",
    "RedirectURL": "https://r3.girogate.de/ti/simbcmc?tx=2222192564&rs=NXyX461Ol79WBMuNVLDUQFDQrkgKDOte&cs=05e30e859ba461b405ff6696796caf4df5b277178484337a85bfa098049467a6",
    "StatementDescriptor": "Example123",
    "Recurring": false,
    "Culture": "EN",
    "PaymentFlow": "APP",
    "DeepLinkURL": "BEP://1BC.GIROGATE.DE/BCMC/123456789$ICAE3BUIH5P9U53Y5HKA9CRT"
}

{
  "Tag": "Created using the Mangopay API Postman collection",
  "AuthorId": "user_m_01HZSK5MX04KS9Q7SQSSRGQQ4Q",
  "DebitedFunds": {
    "Currency": "EUR",
    "Amount": 1627
  },
  "Fees": {
    "Currency": "EUR",
    "Amount": 163
  },
  "CreditedWalletId": "wlt_m_01HW8AS48VH6MRXVT44RKK5RW1",
  "ReturnURL": "https://www.mangopay.com/docs/please-ignore",
  "StatementDescriptor" : "Example123",
  "Recurring" : false,
  "Culture" : "EN",
  "PaymentFlow": "APP"
}