/settlement_bank/create

This call creates a new settlement bank account object which can be safely referred to using the returned settlement_bank_id. The call is described below, however it should be called using the JavaScript library.

Do not use an access token for this call. It must be confirmed using the /settlement_bank/authorize call within 30 minutes of creation.


Arguments

Parameter Required Type Description Example
client_id Yes Integer (64 bits) The unique ID of your API application. This can be located on your app dashboard.
{
	"client_id": "56689",
	"account_id": "1993567257",
	"email": "foobar@example.com",
	"ca_institution": {
		"name": "My Canadian Bank",
		"transit_number": "12345",
		"institution_number": "123",
		"account_number": "1234567",
		"account_type": "checking"
	},
  "original_ip" : "19216872",
  "original_device" : "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; en-US) AppleWebKit/534.13 (KHTML, like Gecko)Chrome/9.0.597.102 Safari/534.13"
}
account_id Yes Integer (64 bits) The unique ID of the account.
email Yes The merchant's email address. This must match the email used in the /user/register call used to setup the merchant. The unique ID of the account you want to look up.
ca_institution Yes (For Canadian banks only) CA Institution Structure Information about a Canadian bank.
gb_institution Yes (For UK banks only) GB Institution Structure Information about a bank in the United Kingdom.
us_institutuion Yes (For U.S. Banks only) US Institution Structure Information about a U.S. bank.
original_ip No (Required if not using the WePay Tokenization Library) String (255 chars) The IP Address of the device used when creating the bank.
original_device No (Required if not using the WePay Tokenization Library) (255 chars) The device ID of the device used when creating the bank.

Response

Response Type Description Example
settlement_bank_id Integer (64 bit) A unique identifier for the settlement bank.
{
"settlement_bank_id":12345
}