AFaffirm
Transactions API

List Transaction Events

Changed on

Lists transaction events.

get/transactions/events

Request

  • Base URL
    https://sandbox.affirm.com/api/v1
  • URL
    https://sandbox.affirm.com/api/v1/transactions/events
  • Auth
    HTTP basic

Query parameters

transaction_type'charge' required

Type of transaction to be listed, list one of charge.

transaction_event_type'authorize' | 'capture' | 'refund' | 'void' | 'all' required

Type of transaction events to be listed, list one of authorize, capture, refund, void, or all.

limitstring

Max number of transaction events to list per page.

before_datestring

End date of query.

after_datestring

Start date of query.

before_aristring

Optional end event ARI of query, used during pagination. Mutually exclusive with the 'after_ari' query parameter - i.e. only one of 'after_ari' or 'before_ari' can be specified in one request.

after_aristring

Optional end event ARI of query, used during pagination. Mutually exclusive with the 'after_ari' query parameter - i.e. only one of 'after_ari' or 'before_ari' can be specified in one request.

merchant_idstring

Optional ARI of merchant issuing the list events request.

Response

HTTP 200 OK

prev_pagestring

URL-encoded parameters that include the event ari of the previous (newer) results for cursor-based pagination.

next_pagestring

URL-encoded parameters that include the event ari of the next (older) results for cursor-based pagination.

Example response

{
  "transactions": [
    {
      "transaction_id": "ABCD-1234",
      "transaction_events": [
        {
          "amount": 20000,
          "created": "2019-01-01T00:00:00.000Z",
          "currency": "USD",
          "fee": 500,
          "fee_refunded": 500,
          "id": "ABCD-1234",
          "reference_id": "202307011027",
          "type": "capture",
          "transaction_id": "ABCD-1234",
          "order_id": "order_125",
          "shipping_carrier": "USPS",
          "shipping_confirmation": "C12345678901234",
          "shipping": {
            "address": {
              "line1": "123 Example Street",
              "line2": "Apt 123",
              "city": "San Francisco",
              "state": "CA",
              "country": "US",
              "email": "test@example.com",
              "phone_number": "1234567890"
            }
          }
        }
      ]
    }
  ],
  "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