Deposits

List deposits

Changed on

Lists deposits for the merchant with cursor-based pagination.

get/v1/deposits

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/deposits
  • Auth
    HTTP bearer

Query parameters

limitinteger

Number of results per page (1-100). Defaults to 10.

cursorstring

Opaque cursor from a previous next_cursor.

settled_at.gtestring date-time
Example:2026-01-01T00:00:00Z

Include deposits whose settled_at is greater than or equal to this ISO 8601 timestamp.

settled_at.ltestring date-time
Example:2026-02-01T00:00:00Z

Include deposits whose settled_at is less than or equal to this ISO 8601 timestamp.

rail'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy'

Filter by deposit rail.

currenciesstring[]

Filter to these currency codes. Use a separate currencies query parameter for each value (e.g. ?currencies=EUR&currencies=USD).

[
  "USD"
]

Response

Paginated list of deposits

has_moreboolean required
next_cursorstring nullable required
has_previousboolean required
previous_cursorstring nullable required

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440004",
      "status": "settled",
      "account_id": "550e8400-e29b-41d4-a716-446655440001",
      "amount": "100.50",
      "currency": "USD",
      "counterparty_id": "550e8400-e29b-41d4-a716-446655440000",
      "unstructured_remittance_information": "INV-2026-0042",
      "tracking_reference": {
        "type": "uetr",
        "value": "550e8400-e29b-41d4-a716-446655440000"
      },
      "rail": "ach",
      "returns": [],
      "settled_at": "2026-01-15T10:30:00Z"
    }
  ],
  "next_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0",
  "previous_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0"
}

Changes

  • f7ded6c181abRevision changes
    • info

      endpoint added

  • 79d607871de9Revision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      deleted the query request parameter created_at.gte

    • warning

      deleted the query request parameter created_at.lte

    • warning

      deleted the query request parameter status

    • warning

      added the new bitcoin enum value to the // response property for the response status

    • warning

      added the new bitcoin_testnet4 enum value to the // response property for the response status

    • warning

      added the new ethereum enum value to the // response property for the response status

    • warning

      added the new ethereum_sepolia enum value to the // response property for the response status

    • warning

      added the new polygon enum value to the // response property for the response status

    • warning

      added the new polygon_amoy enum value to the // response property for the response status

    • warning

      added the new settled enum value to the // response property for the response status

    • warning

      added the new solana enum value to the // response property for the response status

    • warning

      added the new solana_devnet enum value to the // response property for the response status

    • info

      added the new optional query request parameter settled_at.gte

    • info

      added the new optional query request parameter settled_at.lte

    • info

      removed the btc enum value from the // response property for the response status

    • info

      removed the btc_testnet4 enum value from the // response property for the response status

    • info

      removed the elixir enum value from the // response property for the response status

    • info

      removed the eth enum value from the // response property for the response status

    • info

      removed the eth_sepolia enum value from the // response property for the response status

    • info

      removed the express_elixir enum value from the // response property for the response status

    • info

      removed the in_return enum value from the // response property for the response status

    • info

      removed the matic enum value from the // response property for the response status

    • info

      removed the matic_amoy enum value from the // response property for the response status

    • info

      removed the received enum value from the // response property for the response status

    • info

      removed the return_failed enum value from the // response property for the response status

    • info

      removed the return_returned enum value from the // response property for the response status

    • info

      removed the returned enum value from the // response property for the response status

    • info

      removed the sek_account_to_account enum value from the // response property for the response status

    • info

      removed the sol enum value from the // response property for the response status

    • info

      removed the sol_devnet enum value from the // response property for the response status

    • info

      removed the straksclearing enum value from the // response property for the response status

    • info

      removed the sumclearing enum value from the // response property for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status