--- title: "Create a Payment Method" method: POST path: "/v1/companies/{company_id}/payment-methods" tags: ["Payment Methods"] --- # Create a Payment Method `POST /v1/companies/{company_id}/payment-methods` Create a new `PaymentMethod` attached to a `Company`. Please note that there are **four** different types of `PaymentMethods`: `address`, `bank`, `international`, and `paypal`. Companies may have up to six `bank` `PaymentMethods` attached to them. This limit does not apply to other `types` of `PaymentMethods`. ## Path parameters - `company_id` string, uuid, required ## Request body - union - PaymentMethodsAddressNewPaymentMethodAddress - `type` 'address', required — The type of Payment Method. - `type_details` PaymentMethodsAddressPaymentMethodAddressTypeDetails, required - `address_line_1` string, required — The address' first line. - `address_line_2` string, nullable — The address' second line. - `city` string, required — The address' city. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required — Country code in ISO 3166-1 Alpha-2 format. - `postal_code` string, required — The address' postal code. - `state` string, required — The address' state, province or territory. - `attention_line` string — If provided, this will be added as a 'to the attention line of' line printed on the envelope the check is mailed in. - `print_business_name` string, nullable — The business name to print on the check as the payee. If `recipient` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `print_name` string, nullable — The payee name to print on the check. If `print_business_name` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `recipient` string, nullable — The recipient that will be printed on the envelope when the check is mailed. If omitted, `print_business_name` will be used. - `is_primary` boolean — Whether this company account is marked as the primary account for a company. - PaymentMethodsBankNewPaymentMethodBank - `type` 'bank', required — The type of payment method. - `type_details` object, required - `account_number` string, required — The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required — The type of bank account. - `routing_number` string, required — The bank's routing number. - `is_primary` boolean — Whether this company account is marked as the primary account for a Company. - PaymentMethodsInternationalNewPaymentMethodInternational - `type` 'international', required — The type of payment method. - `type_details` PaymentMethodsInternationalNewPaymentMethodInternationalTypeDetails, required - `account_number` string — Bank account number. - `bank_code` string — Bank or institution number. - `beneficiary_details` object, nullable — Extra beneficiary data. - `bic_swift` string — SWIFT business code. - `branch_code` string — Branch number. - `bsb_code` string — Bank State Branch code. - `clabe` string, nullable — A CLABE (Clave Bancaria Estandarizada | Standardized Bank Code) is necessary for sending payments to vendors in Mexico. - `cnaps` string, nullable — A CNAPS (China National Advanced Payment System) code is necessary for sending payments via Chinese Yuan (CNY) to vendors in China. - `country_code` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required — Country code in ISO 3166-1 Alpha-2 format. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR', required — An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `iban` string — International Bank Account Number. - `ifsc` string, nullable — An IFSC (Indian Financial System Code) code is necessary for sending payments via Indian Rupees (INR) to vendors in India. - `institution_name` string — Bank name. - `sort_code` string — Bank and branch code used in the British banking industry. - `payment_types` 'all' | 'priority' | 'regular' — International Payment Types. - `apply_registered_address` boolean — Apply company's address to payment method. - `recipient_address` PaymentMethodsAddressPaymentMethodAddressTypeDetails - `address_line_1` string, required — The address' first line. - `address_line_2` string, nullable — The address' second line. - `city` string, required — The address' city. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required — Country code in ISO 3166-1 Alpha-2 format. - `postal_code` string, required — The address' postal code. - `state` string, required — The address' state, province or territory. - `attention_line` string — If provided, this will be added as a 'to the attention line of' line printed on the envelope the check is mailed in. - `print_business_name` string, nullable — The business name to print on the check as the payee. If `recipient` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `print_name` string, nullable — The payee name to print on the check. If `print_business_name` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `recipient` string, nullable — The recipient that will be printed on the envelope when the check is mailed. If omitted, `print_business_name` will be used. - `is_primary` boolean - PaymentMethodsPaypalNewPaymentMethodPayPal - `is_primary` boolean — Whether this PayPal account is marked as the primary account for a `Company`. - `type` 'paypal', required — The type of this `PaymentMethod`. - `type_details` PaymentMethodsPaypalPaymentMethodPayPalTypeDetails, required - `email` string, email, required — The Company's PayPal email address. ## Response `201` Created - union - object - `object` 'PaymentMethod', required — The object’s type (`PaymentMethod`). - `id` string, uuid, required — The `PaymentMethod` ID. - `archived_by` 'system' | 'team_member', nullable — Indicates who archived this `PaymentMethod`: | Value | Description | | ----------------- | -----------------------------------| | `null` | The `PaymentMethod` is not archived. | | `system` | Routable archived the `PaymentMethod` automatically. | | `team_member` | A member of your team archived the `PaymentMethod`. | - `created_at` string, date-time, required — The timestamp at which this `PaymentMethod` was created. - `delivery_method` 'ach' | 'check' | 'international' | 'paypal', required — The type of `Payables` that can be created with this `PaymentMethod`. *Deprecated.* Use the `delivery_methods` object instead. - `delivery_methods` object — The `Payable` `types` supported by this `PaymentMethod`. Each contains an array of supported `delivery_method` options. - `ach` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for an `ach` payment. - `check` string[] — The `delivery_method` options when you use this `PaymentMethod` for a `check` `Payable`. - `international` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for an `international` payment. - `paypal` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for a `paypal` payment. - `is_archived` boolean, required — When `true`, this `PaymentMethod` has been archived and is unavailable for transactions. - `is_instant_preferred` boolean, required — When `true`, Instant Payments are your vendor's preferred speed using this `PaymentMethod`. - `is_created_by_company` boolean, required — When `true`, this `PaymentMethod` was added by a `Contact` of the `Company` during onboarding. - `is_last_chosen_by_company` boolean — If true, this `PaymentMethod` was explicitly selected by your vendor the last time they were asked to choose a `PaymentMethod`. No more than one `PaymentMethod` per `Company` can have this value set to `true`. - `is_preferred_by_company` boolean, required — Whether this `PaymentMethod` is your vendor's preferred account for receiving payments. - `is_primary` boolean, required — Whether this `PaymentMethod` is your primary account for a vendor's payments. - `is_valid` boolean, required — When `true`, this `PaymentMethod` can be used for transactions. `false` means the `PaymentMethod` is archived, deleted, disabled, or a `Company`-created `bank` `PaymentMethod` that has not yet been `verified` via Plaid or microdeposits. (`PaymentMethods` added by a `team_member`, either through the API or the Routable Dashboard, do not require validation.) - `name` string, required — The name of the `PaymentMethod`. - `verification_status` 'failed' | 'not_verified' | 'pending' | 'verified', required — The verification state of this payment method: | Value | Description | | ----------------- | -----------------------------------| | `failed` | Verification failed. | | `not_verified` | No verification required (`TeamMember`-created or not a `bank` `PaymentMethod`). | | `pending` | Verification has not started or is in progress. | | `verified` | Successfully verified. | - `links` PaymentMethodsCommonPaymentMethodLinks, required — Related links. - `self` string, uri-reference, required — Link to this object. - `company` string, uri-reference, required — Link to this `PaymentMethod`'s `Company`. - `type` 'address', required — The type of Payment Method. - `type_details` PaymentMethodsAddressPaymentMethodAddressTypeDetails, required - `address_line_1` string, required — The address' first line. - `address_line_2` string, nullable — The address' second line. - `city` string, required — The address' city. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required — Country code in ISO 3166-1 Alpha-2 format. - `postal_code` string, required — The address' postal code. - `state` string, required — The address' state, province or territory. - `attention_line` string — If provided, this will be added as a 'to the attention line of' line printed on the envelope the check is mailed in. - `print_business_name` string, nullable — The business name to print on the check as the payee. If `recipient` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `print_name` string, nullable — The payee name to print on the check. If `print_business_name` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `recipient` string, nullable — The recipient that will be printed on the envelope when the check is mailed. If omitted, `print_business_name` will be used. - object - `object` 'PaymentMethod', required — The object’s type (`PaymentMethod`). - `id` string, uuid, required — The `PaymentMethod` ID. - `archived_by` 'system' | 'team_member', nullable — Indicates who archived this `PaymentMethod`: | Value | Description | | ----------------- | -----------------------------------| | `null` | The `PaymentMethod` is not archived. | | `system` | Routable archived the `PaymentMethod` automatically. | | `team_member` | A member of your team archived the `PaymentMethod`. | - `created_at` string, date-time, required — The timestamp at which this `PaymentMethod` was created. - `delivery_method` 'ach' | 'check' | 'international' | 'paypal', required — The type of `Payables` that can be created with this `PaymentMethod`. *Deprecated.* Use the `delivery_methods` object instead. - `delivery_methods` object — The `Payable` `types` supported by this `PaymentMethod`. Each contains an array of supported `delivery_method` options. - `ach` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for an `ach` payment. - `check` string[] — The `delivery_method` options when you use this `PaymentMethod` for a `check` `Payable`. - `international` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for an `international` payment. - `paypal` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for a `paypal` payment. - `is_archived` boolean, required — When `true`, this `PaymentMethod` has been archived and is unavailable for transactions. - `is_instant_preferred` boolean, required — When `true`, Instant Payments are your vendor's preferred speed using this `PaymentMethod`. - `is_created_by_company` boolean, required — When `true`, this `PaymentMethod` was added by a `Contact` of the `Company` during onboarding. - `is_last_chosen_by_company` boolean — If true, this `PaymentMethod` was explicitly selected by your vendor the last time they were asked to choose a `PaymentMethod`. No more than one `PaymentMethod` per `Company` can have this value set to `true`. - `is_preferred_by_company` boolean, required — Whether this `PaymentMethod` is your vendor's preferred account for receiving payments. - `is_primary` boolean, required — Whether this `PaymentMethod` is your primary account for a vendor's payments. - `is_valid` boolean, required — When `true`, this `PaymentMethod` can be used for transactions. `false` means the `PaymentMethod` is archived, deleted, disabled, or a `Company`-created `bank` `PaymentMethod` that has not yet been `verified` via Plaid or microdeposits. (`PaymentMethods` added by a `team_member`, either through the API or the Routable Dashboard, do not require validation.) - `name` string, required — The name of the `PaymentMethod`. - `verification_status` 'failed' | 'not_verified' | 'pending' | 'verified', required — The verification state of this payment method: | Value | Description | | ----------------- | -----------------------------------| | `failed` | Verification failed. | | `not_verified` | No verification required (`TeamMember`-created or not a `bank` `PaymentMethod`). | | `pending` | Verification has not started or is in progress. | | `verified` | Successfully verified. | - `links` PaymentMethodsCommonPaymentMethodLinks, required — Related links. - `self` string, uri-reference, required — Link to this object. - `company` string, uri-reference, required — Link to this `PaymentMethod`'s `Company`. - `type` 'bank', required — The type of Payment Method. - `type_details` PaymentMethodsBankPaymentMethodBankTypeDetails, required - `account_number` string, required — The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required — The type of bank account. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' — An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `institution_name` string, required — The bank's name. - `logo` string, uri — The URL of the bank's logo in PNG format. - `primary_color` string — The bank's primary color hex code. - `routing_number` string — The bank's routing number. - object - `object` 'PaymentMethod', required — The object’s type (`PaymentMethod`). - `id` string, uuid, required — The `PaymentMethod` ID. - `archived_by` 'system' | 'team_member', nullable — Indicates who archived this `PaymentMethod`: | Value | Description | | ----------------- | -----------------------------------| | `null` | The `PaymentMethod` is not archived. | | `system` | Routable archived the `PaymentMethod` automatically. | | `team_member` | A member of your team archived the `PaymentMethod`. | - `created_at` string, date-time, required — The timestamp at which this `PaymentMethod` was created. - `delivery_method` 'ach' | 'check' | 'international' | 'paypal', required — The type of `Payables` that can be created with this `PaymentMethod`. *Deprecated.* Use the `delivery_methods` object instead. - `delivery_methods` object — The `Payable` `types` supported by this `PaymentMethod`. Each contains an array of supported `delivery_method` options. - `ach` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for an `ach` payment. - `check` string[] — The `delivery_method` options when you use this `PaymentMethod` for a `check` `Payable`. - `international` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for an `international` payment. - `paypal` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for a `paypal` payment. - `is_archived` boolean, required — When `true`, this `PaymentMethod` has been archived and is unavailable for transactions. - `is_instant_preferred` boolean, required — When `true`, Instant Payments are your vendor's preferred speed using this `PaymentMethod`. - `is_created_by_company` boolean, required — When `true`, this `PaymentMethod` was added by a `Contact` of the `Company` during onboarding. - `is_last_chosen_by_company` boolean — If true, this `PaymentMethod` was explicitly selected by your vendor the last time they were asked to choose a `PaymentMethod`. No more than one `PaymentMethod` per `Company` can have this value set to `true`. - `is_preferred_by_company` boolean, required — Whether this `PaymentMethod` is your vendor's preferred account for receiving payments. - `is_primary` boolean, required — Whether this `PaymentMethod` is your primary account for a vendor's payments. - `is_valid` boolean, required — When `true`, this `PaymentMethod` can be used for transactions. `false` means the `PaymentMethod` is archived, deleted, disabled, or a `Company`-created `bank` `PaymentMethod` that has not yet been `verified` via Plaid or microdeposits. (`PaymentMethods` added by a `team_member`, either through the API or the Routable Dashboard, do not require validation.) - `name` string, required — The name of the `PaymentMethod`. - `verification_status` 'failed' | 'not_verified' | 'pending' | 'verified', required — The verification state of this payment method: | Value | Description | | ----------------- | -----------------------------------| | `failed` | Verification failed. | | `not_verified` | No verification required (`TeamMember`-created or not a `bank` `PaymentMethod`). | | `pending` | Verification has not started or is in progress. | | `verified` | Successfully verified. | - `links` PaymentMethodsCommonPaymentMethodLinks, required — Related links. - `self` string, uri-reference, required — Link to this object. - `company` string, uri-reference, required — Link to this `PaymentMethod`'s `Company`. - `type` 'international', required — The type of Payment Method - `type_details` PaymentMethodsInternationalPaymentMethodInternationalTypeDetails, required - `account_number` string, nullable — Bank account number. In responses, all but the last four digits will be masked for security. - `bank_code` string, nullable — Bank or institution number. - `beneficiary_details` object, nullable — Extra beneficiary data. - `bic_swift` string, nullable — SWIFT business code. - `branch_code` string, nullable — Branch number. - `bsb_code` string, nullable — Bank State Branch code. - `clabe` string, nullable — A CLABE (Clave Bancaria Estandarizada | Standardized Bank Code) is necessary for sending payments to vendors in Mexico. - `cnaps` string, nullable — A CNAPS (China National Advanced Payment System) code is necessary for sending payments via Chinese Yuan (CNY) to vendors in China. - `country_code` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' — Country code in ISO 3166-1 Alpha-2 format. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' — An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `iban` string, nullable — International Bank Account Number. - `ifsc` string, nullable — An IFSC (Indian Financial System Code) code is necessary for sending payments via Indian Rupees (INR) to vendors in India. - `institution_name` string, nullable — Bank name. - `payment_types` 'all' | 'priority' | 'regular' — Legacy SWIFT payment types supported. This field is `deprecated` and will be ignored if submitted. - `recipient_address` SharedAddress - `address_line_1` string, required — The address' first line. - `address_line_2` string, nullable — The address' second line. - `city` string, required — The address' city. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required — Country code in ISO 3166-1 Alpha-2 format. - `postal_code` string, required — The address' postal code. - `state` string — The address' state, province or territory. - `sort_code` string, nullable — Bank and branch code used in the British banking industry. - object - `object` 'PaymentMethod', required — The object’s type (`PaymentMethod`). - `id` string, uuid, required — The `PaymentMethod` ID. - `archived_by` 'system' | 'team_member', nullable — Indicates who archived this `PaymentMethod`: | Value | Description | | ----------------- | -----------------------------------| | `null` | The `PaymentMethod` is not archived. | | `system` | Routable archived the `PaymentMethod` automatically. | | `team_member` | A member of your team archived the `PaymentMethod`. | - `created_at` string, date-time, required — The timestamp at which this `PaymentMethod` was created. - `delivery_method` 'ach' | 'check' | 'international' | 'paypal', required — The type of `Payables` that can be created with this `PaymentMethod`. *Deprecated.* Use the `delivery_methods` object instead. - `delivery_methods` object — The `Payable` `types` supported by this `PaymentMethod`. Each contains an array of supported `delivery_method` options. - `ach` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for an `ach` payment. - `check` string[] — The `delivery_method` options when you use this `PaymentMethod` for a `check` `Payable`. - `international` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for an `international` payment. - `paypal` string[] — The `delivery_method` options supported when you use this `PaymentMethod` for a `paypal` payment. - `is_archived` boolean, required — When `true`, this `PaymentMethod` has been archived and is unavailable for transactions. - `is_instant_preferred` boolean, required — When `true`, Instant Payments are your vendor's preferred speed using this `PaymentMethod`. - `is_created_by_company` boolean, required — When `true`, this `PaymentMethod` was added by a `Contact` of the `Company` during onboarding. - `is_last_chosen_by_company` boolean — If true, this `PaymentMethod` was explicitly selected by your vendor the last time they were asked to choose a `PaymentMethod`. No more than one `PaymentMethod` per `Company` can have this value set to `true`. - `is_preferred_by_company` boolean, required — Whether this `PaymentMethod` is your vendor's preferred account for receiving payments. - `is_primary` boolean, required — Whether this `PaymentMethod` is your primary account for a vendor's payments. - `is_valid` boolean, required — When `true`, this `PaymentMethod` can be used for transactions. `false` means the `PaymentMethod` is archived, deleted, disabled, or a `Company`-created `bank` `PaymentMethod` that has not yet been `verified` via Plaid or microdeposits. (`PaymentMethods` added by a `team_member`, either through the API or the Routable Dashboard, do not require validation.) - `name` string, required — The name of the `PaymentMethod`. - `verification_status` 'failed' | 'not_verified' | 'pending' | 'verified', required — The verification state of this payment method: | Value | Description | | ----------------- | -----------------------------------| | `failed` | Verification failed. | | `not_verified` | No verification required (`TeamMember`-created or not a `bank` `PaymentMethod`). | | `pending` | Verification has not started or is in progress. | | `verified` | Successfully verified. | - `links` PaymentMethodsCommonPaymentMethodLinks, required — Related links. - `self` string, uri-reference, required — Link to this object. - `company` string, uri-reference, required — Link to this `PaymentMethod`'s `Company`. - `type` 'paypal', required — The type of the `PaymentMethod`. - `type_details` PaymentMethodsPaypalPaymentMethodPayPalTypeDetails, required - `email` string, email, required — The Company's PayPal email address. --- [API](https://skmtc.net/routable/apis/routable-api.md) · [All operations](https://skmtc.net/routable/apis/routable-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/routable/routable-api/revisions/9f17a8bc982a/schema)