Get capabilities

API Reference
Solutions
Features
Resources
- SDKs and Libraries
- Payments 101

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

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

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.

object

Details an Account's onboarding status with Chase Merchant Services.

400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples

Response samples

application/json

{"id": null,
"owner": {"id": "9647b114-55ca-4c58-8072-d424d879ac06",
"path": "/accounts/9647b114-55ca-4c58-8072-d424d879ac06",
"resource": "accounts"
},
"path": "/accounts/9647b114-55ca-4c58-8072-d424d879ac06/capabilities",
"transaction_division_setup": {"current_issues": [{"identity_verification": {"path": "controller.personal_verification.documents",
"requested_documents": ["passport",
"drivers_license"
],
"message": "we need to verify your date of birth"
},
"issue_type": "identity_verification",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
}
],
"enabled": true,
"upcoming_issues": { }
},
"payments": {"current_issues": [{"identity_verification": {"path": "controller.personal_verification.documents",
"requested_documents": ["drivers_license",
"current_lease_contract"
],
"message": "we need to verify your address"
},
"issue_type": "identity_verification",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
},
{"risk_outreach": {"path": "controller.personal_verification.documents",
"requested_documents": ["drivers_license",
"current_lease_contract"
],
"message": "we need to verify your address"
},
"issue_type": "risk_outreach",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
}
],
"enabled": true,
"upcoming_issues": {"1512344668": [{"errant_fields": {"controller.address": ["is_null"
],
"controller.date_of_birth": ["is_null"
],
"controller.name": ["is_null"
],
"controller.personal_country_info.US.social_security_number": ["is_null"
],
"controller.phone": ["is_null"
],
"entity_country_info.US.legal_form": ["is_null"
],
"terms_of_service.acceptance_time": ["is_null"
],
"terms_of_service.original_ip": ["is_null"
],
"terms_of_service.terms_of_service_version": ["is_null"
]
},
"issue_type": "errant_fields",
"target": {"id": "672b72f5-5136-4304-b553-ec7c8544b51e",
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e",
"resource": "legal_entities"
}
}
]
}
},
"payouts": {"current_issues": [{"errant_fields": {"controller.name": ["is_null"
]
},
"issue_type": "errant_fields",
"target": {"id": "672b72f5-5136-4304-b553-ec7c8544b51e",
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e",
"resource": "legal_entities"
}
},
{"additional_documents_required": ["additional_representatives.representative_0.personal_verification.documents"
],
"issue_type": "additional_documents_required",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
},
{"identity_verification": {"path": "controller.personal_verification.documents",
"requested_documents": ["drivers_license",
"current_lease_contract"
],
"message": "we need to verify your address"
},
"issue_type": "identity_verification",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
},
{"risk_outreach": {"path": "controller.personal_verification.documents",
"requested_documents": ["drivers_license",
"current_lease_contract"
],
"message": "we need to verify your address"
},
"issue_type": "risk_outreach",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
}
],
"enabled": false,
"upcoming_issues": {"1512344668": [{"errant_fields": {"controller.address": ["is_null"
],
"controller.date_of_birth": ["is_null"
],
"controller.personal_country_info.US.social_security_number": ["is_null"
],
"controller.phone": ["is_null"
],
"entity_country_info.US.legal_form": ["is_null"
],
"terms_of_service.acceptance_time": ["is_null"
],
"terms_of_service.original_ip": ["is_null"
],
"terms_of_service.terms_of_service_version": ["is_null"
]
},
"issue_type": "errant_fields",
"target": {"id": "672b72f5-5136-4304-b553-ec7c8544b51e",
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e",
"resource": "legal_entities"
}
}
]
}
},
"terminals": {"current_issues": [{"errant_fields": {"controller.phone": ["is_null"
],
"address": ["is_null"
],
"entity_country_info.US.employer_identification_number": ["is_null"
],
"controller.date_of_birth": ["is_null"
],
"phone": ["is_null"
],
"controller.name": ["is_null"
],
"controller.personal_country_info.US.social_security_number": ["is_null"
],
"entity_country_info.US.legal_form": ["is_null"
],
"controller.email": ["is_null"
]
},
"issue_type": "errant_fields",
"target": {"resource": "legal_entities",
"id": "672b72f5-5136-4304-b553-ec7c8544b51e",
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e"
}
},
{"identity_verification": {"path": "controller.personal_verification.documents",
"requested_documents": ["drivers_license",
"current_lease_contract"
],
"message": "we need to verify your address"
},
"issue_type": "identity_verification",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
},
{"risk_outreach": {"path": "controller.personal_verification.documents",
"requested_documents": ["current_bank_statement"
],
"message": "we need to verify your date of birth"
},
"issue_type": "risk_outreach",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
},
{"errant_fields": {"name": ["is_null"
],
"industry.merchant_category_code": ["is_unsupported_value"
]
},
"issue_type": "errant_fields",
"target": {"resource": "accounts",
"id": "9647b114-55ca-4c58-8072-d424d879ac06",
"path": "/accounts/9647b114-55ca-4c58-8072-d424d879ac06"
}
}
],
"enabled": false,
"upcoming_issues": { }
},
"resource": "capabilities",
"api_version": "3.1"
}