> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gr4vy.com/llms.txt
> Use this file to discover all available pages before exploring further.
# BlueSnap - ACH Direct Debit
> Connect to BlueSnap to accept ACH Direct Debit bank payments in the US.
export const connector = {
id: "bluesnap-ach",
displayName: "ACH Direct Debit",
provider: "BlueSnap",
method: "ach",
mode: "redirect",
category: "bank",
features: "create_transaction direct_capture direct_integration_create payment_method_tokenization redirect_requires_popup refunds requires_tokenized_redirect_popup verify_credentials",
supportedCountries: "US",
supportedCurrencies: "USD"
};
export const ConnectorRegions = ({data, kind, name: nameOverride}) => {
const [query, setQuery] = useState("");
const [open, setOpen] = useState(false);
const isCountries = kind === "countries";
const raw = data && (isCountries ? data.supportedCountries : data.supportedCurrencies);
const codes = typeof raw === "string" ? raw.split(/\s+/).filter(Boolean) : Array.isArray(raw) ? raw : [];
const DISPLAY_NAME_OVERRIDES = {
authorizenet: "Authorize.net",
cardpointe: "CardPointe",
cybersource: "Cybersource",
dlocal: "dLocal",
shift4i4go: "Shift4 i4go",
tokenex: "TokenEx"
};
const rawName = data && data.displayName || "";
const name = nameOverride || DISPLAY_NAME_OVERRIDES[rawName.toLowerCase()] || rawName || "This connector";
const verb = isCountries ? "supports transactions from buyers in" : "supports processing payments in";
const noun = isCountries ? "countries" : "currencies";
if (codes.length === 0) return null;
const unrestricted = codes.length >= (isCountries ? 200 : 150);
const disclaimer =
This list is for guidance only. It doesn't guarantee availability or
create any rights, and the provider must also enable each of these {noun}{" "}
for your account.
This list is for guidance only. It doesn't guarantee availability or
create any rights, and the provider may need to enable some features for
your account.
;
};
BlueSnap is a global payment platform that provides payment processing solutions for merchants worldwide. The ACH Direct Debit integration enables US merchants to accept bank account payments directly. Buyers enter their bank account and routing numbers in a BlueSnap-hosted form embedded as a popup, and funds are debited via the ACH network. ACH payments are asynchronous — the transaction enters a pending state immediately after the buyer submits their details, and settlement typically takes 1–3 business days.
## Setup
BlueSnap provides a self-service sign-up for a sandbox account. To sign up, visit the [BlueSnap sign-up page](https://sandbox.bluesnap.com/jsp/onboarding/) and fill in the required details.
### Credentials
When setting up BlueSnap ACH in the dashboard, configure the following credentials:
* **API User Key** - Your BlueSnap API User Key
* **API Password** - Your BlueSnap API Password
* **Webhook Security Header** - Optional security header for webhook signature validation
## Connector configuration
After setting up your BlueSnap ACH connector in the dashboard, configure how transactions are routed to it. Choose one of the following options:
* **Using Flow** - Configure BlueSnap ACH as the target connector in [Flow](/guides/dashboard/flow/overview) to automatically route ACH transactions to this connector
* **Using the API** - Explicitly set the `payment_service_id` parameter to the BlueSnap ACH connector ID when creating transactions. This overrides any Flow routing rules.
The connector ID can be found in the dashboard under **Connections** -> **Configured connections**.
## Capabilities
## Supported countries
## Supported currencies
## Integration
BlueSnap ACH uses a redirect integration where BlueSnap's hosted bank account form is loaded in a popup on your page. The buyer enters their account and routing numbers in the popup, and Gr4vy handles communication with BlueSnap to complete the payment.
ACH settlement is asynchronous. After the buyer submits the form the transaction enters a `pending` state. BlueSnap sends webhooks as the payment progresses:
| Event | Description |
| - | - |
| `CHARGE_PENDING` | The bank debit has been submitted and is awaiting settlement. |
| `CHARGE` | Settlement confirmed. Funds have been captured from the buyer's bank account. |
| `DECLINE` | The debit was rejected by the buyer's bank. |
| `FRAUD_DECLINE` | The transaction was declined due to fraud screening. |
| `REFUND` | A refund has been processed successfully. |
Configure your BlueSnap account to send IPN notifications to your Gr4vy webhook endpoint. To find the endpoint, go to **Connections** in the Gr4vy dashboard, select your BlueSnap connection, and copy the webhook URL from the **Synchronization** tab. In the BlueSnap Merchant Portal, add it under **Settings** -> **Webhook Settings**. The webhook security header is optional but recommended to validate that notifications originate from BlueSnap.
### Required fields
BlueSnap requires the buyer's name on every ACH transaction. Include the following buyer fields when creating a transaction:
* `buyer.billing_details.first_name`
* `buyer.billing_details.last_name`
### Redirect integration
Start by creating a new transaction with the following required fields.
```csharp C# theme={"system"}
var transaction = await client.Transactions.CreateAsync(
transactionCreate: new TransactionCreate()
{
Amount = 1299,
Currency = "USD",
Country = "US",
Intent = "capture",
PaymentMethod =
TransactionCreatePaymentMethod.CreateRedirectPaymentMethodCreate(
new RedirectPaymentMethodCreate()
{
Method = "ach",
Country = "US",
Currency = "USD",
RedirectUrl = "https://example.com/callback",
}
),
Buyer = new GuestBuyer()
{
BillingDetails = new BillingDetails()
{
FirstName = "John",
LastName = "Doe",
}
},
}
);
```
```go Go theme={"system"}
amount := int64(1299)
currency := "USD"
country := "US"
method := components.RedirectPaymentMethodCreateMethodAch
redirectUrl := "https://example.com/callback"
redirectPaymentMethodCreate := components.RedirectPaymentMethodCreate{
Method: method,
Country: country,
Currency: currency,
RedirectURL: redirectUrl,
}
paymentMethod := components.CreateTransactionCreatePaymentMethodRedirectPaymentMethodCreate(redirectPaymentMethodCreate)
transactionCreate := components.TransactionCreate{
Amount: amount,
Currency: currency,
Country: &country,
Intent: gr4vy.Pointer(components.TransactionIntentCapture),
PaymentMethod: &paymentMethod,
Buyer: &components.GuestBuyer{
BillingDetails: &components.BillingDetails{
FirstName: gr4vy.String("John"),
LastName: gr4vy.String("Doe"),
},
},
}
transaction, err := client.Transactions.Create(ctx, transactionCreate, nil, nil, nil)
```
```java Java theme={"system"}
CreateTransactionResponse transactionResponse = gr4vyClient.transactions().create()
.transactionCreate(TransactionCreate.builder()
.amount(1299L)
.currency("USD")
.country("US")
.intent(TransactionIntent.CAPTURE)
.paymentMethod(TransactionCreatePaymentMethod.of(RedirectPaymentMethodCreate.builder()
.method(RedirectPaymentMethodCreateMethod.ACH)
.country("US")
.currency("USD")
.redirectUrl("https://example.com/callback")
.build()))
.buyer(GuestBuyer.builder()
.billingDetails(BillingDetails.builder()
.firstName("John")
.lastName("Doe")
.build())
.build())
.build())
.call();
Transaction transaction = transactionResponse.transaction().orElse(null);
```
```php PHP theme={"system"}
$transactionCreate = new TransactionCreate(
amount: 1299,
currency: 'USD',
country: 'US',
intent: 'capture',
paymentMethod: new RedirectPaymentMethodCreate(
method: 'ach',
country: 'US',
currency: 'USD',
redirectUrl: 'https://example.com/callback'
),
buyer: new GuestBuyer(
billingDetails: new BillingDetails(
firstName: 'John',
lastName: 'Doe'
)
)
);
$response = self::$sdk->transactions->create($transactionCreate);
$transaction = $response->transaction;
```
```python Python theme={"system"}
transaction: models.Transaction = client.transactions.create(
amount=1299,
currency="USD",
country="US",
intent="capture",
payment_method={
"method": "ach",
"country": "US",
"currency": "USD",
"redirect_url": "https://example.com/callback",
},
buyer={
"billing_details": {
"first_name": "John",
"last_name": "Doe",
}
},
)
```
```ts TypeScript theme={"system"}
const transaction = await gr4vy.transactions.create({
amount: 1299,
currency: "USD",
country: "US",
intent: "capture",
paymentMethod: {
method: "ach",
country: "US",
currency: "USD",
redirectUrl: "https://example.com/callback"
},
buyer: {
billingDetails: {
firstName: "John",
lastName: "Doe"
}
}
})
```
After the transaction is created, the API response includes `payment_method.approval_url` and the `buyer_approval_pending` status.
```json theme={"system"}
{
"type": "transaction",
"id": "ea1efdd0-20f9-44d9-9b0b-0a3d71e9b625",
"payment_method": {
"type": "payment-method",
"approval_url": "https://cdn.sandbox.spider.gr4vy.app/connectors/bluesnap/ach.html?token=..."
},
"method": "ach"
}
```
Open the `approval_url` in a popup so the buyer can enter their bank account and routing numbers in the BlueSnap-hosted form. After the buyer submits the form they are redirected to the `redirect_url` you provided. Do not rely solely on the redirect — either poll the transaction or (recommended) rely on webhooks to detect the final status.
## Recurring payments
ACH Direct Debit via BlueSnap supports storing the bank account for later reuse. Set `store: true` on the payment method when creating the transaction.
```csharp C# theme={"system"}
var transaction = await client.Transactions.CreateAsync(
transactionCreate: new TransactionCreate()
{
Amount = 1299,
Currency = "USD",
Country = "US",
Intent = "capture",
PaymentMethod =
TransactionCreatePaymentMethod.CreateRedirectPaymentMethodCreate(
new RedirectPaymentMethodCreate()
{
Method = "ach",
Country = "US",
Currency = "USD",
RedirectUrl = "https://example.com/callback",
Store = true,
}
),
Buyer = new GuestBuyer()
{
BillingDetails = new BillingDetails()
{
FirstName = "John",
LastName = "Doe",
}
},
}
);
```
```go Go theme={"system"}
amount := int64(1299)
currency := "USD"
country := "US"
method := components.RedirectPaymentMethodCreateMethodAch
redirectUrl := "https://example.com/callback"
store := true
redirectPaymentMethodCreate := components.RedirectPaymentMethodCreate{
Method: method,
Country: country,
Currency: currency,
RedirectURL: redirectUrl,
Store: &store,
}
paymentMethod := components.CreateTransactionCreatePaymentMethodRedirectPaymentMethodCreate(redirectPaymentMethodCreate)
transactionCreate := components.TransactionCreate{
Amount: amount,
Currency: currency,
Country: &country,
Intent: gr4vy.Pointer(components.TransactionIntentCapture),
PaymentMethod: &paymentMethod,
Buyer: &components.GuestBuyer{
BillingDetails: &components.BillingDetails{
FirstName: gr4vy.String("John"),
LastName: gr4vy.String("Doe"),
},
},
}
transaction, err := client.Transactions.Create(ctx, transactionCreate, nil, nil, nil)
```
```java Java theme={"system"}
CreateTransactionResponse transactionResponse = gr4vyClient.transactions().create()
.transactionCreate(TransactionCreate.builder()
.amount(1299L)
.currency("USD")
.country("US")
.intent(TransactionIntent.CAPTURE)
.paymentMethod(TransactionCreatePaymentMethod.of(RedirectPaymentMethodCreate.builder()
.method(RedirectPaymentMethodCreateMethod.ACH)
.country("US")
.currency("USD")
.redirectUrl("https://example.com/callback")
.store(true)
.build()))
.buyer(GuestBuyer.builder()
.billingDetails(BillingDetails.builder()
.firstName("John")
.lastName("Doe")
.build())
.build())
.build())
.call();
Transaction transaction = transactionResponse.transaction().orElse(null);
```
```php PHP theme={"system"}
$transactionCreate = new TransactionCreate(
amount: 1299,
currency: 'USD',
country: 'US',
intent: 'capture',
paymentMethod: new RedirectPaymentMethodCreate(
method: 'ach',
country: 'US',
currency: 'USD',
redirectUrl: 'https://example.com/callback',
store: true
),
buyer: new GuestBuyer(
billingDetails: new BillingDetails(
firstName: 'John',
lastName: 'Doe'
)
)
);
$response = self::$sdk->transactions->create($transactionCreate);
$transaction = $response->transaction;
```
```python Python theme={"system"}
transaction: models.Transaction = client.transactions.create(
amount=1299,
currency="USD",
country="US",
intent="capture",
payment_method={
"method": "ach",
"country": "US",
"currency": "USD",
"redirect_url": "https://example.com/callback",
"store": True,
},
buyer={
"billing_details": {
"first_name": "John",
"last_name": "Doe",
}
},
)
```
```ts TypeScript theme={"system"}
const transaction = await gr4vy.transactions.create({
amount: 1299,
currency: "USD",
country: "US",
intent: "capture",
paymentMethod: {
method: "ach",
country: "US",
currency: "USD",
redirectUrl: "https://example.com/callback",
store: true
},
buyer: {
billingDetails: {
firstName: "John",
lastName: "Doe"
}
}
})
```
Gr4vy creates a BlueSnap vaulted shopper when the transaction is initiated. After the buyer fills in their bank details and the `CHARGE_PENDING` webhook is received, a stored payment method token is issued that can be used for subsequent payments without the buyer re-entering their bank details.
To charge the stored bank account later, create a new transaction with `payment_method` set to `{ "method": "id", "id": "" }`, using the ID of the stored payment method. Include the buyer's first and last name as before. BlueSnap debits the account directly, without opening the popup.
When you charge the account without the buyer present, also set `payment_source`, `merchant_initiated: true`, and `is_subsequent_payment: true`. See [Recurring payment scenarios](/guides/features/recurring-payments/scenarios) for the values that match each use case.
See [Recurring payments](/guides/features/recurring-payments/overview) for an overview of storing and reusing payment methods.
## Testing
BlueSnap provides test routing and account numbers for sandbox environments.
| Scenario | Routing Number | Account Number |
| - | - | - |
| Approved transaction | `998877665` | `223344556` |
| Declined transaction | `987654321` | `123456789` |
| Format validation error | `123456789` | `123456789` |
Use any US bank account holder name and address for the remaining fields.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.
setLogoStage(logoStage + 1)} style={{
width: "3.5rem",
height: "3.5rem",
borderRadius: "0.5rem",
margin: 0,
flexShrink: 0
}} /> : }
setChipLogoFailed(true)} style={{
width: "1rem",
height: "1rem",
borderRadius: "0.2rem",
margin: 0
}} />}
{chipLabel}
: null}
{category ? {category} : null}
{flowLabel ? {flowLabel} : null}