@eczodex/issuers-sdk/dist/adapters/braleBankAdapter.d.ts

SDK for interacting with Eczodex issuer APIs.

/**
 * Create a manual external bank address for the given Brale account.
 * POST /accounts/{account_id}/addresses/external
 *
 * `payload` (snake_case) from mapper:
 * {
 *   owner: string,
 *   transfer_types: string[],
 *   account_number: string,
 *   routing_number: string,
 *   name: string,
 *   bank_address: {
 *     street_line_1: string,
 *     street_line_2?: string,
 *     city: string,
 *     state: string,
 *     zip: string
 *   },
 *   beneficiary_address: {
 *     street_line_1: string,
 *     street_line_2?: string,
 *     city: string,
 *     state: string,
 *     zip: string
 *   },
 *   account_type: "checking" | "savings"
 * }
 */
export declare function createBraleBankAddress(accountId: string, payload: any, token: string, idempotencyKey?: string): Promise<any>;
/**
 * Create a Plaid Link token for the given Brale account.
 * POST /accounts/{account_id}/plaid/link_token
 *
 * `payload` (snake_case) from mapper:
 * { date_of_birth?, email_address?, legal_name?, phone_number? }
 */
export declare function createBralePlaidLinkToken(accountId: string, payload: any, token: string, idempotencyKey?: string): Promise<any>;
/**
 * Exchange Plaid public_token with Brale and create/update an Address.
 * POST /accounts/{account_id}/plaid/register-account
 *
 * `payload`:
 * {
 *   public_token: string,
 *   customer_webhook_url?: string,
 *   transfer_types?: ["ach_debit","same_day_ach_debit","ach_credit","same_day_ach_credit","rtp"]
 * }
 */
export declare function registerBralePlaidAccount(accountId: string, payload: any, token: string, idempotencyKey?: string): Promise<any>;
/**
 * Get a single Address (Plaid-linked or internal).
 * GET /accounts/{account_id}/addresses/{address_id}
 */
export declare function getBraleAddressById(accountId: string, addressId: string, token: string): Promise<any>;
/**
 * List all Addresses for the account.
 * GET /accounts/{account_id}/addresses
 */
export declare function listBraleAddresses(accountId: string, token: string): Promise<any>;
/**
 * Request an update Link token for an Address that needs re-auth.
 * POST /accounts/{account_id}/addresses/{address_id}/update-link-token
 */
export declare function requestBraleAddressUpdateLinkToken(accountId: string, addressId: string, token: string, idempotencyKey?: string): Promise<any>;