HomeGetting StartedSolutionsPlatformsGlobal Integration
API reference

List Settlement Events

get
https://sandbox.affirm.com/api/v1/settlements/events

Lists settlement events by merchant.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

New Optional Response Fields for Universal Financing Parity Merchants (UFP)

New optional response fields have been added for UFP merchants. The new fields include the following:

  • initiating_merchant_id: contains the ID of the merchant where order was made.
  • city: contains the store’s city where the order was made, obtained directly from card rails (externally controlled).
  • store: contains the store’s name where the order was made, obtained directly from card rails (externally controlled).
  • card_last_four: contains the last four digits of the payment instrument (FPAN).
  • original_loan_amount: contains the original order total.
  • channel: contains the channel type where an Affirm checkout was initiated, for example:
      - Affirm Direct
      - Apple Pay
      - Google Pay
      - Affirm Card
      - Affirm VCN
Query Params
string
required

The Affirm Merchant ID

integer
1 to 1000

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

date

The beginning of the date range (inclusive)

date

The end of the date range (inclusive)

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

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

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

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

string
enum

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

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 7 months ago