View Payments

 

Sometimes users will want an update regarding the status of a Payment, or additional details and help with a Payment. This cookbook will help your support team access Payments in order to address these questions.


Custom Method

1. Search Payments

We recommend providing the following methods for finding payments and accessing payment details:

  • Browse an account's transaction history to locate a specific payment
  • Search for a payment

To build a search function for payments, decide whether to query your own database or the API via Payments or Payment Methods.

Querying Payments directly requires fewer API calls, but can only query against:

  • Date range
  • Card vs. ACH
  • API status
  • Payment Method ID
  • Reference ID

On the other hand, querying against Payment Methods requires two API calls, but allows querying against:

  • Date range
  • Card brand
  • Card last 4
  • ACH routing number
  • Card vs. ACH

Support agents should collect as many of the above details from the end user (merchant or payer) as possible before trying to search:

An example custom interface for your employees to search payments across your mercants.
An example custom interface for your employees to search payments across your mercants.

Using the submitted search parameters, either query your own database for Payment details, or query the WePay API. To query the WePay API:

  1. Send a GET /payment_methods API request.
  2. Send a secondary request to GET /payments using the payment_method_id OR filter results based on additional search parameters provided.

Display results:

An example of a custom display to serve payments search results to your employees.
An example of a custom display to serve payments search results to your employees.

1.5 Find Payments From Merchant Details

An example of a custom display of a mercant's transaction history that your employees can view
An example of a custom display of a mercant's transaction history that your employees can view

2. View Payment Details

If the Payment is in a failed or pending status, provide a method for support agents to view reason codes:An example of a custom display for payment details for your employees.
An example of a custom display for payment details for your employees.

Once a payment has been found, a support agent should be able to access status, payment errors, date of transaction, and any associated refunds or chargebacks (if applicable).

Additionally, the option to partially or fully refund the payment should be made available in the payment details screen. Read more about building refund components for your support tool here.

Partner Center Method

A. Search Payments

Filter transactions to search for the correct payment:

How to search payments from WePay's Partner Center.
How to search payments from WePay's Partner Center.

Edit the columns to view different details of the transaction:

How to edit columns on a transaction report in WePay's Partner Center.
How to edit columns on a transaction report in WePay's Partner Center.

B Find Payments From Merchant Details

Navigate to the appropriate merchant, if known, and view the “Transactions” tab:

How to view payments in WePay's Partner Center.
How to view payments in WePay's Partner Center.

Filter transactions:

How to filter transactions in Wepay's Partner Center.
How to filter transactions in Wepay's Partner Center.

Payment details are available in the filtered display.