Headless ACH Pull

Whitelist Your API Key & Enable Headless ACH Pull

User Authentication

You can use either of the following authentication options:

User KYC

KYC is a mandatory step in compliance with regulatory requirements. Each user should be KYC Approved. You can use either of the following KYC options:

Generate a quote using the Quote API

Call the Get Quote API to get a quote for the transaction. Pass the apiKey, fiat amount, fiat currency, crypto currency, network, and order type.

A successful response returns a quoteId.

Check for connected bank accounts (using Backend only)

Call the Get Accounts API with paymentInstrumentId set to pm_ach_pull to check whether the user already has a connected bank account.

A successful response returns bankAccounts, isAchMFAVerified, and isAchBlocked.

Place order using the connected account (using Backend only)

If the user has a connected bank account, call the Create Order (Connected Account) API from your backend using below parameters.

A successful response returns the full order details, including orderId and status. Continue with the Track the order step below.

Send Mobile OTP (using Backend only)

If the user has no connected bank account, call the Send Mobile OTP API from your backend with the user’s US mobileNumber.

A successful response returns a mfaSessionId.

Verify Mobile OTP (using Backend only)

Call the Verify Mobile OTP API from your backend with the mfaSessionId from the previous step and the code the user received on their mobile number.

Create a transaction session (using Backend only)

Call the Transaction Session API from your backend using the quoteId and the user’s wallet address. You can optionally pass a config object to customise the color mode of the bank-linking component.

A successful response returns a sessionId.

Load the ACH Pull Component via Transak UI SDK

Use the Transak UI SDK to render the bank-linking component. Pass the sessionId received in the previous step.

The video below shows the ACH Pull bank-linking flow. This entire flow runs through the Embeddable Transak UI.

$
npm install @transak/ui-components

1
import { createTransakAchPull } from '@transak/ui-components';
2
3
const achPull = createTransakAchPull({
4
  sessionId, // sessionId from previous step
5
  environment, // 'STAGING' | 'PRODUCTION'
6
  onReady: () => {
7
    // Component is ready
8
  },
9
  onSuccess: ({ requestId }) => {
10
    // Bank linked — use requestId in the next step
11
  },
12
  onError: ({ code }) => {
13
    // Handle error
14
  },
15
  onClose: () => {
16
    // Customer dismissed the bank-linking widget
17
  },
18
});
19
20
await achPull.mount('ach-pull-slot');
21
22
// and then
23
achPull.unmount();

Error codes

The onError callback receives a code value. Use it to handle specific failure scenarios:

Place order using the new account (using Backend only)

Once the SDK fires onSuccess with a requestId, call the Create Order (New Account) API from your backend using the requestId to complete the payment and create the order.

A successful response returns the full order details, including orderId and status.

Track the order (using Backend only)

The Create Order response already contains the orderId and status. Use the Get Order by ID API to poll for full order details until the status reaches a terminal state.