Bank Accounts - BlindPay Node.js SDK

Bank accounts are the destination accounts where receivers can receive payouts. Each receiver can have multiple bank accounts across different payment rails.

Supported Payment Rails

BlindPay supports the following payment rails:

ACH - US Automated Clearing House transfers
Wire - US domestic wire transfers
RTP - US Real-Time Payments
PIX - Brazilian instant payments
SPEI - Mexican electronic funds transfer
Argentina Transfers - Argentina bank transfers (CVU, CBU, ALIAS)
Colombia ACH - Colombian ACH transfers
International SWIFT - International wire transfers

List Bank Accounts

Retrieve all bank accounts for a receiver.

const response = await blindpay.bankAccounts.list("rcv_123abc");

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(response.data.data); // Array of bank accounts
}

Parameters

receiver_id

string

required

The unique identifier of the receiver

Response

data

array

required

Array of bank account objects

Show Bank Account Object

string

required

Unique identifier for the bank account

type

string

required

Payment rail type: "ach", "wire", "rtp", "pix", "spei_bitso", "transfers_bitso", "ach_cop_bitso", or "international_swift"

name

string

required

Custom name for this bank account

created_at

string

required

ISO 8601 timestamp of creation

beneficiary_name

string

Name of the account beneficiary (ACH, Wire, SPEI, Argentina Transfers)

routing_number

string

Bank routing number (ACH, Wire, RTP)

account_number

string

Bank account number (ACH, Wire, RTP)

account_type

string

Account type: "checking" or "saving" (ACH, Colombia ACH)

account_class

string

Account class: "individual" or "business" (ACH)

address_line_1

string

First line of address (Wire, RTP, SWIFT)

address_line_2

string

Second line of address (Wire, RTP, SWIFT)

city

string

City (Wire, RTP, SWIFT)

state_province_region

string

State, province, or region (Wire, RTP, SWIFT)

country

string

Two-letter ISO country code (Wire, RTP, SWIFT)

postal_code

string

Postal or ZIP code (Wire, RTP, SWIFT)

pix_key

string

PIX key (email, phone, CPF, or random key) - PIX only

spei_protocol

string

SPEI protocol - SPEI only

spei_institution_code

string

SPEI institution code - SPEI only

spei_clabe

string

18-digit CLABE number - SPEI only

transfers_type

string

Transfer type: "CVU", "CBU", or "ALIAS" - Argentina Transfers only

transfers_account

string

Transfer account identifier - Argentina Transfers only

ach_cop_beneficiary_first_name

string

Beneficiary first name - Colombia ACH only

ach_cop_beneficiary_last_name

string

Beneficiary last name - Colombia ACH only

ach_cop_document_id

string

Document ID number - Colombia ACH only

ach_cop_document_type

string

Document type: "CC", "CE", "NIT", "PASS", or "PEP" - Colombia ACH only

ach_cop_email

string

Beneficiary email - Colombia ACH only

ach_cop_bank_code

string

Bank code - Colombia ACH only

ach_cop_bank_account

string

Bank account number - Colombia ACH only

swift_code_bic

string

SWIFT/BIC code - International SWIFT only

swift_account_holder_name

string

Account holder name - International SWIFT only

swift_account_number_iban

string

Account number or IBAN - International SWIFT only

swift_beneficiary_address_line_1

string

Beneficiary address line 1 - International SWIFT only

swift_beneficiary_address_line_2

string

Beneficiary address line 2 - International SWIFT only

swift_beneficiary_country

string

Beneficiary country code - International SWIFT only

swift_beneficiary_city

string

Beneficiary city - International SWIFT only

swift_beneficiary_state_province_region

string

Beneficiary state/province/region - International SWIFT only

swift_beneficiary_postal_code

string

Beneficiary postal code - International SWIFT only

swift_bank_name

string

Bank name - International SWIFT only

swift_bank_address_line_1

string

Bank address line 1 - International SWIFT only

swift_bank_address_line_2

string

Bank address line 2 - International SWIFT only

swift_bank_country

string

Bank country code - International SWIFT only

swift_bank_city

string

Bank city - International SWIFT only

swift_bank_state_province_region

string

Bank state/province/region - International SWIFT only

swift_bank_postal_code

string

Bank postal code - International SWIFT only

swift_intermediary_bank_swift_code_bic

string

Intermediary bank SWIFT/BIC code - International SWIFT only

swift_intermediary_bank_account_number_iban

string

Intermediary bank account number/IBAN - International SWIFT only

swift_intermediary_bank_name

string

Intermediary bank name - International SWIFT only

swift_intermediary_bank_country

string

Intermediary bank country code - International SWIFT only

tron_wallet_hash

string

TRON wallet address for crypto offramp

offramp_wallets

array

Array of offramp wallet configurations

Show Offramp Wallet

string

required

Wallet ID

address

string

required

Wallet address

network

string

required

Network: "tron"

external_id

string

required

External identifier

Get Bank Account

Retrieve a specific bank account.

const response = await blindpay.bankAccounts.get({
  receiver_id: "rcv_123abc",
  id: "ba_456def"
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(response.data);
}

Parameters

receiver_id

string

required

The unique identifier of the receiver

string

required

The unique identifier of the bank account

Response

Returns a single bank account object with the structure described in the List Bank Accounts response.

Delete Bank Account

Delete a bank account from a receiver. This action cannot be undone.

const response = await blindpay.bankAccounts.delete({
  receiver_id: "rcv_123abc",
  id: "ba_456def"
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("Bank account deleted successfully");
}

Parameters

receiver_id

string

required

The unique identifier of the receiver

string

required

The unique identifier of the bank account to delete

Response

Returns an empty success response if the deletion was successful.

Create ACH Bank Account

Create a US ACH bank account for a receiver.

const response = await blindpay.bankAccounts.createAch({
  receiver_id: "rcv_123abc",
  name: "Primary Checking",
  beneficiary_name: "John Doe",
  routing_number: "021000021",
  account_number: "1234567890",
  account_type: "checking",
  account_class: "individual"
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("ACH account created:", response.data.id);
}

Parameters

receiver_id

string

required

The unique identifier of the receiver

name

string

required

Custom name for this bank account

beneficiary_name

string

required

Name on the bank account

routing_number

string

required

9-digit ABA routing number

account_number

string

required

Bank account number

account_type

string

required

Type of account: "checking" or "saving"

account_class

string

required

Class of account: "individual" or "business"

Response

string

required

Unique identifier for the created ACH bank account

type

string

required

Always "ach"

name

string

required

Custom name for this bank account

beneficiary_name

string

required

Name on the bank account

routing_number

string

required

Routing number

account_number

string

required

Account number

account_type

string

required

Account type

account_class

string

required

Account class

created_at

string

required

ISO 8601 timestamp of creation

Create Wire Bank Account

Create a US domestic wire transfer bank account.

const response = await blindpay.bankAccounts.createWire({
  receiver_id: "rcv_123abc",
  name: "Business Wire Account",
  beneficiary_name: "Acme Corporation",
  routing_number: "021000021",
  account_number: "9876543210",
  address_line_1: "123 Business St",
  address_line_2: "Suite 100",
  city: "New York",
  state_province_region: "NY",
  country: "US",
  postal_code: "10001"
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("Wire account created:", response.data.id);
}

Parameters

receiver_id

string

required

The unique identifier of the receiver

name

string

required

Custom name for this bank account

beneficiary_name

string

required

Name on the bank account

routing_number

string

required

9-digit ABA routing number

account_number

string

required

Bank account number

address_line_1

string

required

First line of beneficiary address

address_line_2

string

Second line of beneficiary address

city

string

required

City

state_province_region

string

required

State or region (two-letter state code for US)

country

string

required

Two-letter ISO country code (typically “US”)

postal_code

string

required

ZIP or postal code

Response

Returns a wire bank account object with type: "wire" and all provided fields.

Create RTP Bank Account

Create a Real-Time Payments (RTP) bank account.

const response = await blindpay.bankAccounts.createRtp({
  receiver_id: "rcv_123abc",
  name: "RTP Account",
  beneficiary_name: "Jane Smith",
  routing_number: "021000021",
  account_number: "5555555555",
  address_line_1: "456 Main Ave",
  city: "Boston",
  state_province_region: "MA",
  country: "US",
  postal_code: "02101"
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("RTP account created:", response.data.id);
}

Parameters

RTP accounts use the same parameters as Wire accounts.

Response

Returns an RTP bank account object with type: "rtp" and all provided fields.

Create PIX Bank Account

Create a Brazilian PIX instant payment account.

const response = await blindpay.bankAccounts.createPix({
  receiver_id: "rcv_123abc",
  name: "PIX Account",
  pix_key: "joao.silva@example.com" // Can be email, phone, CPF, or random key
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("PIX account created:", response.data.id);
}

Parameters

receiver_id

string

required

The unique identifier of the receiver

name

string

required

Custom name for this PIX account

pix_key

string

required

PIX key - can be:

Email address
Phone number (format: +5511999999999)
CPF/CNPJ (Brazilian tax ID)
Random key (UUID)

Response

string

required

Unique identifier for the created PIX account

type

string

required

Always "pix"

name

string

required

Custom name

pix_key

string

required

PIX key

created_at

string

required

ISO 8601 timestamp

Create SPEI Bank Account

Create a Mexican SPEI electronic transfer account.

const response = await blindpay.bankAccounts.createSpei({
  receiver_id: "rcv_123abc",
  name: "SPEI Account",
  beneficiary_name: "María García",
  spei_clabe: "012345678901234567",
  spei_institution_code: "012",
  spei_protocol: "STP"
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("SPEI account created:", response.data.id);
}

Parameters

receiver_id

string

required

The unique identifier of the receiver

name

string

required

Custom name for this SPEI account

beneficiary_name

string

required

Name on the bank account

spei_clabe

string

required

18-digit CLABE (Clave Bancaria Estandarizada) number

spei_institution_code

string

required

3-digit bank institution code

spei_protocol

string

required

SPEI protocol type (e.g., “STP”)

Response

Returns a SPEI bank account object with type: "spei_bitso" and all provided fields.

Create Argentina Transfers Bank Account

Create an Argentina bank transfer account (CVU, CBU, or ALIAS).

const response = await blindpay.bankAccounts.createArgentinaTransfers({
  receiver_id: "rcv_123abc",
  name: "Argentina Account",
  beneficiary_name: "Carlos Rodriguez",
  transfers_type: "CVU",
  transfers_account: "0000003100010000000001"
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("Argentina account created:", response.data.id);
}

Parameters

receiver_id

string

required

The unique identifier of the receiver

name

string

required

Custom name for this account

beneficiary_name

string

required

Name on the account

transfers_type

string

required

Type of transfer:

"CVU" - Clave Virtual Uniforme (virtual account)
"CBU" - Clave Bancaria Uniforme (bank account)
"ALIAS" - Account alias

transfers_account

string

required

Account identifier (CVU, CBU number, or alias)

Response

Returns an Argentina transfers account object with type: "transfers_bitso" and all provided fields.

Create Colombia ACH Bank Account

Create a Colombian ACH transfer account.

const response = await blindpay.bankAccounts.createColombiaAch({
  receiver_id: "rcv_123abc",
  name: "Colombia ACH Account",
  account_type: "checking",
  ach_cop_beneficiary_first_name: "Juan",
  ach_cop_beneficiary_last_name: "Pérez",
  ach_cop_document_type: "CC",
  ach_cop_document_id: "1234567890",
  ach_cop_email: "juan.perez@example.com",
  ach_cop_bank_code: "001",
  ach_cop_bank_account: "12345678901234567890"
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("Colombia ACH account created:", response.data.id);
}

Parameters

receiver_id

string

required

The unique identifier of the receiver

name

string

required

Custom name for this account

account_type

string

required

Type of account: "checking" or "saving"

ach_cop_beneficiary_first_name

string

required

Beneficiary’s first name

ach_cop_beneficiary_last_name

string

required

Beneficiary’s last name

ach_cop_document_type

string

required

Type of identification document:

"CC" - Cédula de Ciudadanía (citizenship card)
"CE" - Cédula de Extranjería (foreign ID)
"NIT" - Tax identification number
"PASS" - Passport
"PEP" - Special permit

ach_cop_document_id

string

required

Document ID number

ach_cop_email

string

required

Beneficiary’s email address

ach_cop_bank_code

string

required

Bank code

ach_cop_bank_account

string

required

Bank account number

Response

Returns a Colombia ACH account object with type: "ach_cop_bitso" and all provided fields.

Create International SWIFT Bank Account

Create an international wire transfer account using SWIFT.

const response = await blindpay.bankAccounts.createInternationalSwift({
  receiver_id: "rcv_123abc",
  name: "International SWIFT Account",
  swift_code_bic: "DEUTDEFF",
  swift_account_holder_name: "Hans Mueller",
  swift_account_number_iban: "DE89370400440532013000",
  swift_beneficiary_address_line_1: "Hauptstraße 123",
  swift_beneficiary_city: "Berlin",
  swift_beneficiary_country: "DE",
  swift_beneficiary_state_province_region: "Berlin",
  swift_beneficiary_postal_code: "10115",
  swift_bank_name: "Deutsche Bank",
  swift_bank_address_line_1: "Taunusanlage 12",
  swift_bank_city: "Frankfurt",
  swift_bank_country: "DE",
  swift_bank_state_province_region: "Hesse",
  swift_bank_postal_code: "60325",
  swift_intermediary_bank_swift_code_bic: null,
  swift_intermediary_bank_account_number_iban: null,
  swift_intermediary_bank_name: null,
  swift_intermediary_bank_country: null
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("International SWIFT account created:", response.data.id);
}

Parameters

receiver_id

string

required

The unique identifier of the receiver

name

string

required

Custom name for this account

swift_code_bic

string

required

SWIFT code or BIC of the beneficiary bank (8 or 11 characters)

swift_account_holder_name

string

required

Name of the account holder

swift_account_number_iban

string

required

Account number or IBAN

Beneficiary Information

swift_beneficiary_address_line_1

string

required

First line of beneficiary address

swift_beneficiary_address_line_2

string

Second line of beneficiary address

swift_beneficiary_city

string

required

Beneficiary city

swift_beneficiary_country

string

required

Two-letter ISO country code

swift_beneficiary_state_province_region

string

required

Beneficiary state, province, or region

swift_beneficiary_postal_code

string

required

Beneficiary postal code

Bank Information

swift_bank_name

string

required

Name of the beneficiary bank

swift_bank_address_line_1

string

required

First line of bank address

swift_bank_address_line_2

string

Second line of bank address

swift_bank_city

string

required

Bank city

swift_bank_country

string

required

Two-letter ISO country code of bank

swift_bank_state_province_region

string

required

Bank state, province, or region

swift_bank_postal_code

string

required

Bank postal code

Intermediary Bank (Optional)

Required for some international transfers where a correspondent bank is needed.

swift_intermediary_bank_swift_code_bic

string | null

required

SWIFT/BIC code of intermediary bank

swift_intermediary_bank_account_number_iban

string | null

required

Account number at intermediary bank

swift_intermediary_bank_name

string | null

required

Name of intermediary bank

swift_intermediary_bank_country

string | null

required

Two-letter ISO country code of intermediary bank

Response

Returns an international SWIFT account object with type: "international_swift" and all provided fields.

Client

Receivers

Payments

Wallets & Accounts

Instance Management

Utilities

Documentation Index

​Supported Payment Rails

​List Bank Accounts

​Parameters

​Response

​Get Bank Account

​Parameters

​Response

​Delete Bank Account

​Parameters

​Response

​Create ACH Bank Account

​Parameters

​Response

​Create Wire Bank Account

​Parameters

​Response

​Create RTP Bank Account

​Parameters

​Response

​Create PIX Bank Account

​Parameters

​Response

​Create SPEI Bank Account

​Parameters

​Response

​Create Argentina Transfers Bank Account

​Parameters

​Response

​Create Colombia ACH Bank Account

​Parameters

​Response

​Create International SWIFT Bank Account

​Parameters

​Beneficiary Information

​Bank Information

​Intermediary Bank (Optional)

​Response

Build docs developers (and LLMs) love

Supported Payment Rails

List Bank Accounts

Parameters

Response

Get Bank Account

Parameters

Response

Delete Bank Account

Parameters

Response

Create ACH Bank Account

Parameters

Response

Create Wire Bank Account

Parameters

Response

Create RTP Bank Account

Parameters

Response

Create PIX Bank Account

Parameters

Response

Create SPEI Bank Account

Parameters

Response

Create Argentina Transfers Bank Account

Parameters

Response

Create Colombia ACH Bank Account

Parameters

Response

Create International SWIFT Bank Account

Parameters

Beneficiary Information

Bank Information

Intermediary Bank (Optional)

Response