WePay logo
      Nothing Found

Get capabilities

get/accounts/{id}/capabilities

The GET /accounts/{id}/capabilities call allows your platform to look up an account's capabilities. The accounts resource allows your platform to create a new merchant account for each distinct business purpose.

SecurityappIdAuth and appTokenAuth
Request
path Parameters
id
required
string [ 1 .. 255 ] characters

ID of the merchant account, generated by WePay when the account is created.

query Parameters
is_expanded
boolean
Default: true
header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
capabilities
id
required
string or null [ 1 .. 255 ] characters

A reference number your platform assigns to an Item.

path
required
string

The HTTP path of the resource. The path can be used to retrieve details about the resource and perform actions on it.

required
object

Details the owner resource and owner path.

api_version
required
string
object

Details an Account's Payments capability status, and reasons for a disabled status (i.e. enabled : false), if applicable.

object

Details an Account's Payouts capability status, and reasons for a disabled status (i.e. enabled : false), if applicable.

object

Details an Account's Terminals capability status, and reasons for a disabled status (i.e. enabled : false), if applicable. Note: If your platform does not have permission from WePay to use Card Present, then your merchants' terminal capability will never be enabled. This will not impact their ability to process web-based, card-not-present transactions.

400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "id": null,
  • "owner": {
    • "id": "d3f61e56-5d99-4895-af2d-a07ab48476e9",
    • "path": "/accounts/d3f61e56-5d99-4895-af2d-a07ab48476e9",
    • "resource": "accounts"
    },
  • "path": "/accounts/d3f61e56-5d99-4895-af2d-a07ab48476e9/capabilities",
  • "payments": {
    • "enabled": true
    },
  • "payouts": {
    • "enabled": false
    },
  • "terminals": {
    • "enabled": false
    },
  • "resource": "capabilities",
  • "api_version": "3.0"
}