payoutInfo

address

string

Optional

Street address of vendor bank.
Maximum 60 characters.

bankAccountClass

string

Required

Type of bank account.
Possible values:
PERSONAL
CORPORATE
INTERNATIONAL

bankAccountId

string

Either bankAccountId or iban is required, but not both.

Vendor bank account number.
Maximum 34 characters.

bankAccountType

string

Required

Account type.
Possible values:
CHECKING
SAVINGS

bankId

string

Either bankId or swiftBic is required, but not both.

Bank identifier, routing number, sort code, or BSB.
Maximum 35 characters.

bankName

string

Required

Name of vendor bank.
Maximum 140 characters.

baseCurrency

string

Required

Payout currency for vendor's bank account.
Possible values:

AUD — Australia Dollar

CAD — Canada Dollar

CHF — Switzerland Franc

DKK — Denmark Kroner

EUR — Euro

GBP — United Kingdom Pound

HKD — Hong Kong Dollar

JPY — Japan Yen

NOK — Norway Kroner

NZD — New Zealand Dollar

SEK — Sweden Kroner

USD — 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 bankAccountId or iban is required, but not both.

Vendor International Bank Account Number (IBAN).
15–31 alphanumeric characters.

minimalPayoutAmount

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 minimalPayoutAmount is the same as baseCurrency.

Note: We highly recommend setting this value to25 or more to avoid payout delays and negative balances.

nameOnAccount

string

Required

Name on bank account for vendor.
Valid value: 3–140 alphanumeric characters

paymentReference

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 payoutType is ACH and baseCurrency 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.

payoutType

string

Required

Method of payout to vendor.
Possible values:
ACH
CHAPS
FAST
SEPA
WIRE

For details on each payout method and its applicability, refer these descriptions.

refundReserve

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 refundReserve is the same as baseCurrency.

Note: We recommend setting this value to avoid having a failed refund operation.

swiftBic

string

Either bankId or swiftBic is required, but not both.

The Bank Identifier Code of vendor bank for wire transfers.
Maximum 50 alphanumeric characters.

state

string

Required if country is US or CA

State & Province code.
Refer to State and Province Codes.

zip

string

Optional

Zip/Postal code of vendor bank.
Maximum 10 characters.