bank-details

Request

Property	Type	Required	Description
`address-1`	string	Optional	First line of street address of vendor bank. Maximum 60 characters.
`address-2`	string	Optional	Second line of street address of vendor bank. Maximum 60 characters.
`city`	string	Optional	City of vendor bank. Maximum 40 characters.
`state`	string	Required if country is US or CA	State or province code of vendor bank. Refer to State and Province Codes.
`country`	string	Required	Country code of vendor bank. Refer to Country Codes.
`zip-code`	string	Optional	Zip/Postal code of vendor bank. Maximum 10 characters.
`bic`	string	Either `bank-id` or `bic` is required, but not both.	The Bank Identifier Code of vendor bank for wire transfers. Maximum 50 alphanumeric characters.
`bank-id`	string	Either `bank-id` or `bic` is required, but not both.	Bank identifier, routing number, sort code, or BSB. Maximum 35 characters.
`bank-name`	string	Required	Name of vendor bank. Maximum 140 characters.
`account-id`	string	Either `account-id` or `iban` is required, but not both.	Vendor bank account number. Maximum 34 characters.
`name-on-account`	string	Required	Name on bank account for vendor. Valid value: 3–140 alphanumeric characters
`intermediary-bic`	string	Optional	The Bank Identifier Code of intermediary bank for wire transfers. Maximum 50 alphanumeric characters.
`intermediary-bank-name`	string	Optional	Name of intermediary bank. Maximum 140 characters.
`intermediary-bank-state`	string	Optional	State or province code of intermediary bank. Refer to State and Province Codes.
`intermediary-bank-country`	string	Optional	Country code of intermediary bank. Refer to Country Codes.
`iban`	string	Either `account-id` or `iban` is required, but not both.	Vendor International Bank Account Number (IBAN). 15–31 alphanumeric characters.
`payment-reference`	string	Optional	Reference text that appears on your vendor's bank statement when they are paid out. If left blank, this is the standard message (i.e. "BlueSnap Payment {Payment ID} for Merchant {Merchant ID}"). Learn more. Maximum 100 alphanumeric characters. Notes: Not applicable if payout-payment-type is ACH and currency is CAD. If the bank account is located in the UK, the payment reference field cannot be used for Faster Payments, but it can be used for CHAPS.
`ach-account-class`	string	Optional	Class of ACH bank account. Possible values: PERSONAL CORPORATE INTERNATIONAL
`ach-account-type`	string	Optional	Type of bank account. Possible values: CHECKING SAVINGS
`additional-information`	string	Optional	Any additional custom fields.
`sort-code`	string	Optional	Identifies a specific bank branch.

Response

Property	Type	Required	Description
`address-1`	string	Optional	First line of street address of vendor bank. Maximum 60 characters.
`address-2`	string	Optional	Second line of street address of vendor bank. Maximum 60 characters.
`city`	string	Optional	City of vendor bank. Maximum 40 characters.
`state`	string	Required if country is US or CA	State or province code of vendor bank. Refer to State and Province Codes.
`country`	string	Required	Country code of vendor bank. Refer to Country Codes.
`zip-code`	string	Optional	Zip/Postal code of vendor bank. Maximum 10 characters.
`bic`	string	Either `bank-id` or `bic` is required, but not both.	The Bank Identifier Code of vendor bank for wire transfers. Maximum 50 alphanumeric characters.
`bank-id`	string	Either `bank-id` or `bic` is required, but not both.	Bank identifier, routing number, sort code, or BSB. Maximum 35 characters.
`bank-name`	string	Required	Name of vendor bank. Maximum 140 characters.
`account-id`	string	Either `account-id` or `iban` is required, but not both.	Vendor bank account number. Maximum 34 characters.
`name-on-account`	string	Required	Name on bank account for vendor. Valid value: 3–140 alphanumeric characters
`intermediary-bic`	string	Optional	The Bank Identifier Code of intermediary bank for wire transfers. Maximum 50 alphanumeric characters.
`intermediary-bank-name`	string	Optional	Name of intermediary bank. Maximum 140 characters.
`intermediary-bank-state`	string	Optional	State or province code of intermediary bank. Refer to State and Province Codes.
`intermediary-bank-country`	string	Optional	Country code of intermediary bank. Refer to Country Codes.
`iban`	string	Either `account-id` or `iban` is required, but not both.	Vendor International Bank Account Number (IBAN). 15–31 alphanumeric characters.
`payment-reference`	string	Optional	Reference text that appears on your vendor's bank statement when they are paid out. If left blank, this is the standard message (i.e. "BlueSnap Payment {Payment ID} for Merchant {Merchant ID}"). Learn more. Maximum 100 alphanumeric characters. Notes: Not applicable if payout-payment-type is ACH and currency is CAD. If the bank account is located in the UK, the payment reference field cannot be used for Faster Payments, but it can be used for CHAPS.
`ach-account-class`	string	Optional	Class of ACH bank account. Possible values: PERSONAL CORPORATE INTERNATIONAL
`ach-account-type`	string	Optional	Type of bank account. Possible values: CHECKING SAVINGS
`additional-information`	string	Optional	Any additional custom fields.
`status`	string	Optional	Indicates whether bank details are active ("A") or pending "P"). This is a read-only field that should not be provided in vendor requests.
`sort-code`	string	Optional	Identifies a specific bank branch.