Open banking for API only

Accept open banking payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Before you begin

These instructions explain how to add to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.

Before starting your integration:

1. Make sure that you have set up your back end implementation.
2. Add in your test Customer Area.

Build your payment form for open banking

The way you can show the payment form depends on what's supported.

• In some regions, such as the United Kingdom, you can optionally show the issuer bank selection on your page:
  1. Show a list of available banks to your shopper.
  2. After the shopper selects a bank, include the issuer ID when you make the payment request.
• In other regions, such as Germany, you can't show the issuer bank selection on your page because there are many banks in the list.

List of issuer IDs

For the UK, where you can show the issuer list in the payment form, the available banks are listed below:

You can also get the issuer list from the /paymentMethods response, as explained in the API-only integration guide.

In your /paymentMethods request, specify:

• countryCode: Any supported country. For example, GB
• amount.currency: Any supported country. For example, GBP
• amount.value: The value of the payment.

In markets where issuer selection is supported, the list of issuing banks are included in the object with type: paybybank.

Make a payment

In your /payments request, specify:

Parameter	Required	Description
paymentMethod.type		paybybank.
returnUrl		URL to where the shopper should be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters.
countryCode		The shopper's country in a two-letter country code format. For example, GB
paymentMethod.issuer		The issuer ID of the shopper's selected bank. This is only supported for regions where you can show the issuer list.
shopperLocale		The language that the redirection page (hosted by Tink) should be rendered in. The page can be the country's language (for example, de-DE for Germany) or in en-US.

The /payments response contains an action object with the information needed to redirect the shopper.

Handle the redirect

1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

   • details: Object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.

You receive a response containing:

• resultCode: Use this to present the result to your shopper.

• pspReference: Our unique identifier for the transaction.

Present the payment result

Use the  resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for open banking are:

resultCode	Description	Action to take
Authorised	The payment was successful.	Inform the shopper that the payment has been successful. You will receive the funds in 2-3 days.
Cancelled	The shopper cancelled the payment while on their bank's website.	Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error	There was an error when the payment was being processed.	Inform the shopper that there was an error processing their payment. The response contains a refusalReason, indicating the cause of the error.
Pending or Received	The shopper has completed the payment but the final result is not yet known. It may take minutes or hours to confirm this.	Inform the shopper that you've received their order, and are waiting for the payment to be completed. You will receive the final result of the payment in an AUTHORISATION webhook. If the transaction is not authorised within 30 minutes, the offer will close. Optionally, you can be informed of this through an OFFER_CLOSED webhook.
Refused	The payment was refused by the shopper's bank.	Ask the shopper to try the payment again using a different payment method.

If the shopper closed the browser and failed to return to your website, wait for webhooks to know the outcome of the payment:

eventCode	success field	Description	Action to take
AUTHORISATION	false	The payment failed.	Cancel the order and inform the shopper that the payment failed.
AUTHORISATION	true	The shopper successfully completed the payment.	Inform the shopper that the payment has been successful and proceed with the order.

Chargebacks

In rare scenarios, it's possible that you do not receive the funds even after receiving a successful AUTHORISATION webhook. The successful AUTHORISATION webhook means that the payment has passed the verifications that the issuer and our open banking partners run on the shopper account, and that the bank transfer was initiated successfully. However, the payment can still fail for the following reasons:

• The shopper cancelled the transaction. Banks in some countries (including Germany and Poland) allow shoppers to cancel bank transfers until midnight of the day of the transaction.
• Some banks process transactions with a delay and do not block the funds for an authorized open banking payment. For example, if the shopper completes a open banking payment on a Saturday, the bank might only process it on Monday. If the shopper has withdrawn sufficient funds in the meantime, the payment will fail.

In these cases, Adyen is not informed that the transaction failed. We also don't know whether the bank might still process it later.

On our side, the status of the payment is SentForSettle until we receive the funds. You can check the status of the payment in your Customer Area.

If we have not received the funds after 8 weekdays, the status of the payment becomes Settled, then Chargeback, and you receive a CHARGEBACK webhook.

In case we receive the money after this point, you receive a CHARGEBACK_REVERSED webhook.

Test and go live

We provide different test issuers for testing open banking payments, including testing for failed or cancelled payments. Select the corresponding test issuer name, for example Demo Open Banking Redirect (payment cancelled), to simulate a cancelled payment scenario.

We recommend that you test each scenario before you go live.

Check the status of test payments in your Customer Area > Transactions > Payments.

Before you can accept live open banking payments, contact our Support Team to add open banking in your test Customer Area.

See also