v1

latestOpenAPI 3.0.02026-07-262561105.1 KB

Transactions API

List Settlement Events

Lists settlement events by merchant.

get/settlements/events

Query parameters

merchant_idstring required

The Affirm Merchant ID

limitinteger

The maximum number of results per page. Default is 5.

afterstring date

The beginning of the date range (inclusive)

beforestring date

The end of the date range (inclusive)

from_cursor_uuidstring uuid

Optional paging cursor uuid after which results should be returned. This uuid, along with from_cursor_date is returned in the prev_page field in the 200 response

from_cursor_datestring date

Optional paging cursor date after which results should be returned. This date, along with from_cursor_uuid is returned in the prev_page field in the 200 response

to_cursor_uuidstring uuid

Optional paging cursor uuid before which results should be returned. This uuid, along with to_cursor_date is returned in the next_page field in the 200 response

to_cursor_datestring date

Optional paging cursor date before which results should be returned. This date, along with to_cursor_uuid is returned in the next_page field in the 200 response

ordering'ascending' | 'descending'

Optional parameter to define ordering of results. Default is descending chronological order

Response

HTTP 200 OK