{"_id":"5beec5a5f95d82011c6f36a3","category":{"_id":"5beec5a5f95d82011c6f367e","version":"5beec5a5f95d82011c6f3714","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5beec5a5f95d82011c6f3714","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bcf37dfadc5b905136a39f4","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5beec5a5f95d82011c6f3672","5beec5a5f95d82011c6f3673","5beec5a5f95d82011c6f3674","5beec5a5f95d82011c6f3675","5beec5a5f95d82011c6f3676","5beec5a5f95d82011c6f3677","5beec5a5f95d82011c6f3678","5beec5a5f95d82011c6f3679","5beec5a5f95d82011c6f367a","5beec5a5f95d82011c6f367b","5beec5a5f95d82011c6f367c","5beec5a5f95d82011c6f367d","5beec5a5f95d82011c6f367e","5beec5a5f95d82011c6f367f","5beec5a5f95d82011c6f3680","5beec5a5f95d82011c6f3681"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.28 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-28T16:19:02.507Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":29,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"payout-type\",\n    \"1-0\": \"base-currency\",\n    \"2-0\": \"name-on-account\",\n    \"3-0\": \"bank-account-class\",\n    \"4-0\": \"bank-account-type\",\n    \"5-0\": \"bank-name\",\n    \"6-0\": \"bank-id\",\n    \"7-0\": \"country\",\n    \"9-0\": \"city\",\n    \"10-0\": \"address\",\n    \"11-0\": \"zip\",\n    \"12-0\": \"bank-account-id\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string\",\n    \"4-1\": \"string\",\n    \"5-1\": \"string\",\n    \"7-1\": \"string\",\n    \"9-1\": \"string\",\n    \"10-1\": \"string\",\n    \"11-1\": \"string\",\n    \"6-1\": \"string\",\n    \"12-1\": \"integer\",\n    \"0-2\": \"**Required**\",\n    \"1-2\": \"**Required**\",\n    \"2-2\": \"**Required**\",\n    \"3-2\": \"**Required**\",\n    \"4-2\": \"**Required**\",\n    \"5-2\": \"**Required**\",\n    \"6-2\": \"**Required**\",\n    \"7-2\": \"**Required**\",\n    \"9-2\": \"Optional\",\n    \"10-2\": \"Optional\",\n    \"11-2\": \"Optional\",\n    \"12-2\": \"**Required**\",\n    \"7-3\": \"Country code of vendor bank. \\nSee [Country codes](/docs/country-codes)\",\n    \"0-3\": \"Method of payout to vendor\\n\\nPossible values: \\n**ACH** (USD, CAD)\\n**CHAPS** (GBP)\\n**SEPA** (EUR)\\n**WIRE**\",\n    \"1-3\": \"Payout currency for vendor's bank account.\\n\\nPossible values: \\n**AUD** - Australia Dollar\\n**CAD** - Canada Dollar\\n**CHF** - Switzerland Franc\\n**DKK** - Denmark Kroner\\n**EUR** - Euro\\n**GBP** - United Kingdom Pound\\n**HKD** - Hong Kong Dollar\\n**JPY** - Japan Yen\\n**NOK** - Norway Kroner\\n**NZD** - New Zealand Dollar\\n**SEK** - Sweden Kroner\\n**USD** - US Dollar\",\n    \"2-3\": \"Name on bank account for vendor. Maximum 30 characters.\",\n    \"3-3\": \"Type of bank account\\n\\nPossible values: \\n**PERSONAL**\\n**CORPORATE**\\n**INTERNATIONAL**\",\n    \"4-3\": \"Account type\\n\\nPossible values: \\n**CHECKING**\\n**SAVINGS**\",\n    \"5-3\": \"Name of vendor bank. Maximum 140 characters.\",\n    \"9-3\": \"City of vendor bank. Maximum 40 characters.\",\n    \"10-3\": \"Street address of vendor bank. Maximum 60 characters.\",\n    \"11-3\": \"Zip/Postal code of vendor bank. Maximum 20 characters.\",\n    \"12-3\": \"Vendor bank account number. Maximum 34 characters.\",\n    \"6-3\": \"Bank ID number (ie. Routing number). Maximum 35 characters.\",\n    \"8-0\": \"state\",\n    \"8-1\": \"string\",\n    \"8-2\": \"**Required** if `country` is US or CA\",\n    \"8-3\": \"State & Province code; See  [State and Province Codes](/docs/state-and-province-codes)\",\n    \"13-0\": \"iban\",\n    \"13-1\": \"string\",\n    \"13-2\": \"**Required** if `payout-type` is CHAPS or SEPA\",\n    \"13-3\": \"Vendor International Bank Account Number (IBAN). Between 15 - 31 alphanumeric characters.\",\n    \"14-0\": \"swift-bic\",\n    \"14-1\": \"string\",\n    \"14-2\": \"Optional\",\n    \"14-3\": \"The Bank Identifier Code of vendor bank, up to 50 alphanumeric characters\",\n    \"15-0\": \"minimal-payout-amount\",\n    \"15-1\": \"integer\",\n    \"15-2\": \"Optional\",\n    \"15-3\": \"Minimum amount for which a vendor may be paid out. If the vendor's account balance is below this amount, their balance will be carried forward to the next pay cycle. \\n\\nThe currency for `minimal-payout-amount` is the same as `base-currency`.\\n\\n**Note:** We highly recommend setting this value to **25** or more to avoid payout delays and negative balances.\",\n    \"16-0\": \"payment-reference\",\n    \"16-1\": \"string\",\n    \"16-2\": \"Optional\",\n    \"16-3\": \"Reference text that will appear on your vendor's bank statement when they are paid out. If left blank, the text will be the standard message (i.e. \\\"BlueSnap Payment for Merchant {Merchant ID}\\\").\\n\\nUp to 100 alphanumeric characters\\n\\n**Note**: Not applicable if `payout-type` is **ACH** and `base-currency` is **CAD**.\"\n  },\n  \"cols\": 4,\n  \"rows\": 17\n}\n[/block]","excerpt":"","slug":"payout-info","type":"basic","title":"payout-info"}

Payment API (XML)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Batch Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

Mobile SDK

payout-info

Property Name
Type
Required
Description

payout-type

string

Required

Method of payout to vendor

Possible values:
ACH (USD, CAD)
CHAPS (GBP)
SEPA (EUR)
WIRE

base-currency

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

name-on-account

string

Required

Name on bank account for vendor. Maximum 30 characters.

bank-account-class

string

Required

Type of bank account

Possible values:
PERSONAL
CORPORATE
INTERNATIONAL

bank-account-type

string

Required

Account type

Possible values:
CHECKING
SAVINGS

bank-name

string

Required

Name of vendor bank. Maximum 140 characters.

bank-id

string

Required

Bank ID number (ie. Routing number). Maximum 35 characters.

country

string

Required

Country code of vendor bank.
See Country codes

state

string

Required if country is US or CA

State & Province code; See State and Province Codes

city

string

Optional

City of vendor bank. Maximum 40 characters.

address

string

Optional

Street address of vendor bank. Maximum 60 characters.

zip

string

Optional

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

bank-account-id

integer

Required

Vendor bank account number. Maximum 34 characters.

iban

string

Required if payout-type is CHAPS or SEPA

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

swift-bic

string

Optional

The Bank Identifier Code of vendor bank, up to 50 alphanumeric characters

minimal-payout-amount

integer

Optional

Minimum amount for which a vendor may be paid out. If the vendor's account balance is below this amount, their balance will be 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.

payment-reference

string

Optional

Reference text that will appear on your vendor's bank statement when they are paid out. If left blank, the text will be the standard message (i.e. "BlueSnap Payment for Merchant {Merchant ID}").

Up to 100 alphanumeric characters

Note: Not applicable if payout-type is ACH and base-currency is CAD.