View Payouts

Sometimes merchants will want an update regarding the status of a Payout. This cookbook will help your support team access Payouts in order to address these questions.

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 Payout History

Using the methods outlined above to access a merchant, provide a view of that merchant's Payout history:

An example of a custom interface for your employees to view a merchant's payout history

To retrieve the merchant's Payout history when loading the account details, either store the data on your end and run a query of your database, or send a GET /payouts API request using the merchant's Account ID like so:

Copy

Copied

curl -X GET -G \
  --url 'https://stage-api.wepay.com/payouts' \
  -H 'Accept: application/json'\
  -H 'App-Id: {your-app-id}'\
  -H 'App-Token: {your-app-token}'\
  -H 'Api-Version: 3.0' \
  -d 'owner_id={merchant-account-id}'

Display results, and leverage the pagination feature of the results in your UI to get the next page, the previous page, and to jump to a page number.

3. View Balances

As part of viewing a merchant's Account, be sure to provide an overview of the merchant's balances:

An example of a custom interface for your employee to view a merchant's balances

To retrieve the merchant's balances, send a GET /accounts/{id} request for the most up-to-date information. Then parse the balances JSON object with the following details:

Balance (this is the amount currently available for payout)
Incoming pending (this is the amount that will be available for payout, but the transactions are in a pending status)
Outgoing pending (this is the amount of any Payouts in a pending status)
Reserve (this is any amount exceeding the merchant's weekly payout limit)

4. View Payout Details

When a support agent needs to see more details about a Payout with a pending or failed status, provide a UI path to view. On click, either pull payout details from your own database, or send a GET /payouts/id API request like so:

Copy

Copied

curl -X GET \
  --url 'https://stage-api.wepay.com/payouts/{payout-id} \
  -H 'Accept: application/json'\
  -H 'App-Id: {your-app-id}\
  -H 'App-Token: {your-app-token}\
  -H 'Content-Type: application/json'

Parse the JSON response into a payout display like this:

An example of a custom interface for your employees to view a merchant's payout details

Partner Center Method

A. Search Accounts

The search functionality described in this section can be used here. Click into the merchant profile.

B. View Payout History

Click on the “Withdrawals” tab to view the merchant's payout history:

How to view a merchant's payouts in WePay's Partner Center

Filter the list of payouts by date range:

How to filter a merchant's payouts in WePay's Partner Center

C. View Payout Details

Payout details are displayed on the associated line item.

Questions? Need help? Visit our support page!