Loading...
In this guide, you’ll learn how to use our Deposits, Transactions, and Disputes capabilities so you can understand how a daily transfer of funds to you works. Our examples provide a way to get more details for a particular deposit, but keep in mind that we offer maximum flexibility for how to pull deposit data, whether it’s by timeframe, status, bank account number, and so on.
For information on managing transactions, see Manage Payments.
For more information on Settlement Reporting, see our Overview.
Settlement Reporting is available only to merchants who use us as their acquirer.
Before starting the steps in this guide, you must do the following:
In this step, we pull a list of deposits. For this initial request, you must submit an Account Name or Account ID and the desired timeframe. You can filter the returned data by:
You can sort the returned data by time created, status, or deposit in ascending or descending order. The page size can also be specified.
In our example, we're not using any filters as we want to return all of the deposits in the timeframe specified. To make things simple, we're only going to return two deposits per page.
The response data contains all of the deposits to your bank account within the specified timeframe. For each deposit, a summary object is returned outlining the number of sales, refunds, and disputes included in the deposit, along with any fees applied or discounts. The deposit’s unique ID is also returned, which we can use in Step 2 to get more details on this particular deposit.
Now that we have our deposit ID, we can call the transaction’s endpoint to pull the data of each individual sale or refund that makes up the deposit. It can also include disputes, which we cover in Step 3. The status of the transactions can be either funded or rejected.
To search for a particular transaction in a deposit (or a particular timeframe), add the following data points to your request:
For each of the deposit’s transactions, the response data contains funding status, time created, time batched, and the payment method the customer used. Also returned is the transaction’s unique merchant and acquirer references, which you can use to programmatically reconcile the sales and refunds from your ecommerce or point-of-sale solutions with the transactions funded into your bank account.
Our final step is to pull the list of disputes that make up the deposit. To do this, we call the Disputes endpoint using the deposit ID.
For each of the deposit’s disputes, the response data contains the reason, date created, and the last adjustment, which indicates whether the funds were debited or credited to your account. You also receive data on the dispute’s status and what stage of the process it’s in. For more information on disputes, see Disputes Management.
Our Settlement Reporting solution is available for testing in our free Sandbox environment for registered users of this developer portal. Use our resources below to start testing.
Test different transaction outcomes with simulated cards or banks.
View, import, or fork our API collection in Postman.
View successful responses, HTTP status codes, action response data, and errors.
To get a deeper understanding of Settlement Reporting, we recommend that you use our provided integration references for both API and SDK integrations. For the full detailed API specification, see the API Explorer.
API Guide to using the Settlement Reporting Functionality.
Explore all of the payment actions that are available for our API.
Add server-side or client-side code to your integration.
Demo how easy it is to integrate our customizable solutions into your existing payment experience, and view transactions from multiple channels and regions in one place.
Below are value-added services you can enable for Real-Time Data Reporting.