Create a Pay by Bank PayIn

POST /v2.01/{ClientId}/payins/payment-methods/openbanking

REST

{
    "Tag": "Created using the Mangopay API Postman collection",
    "AuthorId": "user_m_01JM2D5H6C117W88ZDH61FDTA2",
    "DebitedFunds": {
      "Currency": "EUR",
        "Amount": 1000
    },
    "Fees": {
      "Currency": "EUR",
        "Amount": 0
    },
    "CreditedWalletId": "wlt_m_01JM2D5R22PRP33Z5FG33V4N11",
    "Country": "DE",
    "ReturnURL": "http://example.com",
    "IBAN": "DE03500105177564668331",
    "BIC": "AACSDE33",
    "Scheme": "SEPA_INSTANT_CREDIT_TRANSFER",
    "BankName": "de-demobank-open-banking-embedded-templates",
    "Culture": "EN",
    "PaymentFlow": "WEB",
    "StatementDescriptor": "Example123"
}

200

{
    "Id": "wt_af48ec6d-d2a3-4b5c-91ed-1c3466de01f3",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1739542980,
    "AuthorId": "user_m_01JM2D5H6C117W88ZDH61FDTA2",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1036
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1036
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JM2D5R22PRP33Z5FG33V4N11",
    "CreditedUserId": "user_m_01JM2D5H6C117W88ZDH61FDTA2",
    "PaymentType": "PAY_BY_BANK",
    "ExecutionType": "WEB",
    "ReturnURL": "http://example.com?transactionId=wt_af48ec6d-d2a3-4b5c-91ed-1c3466de01f3",
    "RedirectURL": "https://link.tink.com/1.0/pay/direct/?client_id=16056f414a434c149c48770b0f0bed6c&redirect_uri=https://api.dev.whenthen.co/payments/apm/?connectionId=payment-gateway-tink:85013d24-5f47-4cfa-9ee6-ad7ca74901f6&payment_request_id=8be3d49621b543b695ed29a40975b3cd&market=DE&locale=en&session_id=8caa95d0d1694bb59f6fe726fc233635a658cd2b3e2e4d82aaf5da7d516fb4f9&input_provider=de-demobank-open-banking-embedded-templates",
    "StatementDescriptor": "Example123",
    "Country": "DE",
    "BIC": "AACSDE33",
    "IBAN": "DE03500105177564668331",
    "PaymentFlow": "WEB",
    "BankName": "de-demobank-open-banking-embedded-templates",
    "Culture": "EN",
    "Scheme": "SEPA_INSTANT_CREDIT_TRANSFER"
}

Related: test data, guide

Note – Session timeout 9 minutes

The Pay by Bank session lasts for 9 minutes, at which point the pay-in fails automatically if no action has been taken by the user.

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.

DebitedFunds · object · required

Information about the debited funds.

Show properties

Currency · string · required

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the funds.

Amount · integer · required

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Fees · object · required

Information about the fees.

Show properties

Currency · string · required

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the fees.

Amount · integer · required

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

CreditedWalletId · string · required

The unique identifier of the credited wallet.

ReturnURL · string · required

Max. length: 255 characters

The 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 spaces

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

Country · string · required

Allowed values: AT, DE, DK, EE, ES, FI, FR, GB, IE, IT, LV, LT, NL, NO, PL, PT.

The country of residence of the user.

BIC · string

The BIC of the user’s bank account, which is only returned if it was sent.

If both the IBAN and BIC are provided, one of the two authentication steps required by certain banks may be avoided.

IBAN · string

The IBAN of the user’s bank account, which is only returned if it was sent.

If both the IBAN and BIC are provided, one of the two authentication steps required by certain banks may be avoided.

PaymentFlow · string

Allowed values: WEB, APP

Default value: WEB

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

BankName · string

Allowed values: One of the supported bank names.

The name of the bank, which is only returned if it was sent.

If the BankName is provided, the user doesn’t have to select their bank when they are redirected.

Culture · string

Allowed values: DA, CS, DE, EN, ET, ES, FI, FR, IT, LT, LV, NL, NO, PL, PT, SV

Default value: EN

The language in which the Tink open banking page is to be displayed.

Scheme · string

Allowed values: One of the supported schemes for the Country.

Default value: The listed instant scheme for the Country. If Country is DK, there is no default and the Scheme must be specified.

The scheme to use to process the payment. Note that some banks may charge additional fees to the user for instant payment schemes.

Responses

200 - Body parameters

Id · string

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

The unique identifier of the object.

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.

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.

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the funds.

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

CreditedFunds · object

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

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the funds.

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Fees · object

Information about the fees.

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the fees.

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Status · string

Returned values: CREATED, SUCCEEDED, FAILED

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

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: PAY_BY_BANK

The type of pay-in.

ExecutionType · string

Returned values: WEB

The execution type of the mandate.

ReturnURL · string

Max. length: 255 characters

The 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 spaces

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

Country · string

Allowed values: AT, DE, DK, EE, ES, FI, FR, GB, IE, IT, LV, LT, NL, NO, PL, PT.

The country of residence of the user.

BIC · string

The BIC of the user’s bank account, which is only returned if it was sent.

If both the IBAN and BIC are provided, one of the two authentication steps required by certain banks may be avoided.

IBAN · string

The IBAN of the user’s bank account, which is only returned if it was sent.

If both the IBAN and BIC are provided, one of the two authentication steps required by certain banks may be avoided.

PaymentFlow · string

Allowed values: WEB, APP

Default value: WEB

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

BankName · string

Allowed values: One of the supported bank names.

The name of the bank, which is only returned if it was sent.

If the BankName is provided, the user doesn’t have to select their bank when they are redirected.

Culture · string

Allowed values: DA, CS, DE, EN, ET, ES, FI, FR, IT, LT, LV, NL, NO, PL, PT, SV

Default value: EN

The language in which the Tink open banking page is to be displayed.

Scheme · string

Allowed values: One of the supported schemes for the Country.

Default value: The listed instant scheme for the Country. If Country is DK, there is no default and the Scheme must be specified.

The scheme to use to process the payment. Note that some banks may charge additional fees to the user for instant payment schemes.

ProcessingStatus · string

Possible values: PENDING_SUCCEEDED

Parameter that is only returned once the bank wire has been successfully authenticated and initiated by the user but has not yet been received by Mangopay. When the funds are received, the Status changes from CREATED to SUCCEEDED and the ProcessingStatus is no longer returned.

For non-instant schemes, processing can take up to 72 hours but is typically completed within 2 days.

Functional errors (ResultCode) are possible on a 200 response. Read more →

400 - IBAN not valid

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Id": "e5845761-cf31-4bf6-bbca-dee3a969a816",
    "Date": 1743157036,
    "Type": "param_error",
    "Errors": {
        "IBAN": "The value DE123456789 is not valid"
    }
}

400 - BIC not valid

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Id": "7119ceaa-24b9-4330-a715-a6091f814f40",
    "Date": 1743156913,
    "Type": "param_error",
    "Errors": {
        "Bic": "The field must match the regular expression '[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?'."
    }
}

200

{
    "Id": "wt_af48ec6d-d2a3-4b5c-91ed-1c3466de01f3",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1739542980,
    "AuthorId": "user_m_01JM2D5H6C117W88ZDH61FDTA2",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1036
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1036
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JM2D5R22PRP33Z5FG33V4N11",
    "CreditedUserId": "user_m_01JM2D5H6C117W88ZDH61FDTA2",
    "PaymentType": "PAY_BY_BANK",
    "ExecutionType": "WEB",
    "ReturnURL": "http://example.com?transactionId=wt_af48ec6d-d2a3-4b5c-91ed-1c3466de01f3",
    "RedirectURL": "https://link.tink.com/1.0/pay/direct/?client_id=16056f414a434c149c48770b0f0bed6c&redirect_uri=https://api.dev.whenthen.co/payments/apm/?connectionId=payment-gateway-tink:85013d24-5f47-4cfa-9ee6-ad7ca74901f6&payment_request_id=8be3d49621b543b695ed29a40975b3cd&market=DE&locale=en&session_id=8caa95d0d1694bb59f6fe726fc233635a658cd2b3e2e4d82aaf5da7d516fb4f9&input_provider=de-demobank-open-banking-embedded-templates",
    "StatementDescriptor": "Example123",
    "Country": "DE",
    "BIC": "AACSDE33",
    "IBAN": "DE03500105177564668331",
    "PaymentFlow": "WEB",
    "BankName": "de-demobank-open-banking-embedded-templates",
    "Culture": "EN",
    "Scheme": "SEPA_INSTANT_CREDIT_TRANSFER"
}

REST

{
    "Tag": "Created using the Mangopay API Postman collection",
    "AuthorId": "user_m_01JM2D5H6C117W88ZDH61FDTA2",
    "DebitedFunds": {
      "Currency": "EUR",
        "Amount": 1000
    },
    "Fees": {
      "Currency": "EUR",
        "Amount": 0
    },
    "CreditedWalletId": "wlt_m_01JM2D5R22PRP33Z5FG33V4N11",
    "Country": "DE",
    "ReturnURL": "http://example.com",
    "IBAN": "DE03500105177564668331",
    "BIC": "AACSDE33",
    "Scheme": "SEPA_INSTANT_CREDIT_TRANSFER",
    "BankName": "de-demobank-open-banking-embedded-templates",
    "Culture": "EN",
    "PaymentFlow": "WEB",
    "StatementDescriptor": "Example123"
}