AFaffirm
Transactions API

List Settlement Event Summaries

Changed on

Lists settlement event summaries by merchant.

get/settlements/daily

Request

  • Base URL
    https://sandbox.affirm.com/api/v1
  • URL
    https://sandbox.affirm.com/api/v1/settlements/daily
  • Auth
    HTTP basic

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). Default is 30 days ago.

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

countinteger required

The number of settlement summary events returned on the current page.

prev_pagestring required

URL-encoded parameters that include the date and UUID of the previous results for cursor-based pagination. Empty string if no previous results. Previous results refer to newer results if sorted in descending chronological order, and will refer to older results if sorted in ascending chronological order.

next_pagestring required

URL-encoded parameters that include the date and UUID of the next results for cursor-based pagination. Empty string if no next results. Next results refer to older results if sorted in descending chronological order, and will refer to newer results if sorted in ascending chronological order.

Example response

{
  "count": 10,
  "data": [
    {
      "date": "2020-01-31T00:00:00.000Z",
      "deposit_id": "DEPOSIT-ARI-123",
      "total_sales": 12345,
      "total_refunds": -12345,
      "total_fees": 12345,
      "total_settled": 12345,
      "account_last_four": "1234",
      "currency": "USD"
    }
  ],
  "prev_page": "example.com%2Fprev_page",
  "next_page": "example.com%2Fnext_page"
}

Changes

  • 360ca87d6c3eRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status