Create a Pay by Bank PayIn

POST

/v2.01/:ClientId/payins/payment-methods/openbanking

POST

/v2.01/:ClientId/payins/payment-methods/openbanking

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payins/payment-methods/openbanking \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "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"
>   }
> }'

1 {
2   "Id": "wt_af48ec6d-d2a3-4b5c-91ed-1c3466de01f3",
3   "Tag": "Created using the Mangopay API Postman collection",
4   "CreationDate": 1739542980,
5   "AuthorId": "user_m_01JM2D5H6C117W88ZDH61FDTA2",
6   "DebitedFunds": {
7     "Currency": "EUR",
8     "Amount": 1036
9   },
10   "CreditedFunds": {
11     "Currency": "EUR",
12     "Amount": 1036
13   },
14   "Fees": {
15     "Currency": "EUR",
16     "Amount": 0
17   },
18   "Status": "CREATED",
19   "ResultCode": null,
20   "ResultMessage": null,
21   "ExecutionDate": null,
22   "Type": "PAYIN",
23   "Nature": "REGULAR",
24   "CreditedWalletId": "wlt_m_01JM2D5R22PRP33Z5FG33V4N11",
25   "CreditedUserId": "user_m_01JM2D5H6C117W88ZDH61FDTA2",
26   "PaymentType": "PAY_BY_BANK",
27   "ExecutionType": "WEB",
28   "ReturnURL": "http://example.com?transactionId=wt_af48ec6d-d2a3-4b5c-91ed-1c3466de01f3",
29   "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",
30   "StatementDescriptor": "Example123",
31   "Country": "DE",
32   "BIC": "AACSDE33",
33   "IBAN": "DE03500105177564668331",
34   "PaymentFlow": "WEB",
35   "BankName": "de-demobank-open-banking-embedded-templates",
36   "Culture": "EN",
37   "Scheme": "SEPA_INSTANT_CREDIT_TRANSFER"
38 }

Initiate a Pay by Bank pay-in request.

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.

Related: test data, guide

Initiate a Pay by Bank pay-in request. <Note icon="fa-regular fa-circle-info"> **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. </Note> Related: [test data](/testing/payment-methods#pay-by-bank), [guide](/guides/payment-methods/banking/pay-by-bank)

Authentication

AuthorizationBearer

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.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

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

Request

This endpoint expects an object.

AuthorIdstringRequired

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

DebitedFundsobjectRequired

Information about the debited funds.

FeesobjectRequired

Information about the fees.

CreditedWalletIdstringRequired

The unique identifier of the credited wallet.

ReturnURLstringRequired

Max. length: 255 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

CountrystringRequired

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.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

StatementDescriptorstringOptional

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.

BICstringOptional

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.

IBANstringOptional

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.

PaymentFlowstringOptional

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.

BankNamestringOptional

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.

CulturestringOptional

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.

SchemestringOptional

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.

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.

AuthorIdstring

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

DebitedFundsobject

Information about the debited funds.

CreditedFundsobject

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

Feesobject

Information about the fees.

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCodestring

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestring

The explanation of the result code.

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.

CreditedUserIdstring

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

The unique identifier of the user whose wallet is credited.

PaymentTypestring

Returned values: PAY_BY_BANK

The payment type of the pay-in.

ExecutionTypestring

Returned values: WEB

The execution type of the pay-in.

ReturnURLstring

Max. length: 255 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

RedirectURLstring

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.

StatementDescriptorstring

Max. length: 10 characters; only alphanumeric and spaces

Countrystring

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.

BICstring

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.

IBANstring

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.

PaymentFlowstring

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.

BankNamestring

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.

Culturestring

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.

Schemestring

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.

ProcessingStatusstring

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.

Errors

400

Bad Request Error