Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Query Parameters

limit
integer
default:10

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

Required range: 1 < x < 100
cursor
string

Opaque cursor from a previous next_cursor.

status
enum<string>

Current status of the return.

Available options:
pending,
paid,
failed,
returned
deposit_id
string<uuid>

Filter returns belonging to this deposit.

created_at.gte
string<date-time>

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

created_at.lte
string<date-time>

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

Response

200 - application/json

Paginated list of returns

data
object[]
required
has_more
boolean
required
next_cursor
string | null
required