{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"payout-info","type":"basic","slug":"payout-info","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Vendor requirements\",\n  \"body\": \"Initially, you do not need all your vendor's information to submit the request to immediately begin processing transactions; **however**, to fully board your vendor, you must collect all the necessary Know Your Customer (KYC), banking, and any additional required information from them, and submit to BlueSnap for verification.\"\n}\n[/block]\n\n[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\": \"Either `bank-id` or `swift-bic` is required, but not both.\",\n    \"7-2\": \"**Required**\",\n    \"9-2\": \"Optional\",\n    \"10-2\": \"Optional\",\n    \"11-2\": \"Optional\",\n    \"12-2\": \"Either `bank-account-id` or `iban` is required, but not both.\",\n    \"7-3\": \"Country code of vendor bank.\\nRefer to [Country codes](/docs/country-codes)\",\n    \"0-3\": \"Method of payout to vendor.\\nPossible values: \\n**ACH**\\n**CHAPS**\\n**FAST**\\n**SEPA**\\n**WIRE**\\n\\nFor details on each payout method and its applicability, refer [these descriptions](https://support.bluesnap.com/docs/payout-method#section-payout-method-types).\",\n    \"1-3\": \"Payout currency for vendor's bank account.\\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. \\nValid value:  3–140 alphanumeric characters\",\n    \"3-3\": \"Type of bank account.\\nPossible values: \\n**PERSONAL**\\n**CORPORATE**\\n**INTERNATIONAL**\",\n    \"4-3\": \"Account type.\\nPossible values: \\n**CHECKING**\\n**SAVINGS**\",\n    \"5-3\": \"Name of vendor bank.\\nMaximum 140 characters.\",\n    \"9-3\": \"City of vendor bank.\\nMaximum 40 characters.\",\n    \"10-3\": \"Street address of vendor bank. \\nMaximum 60 characters.\",\n    \"11-3\": \"Zip/Postal code of vendor bank. \\nMaximum 10 characters.\",\n    \"12-3\": \"Vendor bank account number.\\nMaximum 34 characters.\",\n    \"6-3\": \"Bank identifier, routing number, sort code, or  BSB.\\nMaximum 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.\\nRefer to [State and Province Codes](/docs/state-and-province-codes)\",\n    \"13-0\": \"`iban`\",\n    \"13-1\": \"string\",\n    \"13-2\": \"Either `bank-account-id` or `iban` is required, but not both.\",\n    \"13-3\": \"Vendor International Bank Account Number (IBAN).\\nBetween 15–31 alphanumeric characters.\",\n    \"14-0\": \"`swift-bic`\",\n    \"14-1\": \"string\",\n    \"14-2\": \"Either `bank-id` or `swift-bic` is required, but not both.\",\n    \"14-3\": \"The Bank Identifier Code of vendor bank. \\nMaximum 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 is 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 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}\\\").\\n\\nUp to 100 alphanumeric characters.\\n\\n**Note**: Not applicable if `payout-type` is **ACH** and `base-currency` is **CAD**.\",\n    \"17-0\": \"`refund-reserve`\",\n    \"17-1\": \"integer\",\n    \"17-2\": \"Optional\",\n    \"17-3\": \"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. \\n\\nThe currency for `refund-reserve` is the same as `base-currency`.\\n\\n**Note:** We recommend setting this value to avoid having a failed refund operation.\"\n  },\n  \"cols\": 4,\n  \"rows\": 18\n}\n[/block]","updates":[],"order":36,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ff4b747849e1b03c506843c","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"5ff4b747849e1b03c5068415","version":"5ff4b747849e1b03c50684c7","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.36.1 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ff4b747849e1b03c5068409","5ff4b747849e1b03c506840a","5ff4b747849e1b03c506840b","5ff4b747849e1b03c506840c","5ff4b747849e1b03c506840d","5ff4b747849e1b03c506840e","5ff4b747849e1b03c506840f","5ff4b747849e1b03c5068410","5ff4b747849e1b03c5068411","5ff4b747849e1b03c5068412","5ff4b747849e1b03c5068413","5ff4b747849e1b03c5068414","5ff4b747849e1b03c5068415","5ff4b747849e1b03c5068416","5ff4b747849e1b03c5068417","5ff4b747849e1b03c5068418","5ff4b747849e1b03c5068419","5ff4b747849e1b03c506841a","5ff4b747849e1b03c506841b","5ff4b747849e1b03c506841c"],"_id":"5ff4b747849e1b03c50684c7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5fd26704abd1b6004f12d72c","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-11-28T16:19:02.507Z","githubsync":"","__v":0}

Payment API (XML)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

iDEAL Transactions

Local Bank Transfer transactions

SEPA Direct Debit Transactions

Sofort Transactions

Batch Transactions

Refunds

Vaulted Shoppers

Subscriptions

Fraud Review

Marketplace

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

Mobile SDK

payout-info

Vendor requirements

Initially, you do not need all your vendor's information to submit the request to immediately begin processing transactions; however, to fully board your vendor, you must collect all the necessary Know Your Customer (KYC), banking, and any additional required information from them, and submit to BlueSnap for verification.

Property Name
Type
Required
Description

payout-type

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.

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.
Valid value: 3–140 alphanumeric 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

Either bank-id or swift-bic is required, but not both.

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

country

string

Required

Country code of vendor bank.
Refer to Country codes

state

string

Required if country is US or CA

State & Province code.
Refer to 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 10 characters.

bank-account-id

integer

Either bank-account-id or iban is required, but not both.

Vendor bank account number.
Maximum 34 characters.

iban

string

Either bank-account-id or iban is required, but not both.

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

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.

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 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.

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}").

Up to 100 alphanumeric characters.

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

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.