Access Account Capabilities

This cookbook will help you guide merchants through onboarding, help them identify missing Account Capabilities details, and provide insight into any additional requirements for Account Payment & Payout Capabilities.

Custom Method

1. Search Accounts

The search functionality described in this section can be used here, so long as search results provide a UI path to view the WePay Account details.

2. View Capabilities

As part of your merchant display, be sure to include Account Capabilities:

A sample implementation of your custom eployee portal to view a merchant's capabilities.

You'll need access to the following data, either from your own database or from the GET /accounts/{id}/capabilities API endpoint:

Parameter to display	Value to display

`payments`
`enabled`	Boolean
`current_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target.path` *This will contain the specific parameter which has an issue.
`upcoming_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target`
`payouts`
`enabled`	Boolean
`current_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target.path` *This will contain the specific parameter which has an issue.
`upcoming_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target`
`terminals` *This is only needed if your platform offers Card Present payments
`enabled`	Boolean
`current_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target.path` *This will contain the specific parameter which has an issue.
`upcoming_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target`

Providing the above information will give your support agents a high-level idea of what is going on with the merchant. To provide more specific information, parse the JSON object corresponding to the issue_type value. For instance, if the payouts.current_issues.issue_type value is errant_fields, then parse the JSON object at payouts.current_issues.additional_documents_required.

A sample implementation of your employee portal to view a merchant's capability details.

The following issue_type values will not have a related JSON object, as they are reasons for which we closed the account and cannot be resolved:

unsupported
high_risk_cb_rate
reported_user
tos_violation
country_not_supported
compliance
fraud

Important

The issue_type value of fraud should never be communicated to merchants. To help protect against this, be sure to train your support team thoroughly and regularly in responding to inquiries from merchants closed for this reason. Responses should be vague, but polite. For example, coach your support team to send something like the following:

Unfortunately, we are no longer able to support your account with us. I'm sorry for the inconvenience, and wish you the best in your future endeavors.

If the value for issue_type is closed_for_loss, the account can be re-opened when the merchant remits payment for the negative balance.

Partner Center Method

A. Search Accounts

The search functionality described in this section can be used here.

B. View Capabilities

Provide a generic section in the UI to house Account Capabilities details, in addition to Legal Entity Verifications details (explained here).

Where to view a merchant's capabilities from the Partner Center

High-level Capability information consists of Payments, Payouts, and Terminals enablement, which can be fetched with a GET /accounts/{id}/capabilities API request. Use the merchant ID provided in the search in this call.

Parameter to display	Value to display

`payments`
`enabled`	Boolean
`current_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target.path` *This will contain the specific parameter which has an issue.
`upcoming_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target`
`payouts`
`enabled`	Boolean
`current_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target.path` *This will contain the specific parameter which has an issue.
`upcoming_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target`
`terminals` *This is only needed if your platform offers Card Present payments
`enabled`	Boolean
`current_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target.path` *This will contain the specific parameter which has an issue.
`upcoming_issues`	This will be an array of JSON objects, each object corresponding to a unique issue. `issue_type` `target`

How to view a merchant's capability details from the Partner Center

The following issue_type values will not have a related JSON object, as they are reasons for which we closed the account, and cannot be resolved:

unsupported
high_risk_cb_rate
reported_user
tos_violation
country_not_supported
compliance
fraud

Important

Unfortunately, we are no longer able to support your account with us. I'm sorry for the inconvenience, and wish you the best in your future endeavors.

If the value for issue_type is closed_for_loss, the account can be re-opened when the merchant remits payment for the negative balance.

Questions? Need help? Visit our support page!