{
  "opencollection": "1.0.0",
  "info": {
    "name": "Affirm Transactions API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Transactions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Affirm List Transactions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.affirm.com/api/v1/transactions",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to return per page."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor returned from a previous list response."
              }
            ]
          },
          "docs": "Returns a paginated list of all transactions for the authenticated merchant. Transactions represent authorized Affirm loans that can be captured, refunded, or voided. Results are sorted by creation date in descending order."
        },
        {
          "info": {
            "name": "Affirm Authorize a Transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.affirm.com/api/v1/transactions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Authorizes a new transaction using a checkout token obtained after a customer completes the Affirm checkout flow. The checkout token is a one-time-use token that must be exchanged server-side within the authorization window. A successful authorization places a hold on the customer's Affirm credit and returns a transaction object with status \"authorized\". The transaction must subsequently be captured to initiate transfer of funds to the merchant."
        },
        {
          "info": {
            "name": "Affirm Read a Transaction",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.affirm.com/api/v1/transactions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the transaction."
              }
            ]
          },
          "docs": "Retrieves the full details of a specific transaction by its unique identifier. Returns the transaction object including current status, amounts, associated events, order metadata, and authorization expiration time."
        },
        {
          "info": {
            "name": "Affirm Update a Transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.affirm.com/api/v1/transactions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the transaction."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates mutable fields on an existing transaction, such as the merchant order ID. Only fields included in the request body are updated; omitted fields remain unchanged."
        },
        {
          "info": {
            "name": "Affirm Capture a Transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.affirm.com/api/v1/transactions/:id/capture",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the transaction."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Captures a previously authorized transaction and initiates the transfer of funds to the merchant. A capture can be for the full authorized amount or a partial amount when split capture is configured. Once captured, the transaction transitions to \"captured\" status and Affirm initiates the settlement process. Partial captures leave the remaining authorized amount available for subsequent captures."
        },
        {
          "info": {
            "name": "Affirm Refund a Transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.affirm.com/api/v1/transactions/:id/refund",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the transaction."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Issues a full or partial refund on a captured transaction. Partial refunds may be issued multiple times until the total refunded amount equals the captured amount. The refund is applied to the customer's Affirm account and the merchant's settlement is adjusted accordingly. The transaction's amount_refunded field is updated to reflect the cumulative refunded total."
        },
        {
          "info": {
            "name": "Affirm Void a Transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.affirm.com/api/v1/transactions/:id/void",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the transaction."
              }
            ]
          },
          "docs": "Voids an authorized transaction that has not yet been captured, releasing the hold on the customer's Affirm credit. A voided transaction cannot be subsequently captured or refunded. This operation is typically used when an order is cancelled after authorization but before fulfillment."
        }
      ]
    },
    {
      "info": {
        "name": "Transaction Events",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Affirm List Transaction Events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.affirm.com/api/v1/transaction_events",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to return per page."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor returned from a previous list response."
              }
            ]
          },
          "docs": "Returns a paginated list of transaction event records for the authenticated merchant. Each event documents a change in a transaction's lifecycle, such as an authorization, capture, refund, or void. Events include timestamps, amounts, fees, and reference identifiers for reconciliation."
        }
      ]
    },
    {
      "info": {
        "name": "Settlement Events",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Affirm List Settlement Events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.affirm.com/api/v1/settlement_events",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to return per page."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor returned from a previous list response."
              }
            ]
          },
          "docs": "Returns a paginated list of settlement events representing individual disbursement line items from Affirm to the merchant. Each settlement event is tied to a transaction event and includes the net amount disbursed after fees. Used for financial reconciliation and accounting."
        },
        {
          "info": {
            "name": "Affirm List Settlement Event Summaries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.affirm.com/api/v1/settlement_event_summaries",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to return per page."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor returned from a previous list response."
              }
            ]
          },
          "docs": "Returns a paginated list of settlement event summary records that aggregate settlement activity by disbursement batch. Each summary includes the total amount disbursed, the date of the disbursement, and a count of associated settlement events. Used for high-level financial reconciliation."
        }
      ]
    }
  ],
  "bundled": true
}