The /account API calls

/account

This call allows you to lookup the details of a payment account on WePay. The payment account must belong to the user associated with the access token used to make the call.

Arguments:

Example:

{
  "account_id":12345
}

Response:

Example:

{
  "account_id":12345,
  "name":"Example account",
  "state":"active",
  "description":"this account is just an example.",
  "reference_id":"123abc",
  "account_uri":"https://stage.wepay.com/account/12345",
  "payment_limit":2000,
  "verification_state":"pending",
  "type":"personal",
  "create_time":1367958263,
  "country": "US",
  "currencies": ["USD"]
}

/account/find

This call lets you search the accounts of the user associated with the access token used to make the call. You can search by name or reference_id, and the response will be an array of all the matching accounts. If both name and reference_id are blank, this will return an array of all of the user's accounts.

Arguments:

Example:

{
  "name":"Example Acccount",
  "reference_id":"123abc"
}

Response:

An array of accounts matching the search parameters. Each element of the array will include the same data as returned from the /account call.

Example:

[
  {
    "account_id":12345,
    "name":"Example account",
    "state":"active",
    "description":"this account is just an example.",
    "reference_id":"123abc",
    "account_uri":"https://stage.wepay.com/account/12345",
    "payment_limit":"2000",
    "verification_state":"pending",
    "type":"personal",
    "create_time":1367958263,
    "country": "US",
    "currencies": ["USD"]
  }
]

/account/create

Creates a new payment account for the user associated with the access token used to make this call. If reference_id is passed, it MUST be unique for the application/user pair or an error will be returned. NOTE: You cannot create an account with the word 'wepay' in it. This is to prevent phishing attacks.

Arguments:

Example:

{
  "name":"Example Account",
  "description":"This is just an example WePay account.",
  "reference_id":"abc123",
  "image_uri":"https://stage.wepay.com/img/logo.png",
  "country": "US",
  "currencies": ["USD"]
}

Response:

Example:

{
  "account_id":12345,
  "account_uri":"https://stage.wepay.com/account/12345"
}

/account/modify

Updates the specified properties. If reference_id is passed, it must be unique for the user/application pair.

Arguments:

Example:

{
  "account_id":12345,
  "name":"Example Account",
  "description":"This is just an example WePay account. Modify the text.",
  "reference_id":"abc123",
  "image_uri":"https://stage.wepay.com/img/logo.png"
}

Response:

/account/delete

Deletes the account specified. The use associated with the access token used must have permission to delete the account. An account may not be deleted if it has a balance or pending payments.

Arguments:

Example:

{
  "account_id":12345
}

Response:

Example:

{
  "account_id":12345,
  "state":"deleted"
}

/account/balance

Gets the balance for the account.

Arguments:

Example:

{
  "account_id":12345
}

Response:

Example:

{
  "pending_balance":"500",
  "available_balance:"500",
  "currency":"USD"
}

/account/add_bank

This call allows you to add a bank account to a specified account. It will return a URL that a user can visit to add a bank account to their account. In addition, add_bank will allow you to change bank accounts if one was previously set.

Arguments:

Example:

{
  "account_id":12345,
  "mode":"iframe"
}

Response:

Example:

{
  "account_id":12345,
  "add_bank_uri:"http://stage.wepay.com/api/account_add_bank/12345"
}

/account/set_tax

This call lets you set tax rates for an account that will be applied to checkouts created for this account. Taxes are only applied on a checkout if the charge_tax parameter is set to true when the checkout is created.

Arguments:

Example:

{
  "account_id":12345,
  "taxes":
    [
      {"percent":10,"country":"US","state":"CA","zip":"94025"},
      {"percent":7, "country":"US","state":"CA"},
      {"percent":5, "country":"US"}
    ]
}

When determining taxes to be applied, we will use the most specific match we could find. So for the example above, if the shipping address provided by the payer matches country = US, state = CA and zip = 94025, the tax rate will be 10%. For any addresses in California with non-94025 zip's the tax rate will be 7%. For any addresses in the rest of the USA, not in California, the rate will be 5%. For any addresses not in the USA, the tax rate will be 0% (as no tax was specified).

Response:

/account/get_tax

This call lets you get the tax rates for an account. They will be in the same format as detailed in the /account/set_tax call.

Arguments:

Example:

{
 "account_id":12345
}

Response:

Example:

[
  {"percent":10,"country":"US","state":"CA","zip":"94025"},
  {"percent":7, "country":"US","state":"CA"},
  {"percent":5, "country":"US"},
]