Get Deposits

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/deposits \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>'

{
  "data": [
    {
      "id": "8810f34fd5061afeec3eab67",
      "status": "PAID",
      "type": "AUTOMATED",
      "amountInCents": 125000,
      "arrivalAt": "2026-05-20T00:00:00.000Z",
      "startingBalanceInCents": 0,
      "endingBalanceInCents": 125000,
      "bankName": "Chase",
      "bankLast4": "1234",
      "statementDescriptor": "OVERFLOW PAYOUT",
      "paymentMethodType": [
        "card",
        "ach"
      ],
      "name": "May payout",
      "reconciledAt": null,
      "createdAt": "2026-05-19T00:00:00.000Z",
      "updatedAt": "2026-05-20T00:00:00.000Z",
      "lineItems": [
        {
          "type": "payment",
          "grossValueInCents": 5000,
          "grossFeeValueInCents": 145,
          "referenceId": "6710f34fd5061afeec3eab57",
          "description": "Contribution from John D."
        }
      ]
    }
  ],
  "totalCount": 100
}

Deposits

Get Deposits

Returns deposits for the nonprofit based on the provided filters. A deposit is a settlement from Overflow to the nonprofit’s bank account.

Deposit Status

PENDING: The deposit is awaiting processing.
IN_TRANSIT: The deposit has been initiated and is in transit to the bank.
PAID: The deposit has arrived in the bank account.
FAILED: The deposit failed to be processed.
CANCELED: The deposit was canceled before processing.

Deposit Types

AUTOMATED: A scheduled payout initiated by Overflow.
MANUAL: A payout initiated manually.
IMPORT: An imported historical payout.

Filtering

Use startDate and endDate to filter by the deposit’s arrival date.
Use minimumEstimatedValueInCents and maximumEstimatedValueInCents to filter by net amount (values are in cents).
Use reconciled to filter by reconciliation status.

All monetary amounts in the response are expressed in cents.

GET

api

deposits

Get Deposits

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/deposits \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>'

{
  "data": [
    {
      "id": "8810f34fd5061afeec3eab67",
      "status": "PAID",
      "type": "AUTOMATED",
      "amountInCents": 125000,
      "arrivalAt": "2026-05-20T00:00:00.000Z",
      "startingBalanceInCents": 0,
      "endingBalanceInCents": 125000,
      "bankName": "Chase",
      "bankLast4": "1234",
      "statementDescriptor": "OVERFLOW PAYOUT",
      "paymentMethodType": [
        "card",
        "ach"
      ],
      "name": "May payout",
      "reconciledAt": null,
      "createdAt": "2026-05-19T00:00:00.000Z",
      "updatedAt": "2026-05-20T00:00:00.000Z",
      "lineItems": [
        {
          "type": "payment",
          "grossValueInCents": 5000,
          "grossFeeValueInCents": 145,
          "referenceId": "6710f34fd5061afeec3eab57",
          "description": "Contribution from John D."
        }
      ]
    }
  ],
  "totalCount": 100
}

Authorizations

x-client-id

string

header

required

Client ID for API authentication

x-api-key

string

header

required

API Key for API authentication

Query Parameters

limit

number

default:25

The number of deposits to return.

Required range: 1 <= x <= 100

page

number

default:1

The page number of the deposits to return.

Required range: x >= 1

createdAt

string<date-time>

Filter deposits created on this date.

Example:

"2026-01-15"

startDate

string<date-time>

Filter deposits whose arrival date is on or after this date.

Example:

"2026-01-01"

endDate

string<date-time>

Filter deposits whose arrival date is on or before this date.

Example:

"2026-02-01"

ids

string[]

Filter by deposit ids.

sortBy

string

Field to sort deposits by. Defaults to arrival date.

sortDirection

enum<string>

Sort direction. Defaults to descending.

Available options:

ASC,

DESC

string

Free-text search across deposit fields.

reconciled

boolean

Filter by reconciliation status.

minimumEstimatedValueInCents

Filter deposits with net amount greater than or equal to this value, in cents.

maximumEstimatedValueInCents

Filter deposits with net amount less than or equal to this value, in cents.

paymentMethod

string[]

Filter by payment method types.

Example:

["card", "ach"]

types

string[]

Filter by deposit types.

Response

200 - application/json

data

object[]

required

List of deposits.

Show child attributes

totalCount

number

required

Total number of deposits matching the filters.

Example:

100

Initiate Refund Get Deposit

⌘I

Documentation Index

Authorizations

Query Parameters

Response