SbPublicApiCaptureResponse

snowbee.SbPublicApiCaptureResponse

object · non-null

amountstringnullableoptional

Captured amount

Format: BigDecimal
Pattern: ^-?\d+(\.\d{1,2})?$

Example"747.50"

createdDatestringnullableoptional

Date the capture was created

Format: date

Example"2024-06-15"

idstringnon-nullrequired

Example"01234567-89ab-cdef-0123-456789abcdef"

linesarray of objectnon-nullrequired

Show item fields

lineItemIdstringnon-nullrequired: Reference to order line item
Example"01234567-89ab-cdef-0123-456789abcdef"
quantitystringnon-nullrequired: Quantity captured
Format: BigDecimal
Example"2.0"

statusstringnon-nullrequired

Capture status

Allowed values"PENDING""CONFIRMED""FAILED"

View raw schema

{
  "type": "object",
  "properties": {
    "amount": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "description": "Captured amount",
      "example": "747.50",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    },
    "createdDate": {
      "type": [
        "null",
        "string"
      ],
      "format": "date",
      "description": "Date the capture was created",
      "example": "2024-06-15",
      "title": "LocalDate"
    },
    "id": {
      "type": "string",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiCaptureLineResponse"
      },
      "title": "List<SbPublicApiCaptureLineResponse>"
    },
    "status": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiCaptureStatus",
      "description": "Capture status"
    }
  },
  "required": [
    "id",
    "lines",
    "status"
  ],
  "title": "SbPublicApiCaptureResponse"
}