Utilities

Methods for querying available payment rails and bank detail requirements

The available resource provides utility methods to discover supported payment rails and their required bank details.

Methods

getRails()

Retrieve all available payment rails supported by BlindPay.

const { data, error } = await blindpay.available.getRails();

data · array

Array of available payment rails

Show properties

label · string · required

Human-readable name of the payment rail

value · Rail · required

The rail identifier. One of: "wire", "ach", "pix", "spei_bitso", "transfers_bitso", "ach_cop_bitso", "international_swift", or "rtp"

country · string · required

Two-letter ISO country code (e.g., “US”, “BR”, “MX”)

error · ErrorResponse | null

Error object if the request failed, null otherwise

Example Response

[
  {
    "label": "Domestic Wire",
    "value": "wire",
    "country": "US"
  },
  {
    "label": "ACH",
    "value": "ach",
    "country": "US"
  },
  {
    "label": "PIX",
    "value": "pix",
    "country": "BR"
  },
  {
    "label": "SPEI",
    "value": "spei_bitso",
    "country": "MX"
  },
  {
    "label": "Transfers 3.0",
    "value": "transfers_bitso",
    "country": "AR"
  },
  {
    "label": "ACH Colombia",
    "value": "ach_cop_bitso",
    "country": "CO"
  },
  {
    "label": "International Swift",
    "value": "international_swift",
    "country": "US"
  },
  {
    "label": "RTP",
    "value": "rtp",
    "country": "US"
  }
]

---

getBankDetails()

Get the required bank detail fields for a specific payment rail. This method returns the fields you need to collect when creating a bank account for the specified rail.

const { data, error } = await blindpay.available.getBankDetails("pix");

rail · Rail · required

The payment rail to query. Must be one of: "wire", "ach", "pix", "spei_bitso", "transfers_bitso", "ach_cop_bitso", "international_swift", or "rtp"

data · array

Array of bank detail field requirements

Show properties

label · string · required

Human-readable label for the field

key · BankDetailKey · required

The field identifier used when creating bank accounts. See BankDetailKey enum for all possible values.

regex · string · required

Validation regex pattern for the field (empty string if no pattern required)

required · boolean · required

Whether this field is required

items · array

Array of predefined options for select-type fields

Show properties

label · string · required

Display label for the option

value · string · required

The value to submit

is_active · boolean

Whether this option is currently active

error · ErrorResponse | null

Error object if the request failed, null otherwise

Example Response

[
  {
    "label": "Account Type",
    "regex": "",
    "key": "account_type",
    "items": [
      {
        "label": "Checking",
        "value": "checking"
      },
      {
        "label": "Savings",
        "value": "saving"
      }
    ],
    "required": true
  }
]

---

getSwiftCodeBankDetails()

Look up bank information using a SWIFT/BIC code. This is useful for validating and auto-filling bank details for international SWIFT transfers.

const { data, error } = await blindpay.available.getSwiftCodeBankDetails("BOFAUS3NLMA");

swiftCode · string · required

The SWIFT/BIC code to look up (e.g., “BOFAUS3NLMA”)

data · array

Array of matching bank records for the SWIFT code

Show properties

id · string · required

Unique identifier for this SWIFT code entry

bank · string · required

Full name of the bank

city · string · required

City where the bank branch is located

branch · string · required

Branch name or identifier

swiftCode · string · required

The SWIFT/BIC code

swiftCodeLink · string · required

URL to more information about this SWIFT code

country · string · required

Full country name

countrySlug · string · required

URL-friendly country identifier

error · ErrorResponse | null

Error object if the request failed, null otherwise

Example Response

[
  {
    "id": "416",
    "bank": "BANK OF AMERICA, N.A.",
    "city": "NEW JERSEY",
    "branch": "LENDING SERVICES AND OPERATIONS (LSOP)",
    "swiftCode": "BOFAUS3NLMA",
    "swiftCodeLink": "https://bank.codes/swift-code/united-states/bofaus3nlma/",
    "country": "United States",
    "countrySlug": "united-states"
  }
]

---

Type Reference

Rail enum

Payment rail identifiers supported by BlindPay:

Value	Description
"wire"	Domestic Wire (US)
"ach"	ACH (US)
"pix"	PIX (Brazil)
"spei_bitso"	SPEI (Mexico)
"transfers_bitso"	Transfers 3.0 (Argentina)
"ach_cop_bitso"	ACH Colombia
"international_swift"	International SWIFT
"rtp"	Real-Time Payments (US)

BankDetailKey enum

Bank detail field identifiers used in bank account creation. The required fields vary by payment rail:

General Fields

• "type" - Account type
• "name" - Bank name
• "beneficiary_name" - Account holder name
• "routing_number" - Bank routing number
• "account_number" - Account number
• "account_type" - Type of account (checking/savings)
• "account_class" - Individual or business account

Address Fields

• "address_line_1" - Primary address line
• "address_line_2" - Secondary address line
• "city" - City
• "state_province_region" - State, province, or region
• "country" - Country code
• "postal_code" - Postal/ZIP code

PIX (Brazil)

• "pix_key" - PIX key identifier

SPEI (Mexico)

• "spei_protocol" - SPEI protocol type
• "spei_institution_code" - Bank institution code
• "spei_clabe" - CLABE number (18-digit bank account number)

Transfers (Argentina)

• "transfers_type" - Transfer type (CVU, CBU, ALIAS)
• "transfers_account" - Account identifier

ACH Colombia

• "ach_cop_beneficiary_first_name" - Beneficiary first name
• "ach_cop_beneficiary_last_name" - Beneficiary last name
• "ach_cop_document_id" - Document ID number
• "ach_cop_document_type" - Document type (CC, CE, NIT, PASS, PEP)
• "ach_cop_email" - Email address
• "ach_cop_bank_code" - Bank code
• "ach_cop_bank_account" - Bank account number

International SWIFT

• "swift_code_bic" - SWIFT/BIC code
• "swift_account_holder_name" - Account holder name
• "swift_account_number_iban" - Account number or IBAN
• "swift_beneficiary_address_line_1" - Beneficiary address line 1
• "swift_beneficiary_address_line_2" - Beneficiary address line 2
• "swift_beneficiary_country" - Beneficiary country
• "swift_beneficiary_city" - Beneficiary city
• "swift_beneficiary_state_province_region" - Beneficiary state/province/region
• "swift_beneficiary_postal_code" - Beneficiary postal code
• "swift_bank_name" - Bank name
• "swift_bank_address_line_1" - Bank address line 1
• "swift_bank_address_line_2" - Bank address line 2
• "swift_bank_country" - Bank country
• "swift_bank_city" - Bank city
• "swift_bank_state_province_region" - Bank state/province/region
• "swift_bank_postal_code" - Bank postal code

SWIFT Intermediary Bank (Optional)

• "swift_intermediary_bank_swift_code_bic" - Intermediary bank SWIFT/BIC
• "swift_intermediary_bank_account_number_iban" - Intermediary bank account/IBAN
• "swift_intermediary_bank_name" - Intermediary bank name
• "swift_intermediary_bank_country" - Intermediary bank country

Checkbook (Legacy)

• "checkbook_account_id" - Checkbook account ID
• "checkbook_user_key" - Checkbook user key