POST
/
v2.01
/
{ClientId}
/
payins
/
payment-methods
/
openbanking
{
    "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"
}

{
    "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

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

​
Fees
object
required

Information about the fees.

​
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

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

{
    "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"
}

{
    "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"
}

Was this page helpful?