Returns

List returns

Changed on

Lists deposit returns for the merchant with cursor-based pagination.

get/v1/returns

Request

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

Query parameters

limitinteger

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

cursorstring

Opaque cursor from a previous next_cursor.

status'initiated' | 'submitted' | 'sent' | 'failed' | 'returned'
Example:sent

Filter by return status.

deposit_idstring uuid
Example:550e8400-e29b-41d4-a716-446655440004

Filter returns belonging to this deposit.

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

Include returns whose created_at is greater than or equal to this ISO 8601 timestamp.

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

Include returns whose created_at is less than or equal to this ISO 8601 timestamp.

Response

Paginated list of returns

has_moreboolean required
next_cursorstring nullable required
has_previousboolean required
previous_cursorstring nullable required

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440005",
      "status": "sent",
      "deposit_id": "550e8400-e29b-41d4-a716-446655440004",
      "amount": "100.50",
      "currency": "USD",
      "initiated_at": "2026-01-15T10:30:00Z",
      "sent_at": "2026-01-15T10:35:00Z",
      "rail": "ach",
      "metadata": {
        "invoice_id": "INV-2026-0042"
      }
    }
  ],
  "next_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0",
  "previous_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0"
}

Changes

  • f7ded6c181abRevision changes
    • info

      endpoint added

  • ca35cff0b637Revision changes
    • warning

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

    • info

      added the new enum value submitted to the query request parameter status