---
title: "Pay by Bank (US) Redirect Component for iOS"
description: "Add Pay by Bank (US) to your existing iOS Components integration."
url: "https://docs.adyen.com/payment-methods/pay-by-bank-us/ios-component"
source_url: "https://docs.adyen.com/payment-methods/pay-by-bank-us/ios-component.md"
canonical: "https://docs.adyen.com/payment-methods/pay-by-bank-us/ios-component"
last_modified: "2026-06-01T15:33:15+02:00"
language: "en"
---

# Pay by Bank (US) Redirect Component for iOS

Add Pay by Bank (US) to your existing iOS Components integration.

[View source](/payment-methods/pay-by-bank-us/ios-component.md)

This page explains how to add Pay by Bank (US) to your existing iOS Components integration.

## Requirements

Select the [server-side flow](/online-payments/build-your-integration) that your integration uses:

### Tab: Sessions flow

| Requirement          | Description                                                                                                                                                                                                     |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Integration type** | Make sure that you have built a Sessions flow [iOS Components integration](/online-payments/build-your-integration/sessions-flow?platform=iOS\&integration=Components). The minimum required version is 5.70.0. |
| **Setup steps**      | Before you begin, [add Pay by Bank (US) in your Customer Area](/payment-methods/add-payment-methods).                                                                                                           |

### Tab: Advanced flow

| Requirement          | Description                                                                                                                                                                                                      |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Integration type** | Make sure that you have built an Advanced flow [iOS Components integration](/online-payments/build-your-integration/advanced-flow?platform=iOS\&integration=Components). The minimum required version is 5.70.0. |
| **Setup steps**      | Before you begin, [add Pay by Bank (US) in your Customer Area](/payment-methods/add-payment-methods).                                                                                                            |

## API reference

Select the endpoint you are using to make payments:

### Tab: `/sessions`

This is the default with [Components v5.0.0](/online-payments/build-your-integration/sessions-flow/?platform=iOS\&integration=Components) or later.

| Parameter name                                                                                       | Required                                                                                    | Description                                                                                                                                                                                                                                                                                                    |
| ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [countryCode](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-countryCode) | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The shopper's country/region. This determines the banks that our partner shows to the shopper. Format: the two-letter [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. Currently, only **US** is supported. This is also the default if you do not include this parameter. |

### Tab: `/payments`

If you implemented an [additional use case](/online-payments/build-your-integration).

| Parameter name                                                                                       | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ---------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [countryCode](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-countryCode) |          | The shopper's country/region. This determines the banks that our partner shows to the shopper. Format: the two-letter [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. Currently, only **US** is supported. This is also the default if you do not include this parameter. The `countryCode` is not required, but we recommend implementing it because of future enhancements that will allow Pay by Bank (US) payments through non-US banks. |

## Component setup

Create an instance of the Pay by Bank (US) Component:

### Tab: `/sessions`

**Default way to create the Component**

```swift
let paymentMethods = session.sessionContext.paymentMethods
// Check that the payment method is supported before showing the Component.
guard let paymentMethod = paymentMethods.paymentMethod(ofType: PayByBankUSPaymentMethod.self) else { return }
let component = PayByBankUSComponent(
                paymentMethod: paymentMethod,
                context: context)
self.currentComponent = component
// Set the session as the delegate.
component.delegate = session
present(component.viewController, animated: true)
```

**Create the Component for a stored payment method**

```swift
// Check that the payment method is supported before showing the Component.
guard let paymentMethod = paymentMethods.stored.compactMap { $0 as? StoredPayByBankUSPaymentMethod }.first else { return }
let component = StoredPaymentMethodComponent(
                paymentMethod: paymentMethod,
                context: context)
self.currentComponent = component
// Set the session as the delegate.
component.delegate = session
present(component.viewController, animated: true)
```

### Tab: `/payments`

**Default way to create the Component**

```swift
// Check that the payment method is supported before showing the Component.
guard let paymentMethod = paymentMethods.paymentMethod(ofType: PayByBankUSPaymentMethod.self) else { return }
let component = PayByBankUSComponent(
                paymentMethod: paymentMethod,
                context: context)
self.currentComponent = component
// Set the component as the delegate.
component.delegate = self
present(component.viewController, animated: true)
```

**Create the Component for a stored payment method**

```swift
// Check that the payment method is supported before showing the Component.
guard let paymentMethod = paymentMethods.stored.compactMap { $0 as? StoredPayByBankUSPaymentMethod }.first else { return }
let component = StoredPaymentMethodComponent(
                paymentMethod: paymentMethod,
                context: context)
self.currentComponent = component
// Set the component as the delegate.
component.delegate = self
present(component.viewController, animated: true)
```

## Redirect handling

Your Components integration handles the redirect, so you do not need to do anything additional for Pay by Bank (US).

## Payment outcome

Your Components integration gets the payment outcome, so you do not need to do anything additional for Pay by Bank (US).

## Capture

We strongly recommend capturing Pay by Bank (US) payments immediately, to reduce the risk of insufficient funds at the time of capture.

Through our partner Plaid, Adyen completes the checks on the shopper's bank account, including a balance check and risk checks, at the time of authorization. However, the issuing bank does not hold the authorized funds and thus it is possible that the account balance is no longer sufficient by the time you capture the payment. For that reason, you should capture Pay by Bank (US) payments as soon as possible.

However, even with immediate capture there is still a risk of insufficient funds at the time of capture, because capturing is an asynchronous process on the ACH Direct Debit network.

## Recurring payments

Pay by Bank (US) supports tokenization of the shopper's payment details for recurring transactions.

We strongly recommend that you ask explicit permission from the shopper if you intend to make future recurring payments. Being transparent about the payment schedule and the amount reduces the risk of chargebacks.

To make recurring payments, refer to [Tokenization](/online-payments/tokenization) to:

* Create a token through the initial payment.
* Use the token in subsequent payments.
* Manage tokens.

## Test and go live

You can test the payment flow as well as the chargeback flow.

To go live, you need to await registration with our partner Plaid.

### Test the payment flow

In the test environment, the redirect flow mimics the live flow, but not all refusal reasons can be simulated.

To test the payment flow, you can either include a specific amount in your payment request to test a specific scenario, or you can specify **custom\_balances** as your username when you are redirected to confirm the payment.

These are the scenarios you can test:

| Scenario                                                                                                                                     | Username                                                                                                                                       | Amount         |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| Approved                                                                                                                                     | Not required, but you can use **custom\_chase**, **custom\_boa**, **custom\_citi**, or **custom\_wellsfargo** to test different bank accounts. | USD 3.53       |
| Refused with refusal reason **Failed: Risk of unauthorized returns**                                                                         | Not required, but you can use **custom\_chase**, **custom\_boa**, **custom\_citi**, or **custom\_wellsfargo** to test different bank accounts. | USD 27.53      |
| Test custom transaction amounts with different account balances, such as high value transactions or refusals due to an insufficient balance. | **custom\_balances**                                                                                                                           | Any USD amount |

Entering a username is not required to test the payment flow. Tests without a username all use the same bank account from CITIZENS BANK. The **custom\_balances** username allows you to select from several bank accounts with different balances. For example, if you want to test high value transactions, you can use the **custom\_balances** username and select a bank account with a high balance.

1. Make a test Pay by Bank (US) payment using an amount from the table with scenarios or your own amount.

2. When you are redirected to **First Platypus Bank**, depending on your test scenario, either enter a username or leave this field blank.

3. Leave the password blank and select **Continue**.

4. Check the status of test payments in your [test Customer Area](https://ca-test.adyen.com/)  > **Transactions** > **Payments**.

### Test the chargeback flow

The chargeback mechanism for [Pay by Bank (US) chargebacks](/payment-methods/pay-by-bank-us#chargebacks) relies on the ACH Direct Debit network. You can simulate a Pay by Bank (US) chargeback by providing a username that indicates the chargeback scenario you want to test. In the test environment, the flow goes directly to the Chargeback stage.

1. Send a test Pay by Bank (US) payment request.

2. When redirected to **First Platypus Bank**, specify the following username:

   * **custom\_chargeback\_rXX** where **XX** is the dispute reason code without the leading **R**.\
     You can use any of the [ACH Direct Debit reason codes](/risk-management/understanding-disputes/dispute-reason-codes/#ach-direct-debit).

     Example: the username **custom\_chargeback\_r01** triggers a chargeback with reason code R01 for *Insufficient Funds*.

3. Leave the password blank and select **Continue**.

4. Note that the request succeeds with `resultCode`: **Authorised**.\
   The chargeback flow starts after the test payment is captured and settled.

5. Wait for the [CHARGEBACK](https://docs.adyen.com/api-explorer/Webhooks/latest/post/CHARGEBACK) webhook and check your [test Customer Area](https://ca-test.adyen.com/) > **Revenue & risk** > **Disputes**.\
   The webhook and your Customer Area show a chargeback with the return reason code that you specified in the test payment request.

### Go live

To go live, you need to [add Pay by Bank (US) in your live Customer Area](/payment-methods/add-payment-methods/). Our [partner Plaid](/payment-methods/pay-by-bank-us#plaid-partner) then registers your merchant account with participating banks, including some of the largest banks in the US. The registration takes up to one business week from the moment Plaid has started the process. During this time, your shoppers cannot connect their bank account to Plaid. For this reason, you cannot accept live Pay by Bank (US) payments until the registration process is completed.

We send you a [paymentMethod.created](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/paymentMethod.created) webhook when you can start accepting live Pay by Bank (US) payments.

## See also

* [Sessions flow iOS Components integration guide](/online-payments/build-your-integration/sessions-flow?platform=iOS\&integration=Components)
* [Advanced flow iOS Components integration guide](/online-payments/build-your-integration/advanced-flow?platform=iOS\&integration=Components)
* [Webhooks](/development-resources/webhooks)
* [Tokenization for recurring payments](/online-payments/tokenization)
* [ACH Direct Debit chargebacks](/risk-management/chargeback-guidelines/ach-chargebacks)
* [API Explorer](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/overview)
* [Pay by Bank (US) raw refusal responses](/development-resources/raw-acquirer-responses#pay-by-bank-us-raw-responses)
