Routing Details

A routing_detail object represents the specific routing information required to transact with someone's bank account. A single bank account in the United States often has different instructions for ACH, domestic wires, and international wires. Using routing details we can encapsulate all these different routing instructions and assign them to a single account.

Modern Treasury validates routing numbers when creating a Routing Detail object to make sure they are acceptable.

AttributeDescription
id
string
The ID of the routing detail.
payment_type
string
If the routing detail is to be used for a specific payment type this field will be populated, otherwise null.
routing_number
string
The routing number of the bank.
bank_name
string
The name of the bank.
bank_address
object
The address of the bank.
live_mode
boolean
This field will be true if this object was created with a production API key or false if created with a test API key.
routing_number_type
string
One of
"aba", (USA)
"au_bsb", (Australia)
"br_codigo", (Brazil)
"ca_cpa", (Canada)
"chips", (USA)
"cnaps", (China)
"dk_interbank_clearing_code", (Denmark)
"gb_sort_code", (UK)
"hk_interbank_clearing_code", (Hong Kong)
"hu_interbank_clearing_code", (Hungary)
"id_sknbi_code", (Indonesia)
"in_ifsc", (India)
"jp_zengin_code", (Japan)
"my_branch_code", (Malaysia)
"mx_bank_identifier", (Mexico)
"nz_national_clearing_code", (New Zealand)
"pl_national_clearing_code", (Poland)
"se_bankgiro_clearing_code", (Sweden)
"swift", (International SWIFT BIC, SEPA)
"za_national_clearing_code" (South Africa)
{
  "id": "2e90da60-405c-44bc-8b33-2bdb9419afe3",
  "object": "routing_detail",
  "payment_type": null,
  "routing_number": "021000021",
  "routing_number_type": "aba",
  "bank_name": "Gringotts Wizarding Bank",
  "bank_address": {
    "id": "fcf5ebe1-b990-4684-880f-f69c277106bb",
    "object": "address",
    "line1": "6000 Universal Boulevard",
    "line2": null,
    "locality": "Orlando",
    "region": "FL",
    "postal_code": "32819",
    "country": "US"
  },
  "live_mode": true,
  "created_at": "2019-11-09T00:11:07Z",
  "updated_at": "2019-11-09T00:11:07Z"
}