Sign in
External Bank Accounts

Update an external account

Update mutable fields on an existing external bank account.

Adding payment rails

Create does not merge rails when the same bank identity already exists. To enable additional compatible rails (e.g. add ACH to a US account created with WIRE only), PATCH with paymentRails set to the full resulting list — existing rails plus any to add.

  • Existing rails cannot be removed.
  • New rails must be compatible with the account's stored bank details and with each other.
  • Proxy accounts cannot change paymentRails.
patch/v1/external-bank-accounts/{id}

Path parameters

idstring required

External account ID

Headers

X-API-Keystring

API key

Request body

beneficiaryType'INDIVIDUAL' | 'BUSINESS'

Beneficiary type

beneficiaryNamestring

Beneficiary full name

beneficiaryPhonestring

Beneficiary phone number

beneficiaryDateOfBirthstring date

Account holder's date of birth

beneficiaryDocumentTypestring

Type of the beneficiary's national/tax identification document. Rail-specific codes — see the field on account creation.

beneficiaryDocumentNumberstring

The beneficiary's national/tax identification document number (e.g. EIN for US business beneficiaries). Payouts on rails that require it fail without it.

bankNamestring

Bank name

paymentRailsstring[]

Adds compatible payment rails to this account. Send the full resulting list (existing rails plus any to add). Existing rails cannot be removed.

Rails must be compatible with each other and with the account's stored bank details (e.g. add RTP to a US ACH/WIRE account; do not mix SEPA with a US routing-number account).

currencyCodesstring[]

Currency codes supported by this account. Only updatable for accounts with Hong Kong (CHATS) or SWIFT payment rails.

bankAccountType'checking' | 'savings'

Bank account type (checking or savings)

Example request

{
  "beneficiaryType": "INDIVIDUAL",
  "beneficiaryName": "John Smith",
  "beneficiaryAddress": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94102",
    "country": "US",
    "transliterated": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Apt 4B",
      "city": "Beijing",
      "state": "Hebei"
    }
  },
  "beneficiaryPhone": "+1234567890",
  "beneficiaryDateOfBirth": "1990-01-31",
  "beneficiaryDocumentType": "EIN",
  "beneficiaryDocumentNumber": "12-3456789",
  "bankName": "JPMorgan Chase Bank",
  "bankAddress": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94102",
    "country": "US"
  },
  "paymentRails": [
    "ACH",
    "WIRE",
    "RTP"
  ],
  "currencyCodes": [
    "USD",
    "EUR",
    "GBP"
  ],
  "bankAccountType": "checking",
  "metadata": {
    "nickname": "Main Checking Account",
    "purpose": "Business operations",
    "tags": [
      "primary",
      "operations"
    ]
  }
}

Response

External account updated successfully

idstring required

Account ID

customerIdstring required

Customer ID

counterpartyIdstring nullable

Counterparty ID when this is a third-party recipient account

type'EXTERNAL_BANK' | 'EXTERNAL_PROXY' required

Account type

status'IN_REVIEW' | 'ACTIVE' | 'CLOSED' required

Account status

beneficiaryType'INDIVIDUAL' | 'BUSINESS' required

Beneficiary type

beneficiaryNamestring required

Beneficiary name

paymentRail'ACH' | 'ACH_SAME_DAY' | 'WIRE' | 'FEDWIRE' | 'FED_NOW' | 'RTP' | 'EREBOR' | 'EREBOR_RAIL' | 'BALANCE' | 'SWIFT' | 'SEPA' | 'SEPA_INSTANT' | 'TIPS' | 'FASTER_PAYMENTS' | 'BACS' | 'CHAPS' | 'ELIXIR' | 'NICS' | 'EFT' | 'INTERAC' | 'NPP' | 'BECS' | 'UPI' | 'IMPS' | 'IMPS_WITH_FIRC' | 'NEFT' | 'RTGS' | 'BI_FAST' | 'ARTAJASA' | 'PIX' | 'TED' | 'TEF' | 'SPEI' | 'COELSA' | 'SINPE' | 'CIPS' | 'CFXPS' | 'CHATS' | 'ZENGIN' | 'KFTC' | 'FAST_SG' | 'MEPS' | 'DUITNOW' | 'PROMPTPAY' | 'INSTAPAY' | 'PESONET' | 'NAPAS' | 'BEFTN' | 'SLIPS' | 'ZAHAV' | 'GHIPSS' | 'NIBSS' | 'PESALINK' | 'RTC_ZA' | 'TZS_RTGS' | 'EGP_ACH' | 'JOD_ACH' | 'NPSS' | 'MADA' | 'QPS' | 'DOP_ACH' | 'GTQ_ACH' | 'HNL_ACH' | 'PEN_ACH' | 'JMD_ACH' | 'USD_ACH_SV' | 'USD_ACH_EC' | 'CLP_TEF' | 'PSE' | 'COP_ACH' | 'BOB_RTGS' | 'PYG_ACH' | 'CERTIS' | 'DKK_TIPS' | 'SENT' | 'NKS' | 'BANKGIROT' | 'HKD_FPS' | 'IBFT' | 'TRY_FAST' required

Primary payment rail for this account

paymentRailsstring[]

All payment rails this account supports (bank accounts only)

beneficiaryPhonestring nullable

Beneficiary phone number

beneficiaryDateOfBirthstring date

Account holder's date of birth

bankNamestring nullable

Bank name (bank accounts only)

swiftBicstring nullable

SWIFT/BIC code (bank accounts only)

ibanstring nullable

IBAN (bank accounts only)

accountNumberstring nullable

Bank account number (bank accounts only)

routingNumberstring nullable

Bank routing code (ABA routing number, sort code, BSB, IFSC, etc.)

branchCodestring nullable

Bank branch code (for countries like Japan, Brazil, South Africa that use separate branch identifiers)

beneficiaryDocumentTypestring

Type of the beneficiary's national/tax identification document (rail-specific codes, e.g. CC/NIT for Colombia, RUT for Chile)

beneficiaryDocumentNumberstring

The beneficiary's national/tax identification document number

beneficiaryStateProvincestring

The beneficiary's state/department/province (rails that require it on payouts, e.g. Peru ACH)

correspondentBankNamestring nullable

Correspondent/intermediary bank name (SWIFT)

correspondentBankSwiftCodestring nullable

Correspondent/intermediary bank SWIFT/BIC code (SWIFT)

correspondentAccountNumberstring nullable

Correspondent/intermediary account number (SWIFT)

bankAccountType'checking' | 'savings' nullable

Bank account type (bank accounts only)

currencyCodesstring[] nullable

Supported currency codes

aliasType'PHONE' | 'EMAIL' | 'NATIONAL_ID' | 'TAX_ID' | 'RANDOM' | 'CORPORATE_ID' nullable

Type of proxy alias (proxy accounts only)

aliasValuestring nullable

The proxy alias value (proxy accounts only)

createdAtstring date-time required

Account creation date

updatedAtstring date-time required

Account last update date

createdboolean

Present on create responses. true = a new account was inserted. false = an existing account matched (bank: customer + the exact normalized identifier set supplied; proxy: customer + alias + rail) and was reused. For bank accounts, existing paymentRails are not updated by create — use PATCH to add rails; missing create-only fields may still be backfilled and conflicting values return 400. For proxy accounts, inspect paymentRail (proxies do not return paymentRails).

Example response

{
  "id": "eba_1234567890abcdef",
  "customerId": "cust_abc123",
  "counterpartyId": "cp_abc123",
  "type": "EXTERNAL_BANK",
  "status": "IN_REVIEW",
  "beneficiaryType": "INDIVIDUAL",
  "beneficiaryName": "John Smith",
  "metadata": {
    "nickname": "Main Checking Account",
    "purpose": "Business operations",
    "tags": [
      "primary",
      "operations"
    ]
  },
  "paymentRail": "SWIFT",
  "paymentRails": [
    "ACH",
    "ACH_SAME_DAY",
    "WIRE"
  ],
  "beneficiaryAddress": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "beneficiaryPhone": "+12125551234",
  "beneficiaryDateOfBirth": "1990-01-31",
  "bankName": "JPMorgan Chase Bank",
  "bankAddress": {
    "addressLine1": "270 Park Avenue",
    "addressLine2": "Floor 10",
    "city": "New York",
    "state": "NY",
    "postalCode": "10017",
    "country": "US"
  },
  "swiftBic": "CHASUS33",
  "iban": "GB82WEST12345698765432",
  "accountNumber": "1234567890",
  "routingNumber": "021000021",
  "branchCode": "001",
  "beneficiaryDocumentType": "CC",
  "beneficiaryDocumentNumber": "12345678901",
  "beneficiaryStateProvince": "LIMA",
  "correspondentBankName": "Bank of America",
  "correspondentBankSwiftCode": "IRVTUS3NXXX",
  "correspondentAccountNumber": "9876543210",
  "bankAccountType": "checking",
  "currencyCodes": [
    "USD",
    "EUR"
  ],
  "aliasType": "TAX_ID",
  "aliasValue": "12345678901",
  "createdAt": "2026-01-15T10:00:00Z",
  "updatedAt": "2026-01-15T10:00:00Z",
  "created": true
}

Changes

Changed in 2 of the 19 revisions of this API.112

  • 856ef426cc172See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

  • 7d6487f295d711See the full diff
    • ▲

      added to the request property allOf list

      request-property-all-of-added

    • ●

      removed from the request property allOf list

      request-property-all-of-removed