Deposits

Retrieve a detailed list of deposits made to your merchants' bank accounts by date range. This report provides a comprehensive breakdown of all transactions and actions that comprise each deposit, helping your merchants reconcile payments received in your bank account.

Overview

As your merchants process transactions, deposits are made to their bank accounts at scheduled times throughout the day. The Deposits API provides detailed information about:

  • The total amount deposited to each merchant's bank account
  • Individual transactions that make up each deposit
  • Transaction types (payments, payouts, refunds, adjustments, etc.)
  • Customer information associated with each transaction
  • Transaction status and timing details

This endpoint is essential for reconciliation, accounting, and understanding the composition of funds received in their bank account.




Deposit Windows

Deposits are processed and reported at three specific times each day (Eastern Time):

  • 8:00 AM ET
  • 12:00 PM ET
  • 6:00 PM ET
  • 9:00 PM ET

If there is no activity during a specific window, the response will indicate No Activity for that time period.




Deposit Types

Each deposit may contain transactions from one or more of the following types:

  • Payment Settlement
    • Payments collected from customers that have settled and are being deposited to the merchant's bank account
  • Payout Origination
    • Outbound payments initiated to send funds from the merchant's bank account
  • Refund Origination
    • Refunds issued to customers - money debited from the merchant's bank account to return funds back to the customer
  • Late Return Rectification
    • Clawback of funds that the processor needs to recoup from the merchant because a transaction was returned after it had already settled.
  • Processor Adjustment
    • Adjustments made by the payment processor (aka, corrections)



Response Structure

The response is organized hierarchically by:

  1. Date (YYYY-MM-DD)
  2. Time Window (8:00 AM ET, 12:00 PM ET, 6:00 PM ET, 9:00 PM ET)
  3. Deposits (array of deposit objects for that time window)
  4. Transactions (array of transactions within each deposit)
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!