payout-info

📘
This object has been deprecated and replaced by payout-configuration. If provided in a request such as Create or Update Vendor, an error will be returned.

Property Name	Type	Required	Description
`address`	string	Optional	Street address of vendor bank. Maximum 60 characters.
`bank-account-class`	string	Required	Type of bank account. Possible values: PERSONAL CORPORATE INTERNATIONAL
`bank-account-id`	string	Either `bank-account-id` or `iban` is required, but not both.	Vendor bank account number. Maximum 34 characters.
`bank-account-type`	string	Required	Account type. Possible values: CHECKING SAVINGS
`bank-id`	string	Either `bank-id` or `swift-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.
`base-currency`	string	Required	Payout currency for vendor's bank account. Possible values:AUD — Australia DollarCAD — Canada DollarCHF — Switzerland FrancDKK — Denmark KronerEUR — EuroGBP — United Kingdom PoundHKD — Hong Kong DollarJPY — Japan YenNOK — Norway KronerNZD — New Zealand DollarSEK — Sweden KronerUSD — US Dollar
`city`	string	Optional	City of vendor bank. Maximum 40 characters.
`country`	string	Required	Country code of vendor bank. Refer to Country codes
`iban`	string	Either `bank-account-id` or `iban` is required, but not both.	Vendor International Bank Account Number (IBAN). Between 15–31 alphanumeric characters.
`minimal-payout-amount`	string	Optional	Minimum amount for which a vendor may be paid out. If the vendor's account balance is below this amount, their balance is carried forward to the next pay cycle.The currency for `minimal-payout-amount` is the same as `base-currency`.Note: We highly recommend setting this value to 25 or more to avoid payout delays and negative balances.
`name-on-account`	string	Required	Name on bank account for vendor. Valid value: 3–140 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 for Merchant {Merchant ID}"). Learn more.Up to 100 alphanumeric characters.Note: Not applicable if`payout-type` is ACHand`base-currency` is CAD.
`payout-type`	string	Required	Method of payout to vendor. Possible values: ACH CHAPS FAST SEPA WIREFor details on each payout method and its applicability, refer these descriptions.
`refund-reserve`	integer	Optional	Vendor's Refund Reserve, which are account funds that are set aside (not paid out) to enable you to issue refunds even when the vendor's account balance is low. The Refund Reserve balance accrues from sales, and once the Refund Reserve amount is met, all additional sales are applied to the next payout.The currency for `refund-reserve` is the same as `base-currency`.Note: We recommend setting this value to avoid having a failed refund operation.
`state`	string	Required if `country` is US or CA	State & Province code. Refer to State and Province Codes
`swift-bic`	string	Either `bank-id` or `swift-bic` is required, but not both.	The Bank Identifier Code of vendor bank. Maximum 50 alphanumeric characters.
`zip`	string	Optional	Zip/Postal code of vendor bank. Maximum 10 characters.