Bolt · Schema

payment-incremental-authorization-request

CheckoutPaymentseCommerceOne-Click CheckoutShopper NetworkFraud Protection

Properties

Name Type Description
amount integer Additional amount to authorize in the smallest currency unit (cents for USD)
currency string Currency code for the additional amount
merchant_event_id string Optional merchant event ID for tracking purposes
skip_hook_notification boolean Field to skip webhook notification
seller_info object
View JSON Schema on GitHub

JSON Schema

payment-incremental-authorization-request.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.bolt.com/schemas/payment-incremental-authorization-request",
  "title": "payment-incremental-authorization-request",
  "type": "object",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Additional amount to authorize in the smallest currency unit (cents for USD)",
      "example": 500,
      "minimum": 1
    },
    "currency": {
      "type": "string",
      "description": "Currency code for the additional amount",
      "example": "USD",
      "pattern": "^[A-Z]{3}$"
    },
    "merchant_event_id": {
      "type": "string",
      "description": "Optional merchant event ID for tracking purposes",
      "example": "event_12345"
    },
    "skip_hook_notification": {
      "type": "boolean",
      "description": "Field to skip webhook notification",
      "example": true
    },
    "seller_info": {
      "$ref": "#/components/schemas/seller-info"
    }
  }
}