Affirm · JSON Structure

Direct Api Transaction Structure

Represents an Affirm payment transaction at any point in its lifecycle.

Type: object Properties: 9

FintechBNPLLendingPaymentsConsumer

Transaction is a JSON Structure definition published by Affirm, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id checkout_id order_id status amount amount_refunded currency created authorization_expiration

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/affirm/refs/heads/main/json-structure/direct-api-transaction-structure.json",
  "name": "Transaction",
  "description": "Represents an Affirm payment transaction at any point in its lifecycle.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for this transaction.",
      "example": "500123"
    },
    "checkout_id": {
      "type": "string",
      "description": "Identifier of the checkout session that originated this transaction.",
      "example": "500123"
    },
    "order_id": {
      "type": "string",
      "description": "Merchant's internal order identifier.",
      "example": "500123"
    },
    "status": {
      "type": "string",
      "description": "Current lifecycle status of the transaction.",
      "enum": [
        "authorized",
        "captured",
        "voided",
        "refunded",
        "partially_refunded"
      ],
      "example": "authorized"
    },
    "amount": {
      "type": "int32",
      "description": "Original authorized amount in cents.",
      "example": 1
    },
    "amount_refunded": {
      "type": "int32",
      "description": "Cumulative amount refunded in cents.",
      "example": 1
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code.",
      "example": "USD"
    },
    "created": {
      "type": "datetime",
      "description": "Creation timestamp in RFC 3339 format.",
      "example": "2025-03-15T14:30:00Z"
    },
    "authorization_expiration": {
      "type": "datetime",
      "description": "Timestamp after which the authorization can no longer be captured.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}