{"_id":"59a45d467ee621000fc9d423","category":{"_id":"59a45d447ee621000fc9d3c4","version":"59a45d437ee621000fc9d3b7","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":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:13:23.840Z","releaseDate":"2017-08-28T18:13:23.840Z","categories":["59a45d447ee621000fc9d3b8","59a45d447ee621000fc9d3b9","59a45d447ee621000fc9d3ba","59a45d447ee621000fc9d3bb","59a45d447ee621000fc9d3bc","59a45d447ee621000fc9d3bd","59a45d447ee621000fc9d3be","59a45d447ee621000fc9d3bf","59a45d447ee621000fc9d3c0","59a45d447ee621000fc9d3c1","59a45d447ee621000fc9d3c2","59a45d447ee621000fc9d3c3","59a45d447ee621000fc9d3c4","59a45d447ee621000fc9d3c5","59a45d447ee621000fc9d3c6","59a45d447ee621000fc9d3c7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-28T16:19:02.507Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":72,"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\": \"integer\",\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](/v1.0/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\",\n    \"3-3\": \"Type of bank account\\n\\nPossible values: \\nPERSONAL\\nCORPORATE\\nINTERNATIONAL\",\n    \"4-3\": \"Account type\\n\\nPossible values: \\nCHECKING\\nSAVINGS\",\n    \"5-3\": \"Name of vendor bank\",\n    \"9-3\": \"City of vendor bank\",\n    \"10-3\": \"Street address of vendor bank\",\n    \"11-3\": \"Zip/Postal code of vendor bank\",\n    \"12-3\": \"Vendor bank account number\",\n    \"6-3\": \"Bank ID number (ie. Routing number)\",\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](/v1.0/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)\\n\\n15 - 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\\n\\nUp 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\\nInteger must be positive (i.e. 45)\\n\\nThe currency for `minimal-payout-amount` is the same as `base-currency`.\",\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 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

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

bank-id

integer

Required

Bank ID number (ie. Routing number)

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

address

string

Optional

Street address of vendor bank

zip

string

Optional

Zip/Postal code of vendor bank

bank-account-id

integer

Required

Vendor bank account number

iban

string

Required if payout-type is CHAPS or SEPA

Vendor International Bank Account Number (IBAN)

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.

Integer must be positive (i.e. 45)

The currency for minimal-payout-amount is the same as base-currency.

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.