{ "opencollection": "1.0.0", "info": { "name": "Affirm Checkout Authorization Transactions API", "version": "1.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Transactions", "type": "folder" }, "items": [ { "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 to initiate transfer of funds to the merchant. Capture may be for the full authorized amount or a partial amount when split capture is in use. The merchant should capture only upon order fulfillment or shipment to align with Affirm's terms of service." }, { "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 but uncaptured transaction, releasing the hold on the customer's Affirm credit. Used when an order is cancelled prior to fulfillment. A voided transaction cannot be captured or refunded." }, { "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 Direct API transaction. Partial refunds can be applied multiple times until the total refunded amount equals the captured amount. The customer's Affirm account is credited and the merchant's settlement is adjusted." }, { "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." } ] } ], "bundled": true }