v25

OpenAPI 3.1.0raw.githubusercontent.com2026-08-014254240.1 KB
Returns

List returns

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

get/v1/returns

Query parameters

limitinteger

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

cursorstring

Opaque cursor from a previous next_cursor.

status'pending' | 'paid' | 'failed' | 'returned'

Current status of the return.

deposit_idstring uuid

Filter returns belonging to this deposit.

created_at.gtestring date-time

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

created_at.ltestring date-time

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