createBraleAchCheckout

API Reference

Overview

Client Methods

Actions

React Hooks

Signers & Integrations

Smart Accounts

Wallet Connectors

REST SDK

Types & Configuration

Usage

const checkout = await para.createBraleAchCheckout({
  walletId: wallet.id,
  amountUsd: "100.00",
  customer: { legalName: "Jane Doe" },
});

if (checkout.nextAction === "launch_plaid") {
  openPlaidLink(checkout.plaidLinkToken);
} else {
  showSavedBank(checkout.savedBank);
}

Signature

createBraleAchCheckout(params: {
  walletId: string;
  assetImplementationId?: string;
  amountUsd: string;
  customer?: BraleAchCustomer;
  testMode?: boolean;
  linkNewBank?: boolean;
}): Promise<BraleAchCheckoutStart>

The response is a BraleAchCheckout in one of two forms:

type BraleAchCheckoutStart =
  | (BraleAchCheckout & { stage: "link_required"; nextAction: "launch_plaid"; plaidLinkToken: string })
  | (BraleAchCheckout & { stage: "linked"; nextAction: "confirm_deposit"; savedBank: BraleAchSavedBank });

With "launch_plaid", open Plaid Link with plaidLinkToken, then call linkBraleAchBank with the public token that Plaid returns.
With "confirm_deposit", show the user savedBank. When the user confirms, call submitBraleAchDeposit.

The method needs a signed-in user who isn’t a guest, and the wallet must belong to that user. Starting a checkout for a wallet replaces that wallet’s open checkout.

Pay by bank supports web apps only. ACH must be on for your API key in the Developer Portal, and production keys also need a paid plan. See Pay by Bank (ACH).

For a full React example with Plaid Link, see Pay by bank (ACH).

​Usage

Usage