braintree · Schema

TransactionOptions

Configuration options that modify transaction processing behavior.

Properties

Name Type Description
submit_for_settlement boolean If true, the transaction is automatically submitted for settlement after authorization. Defaults to false.
store_in_vault boolean If true, the payment method is stored in the Braintree Vault after the transaction is created.
store_in_vault_on_success boolean If true, the payment method is stored in the Vault only if the transaction is successfully authorized.
skip_avs boolean Skip the address verification check for this transaction.
skip_cvv boolean Skip the CVV verification check for this transaction.
hold_in_escrow boolean If true, funds are held in escrow rather than disbursed immediately. Applicable to Braintree Marketplace transactions only.
View JSON Schema on GitHub

JSON Schema

braintree-transactionoptions-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TransactionOptions",
  "title": "TransactionOptions",
  "type": "object",
  "description": "Configuration options that modify transaction processing behavior.",
  "properties": {
    "submit_for_settlement": {
      "type": "boolean",
      "description": "If true, the transaction is automatically submitted for settlement after authorization. Defaults to false.",
      "default": false
    },
    "store_in_vault": {
      "type": "boolean",
      "description": "If true, the payment method is stored in the Braintree Vault after the transaction is created.",
      "default": false
    },
    "store_in_vault_on_success": {
      "type": "boolean",
      "description": "If true, the payment method is stored in the Vault only if the transaction is successfully authorized.",
      "default": false
    },
    "skip_avs": {
      "type": "boolean",
      "description": "Skip the address verification check for this transaction.",
      "default": false
    },
    "skip_cvv": {
      "type": "boolean",
      "description": "Skip the CVV verification check for this transaction.",
      "default": false
    },
    "hold_in_escrow": {
      "type": "boolean",
      "description": "If true, funds are held in escrow rather than disbursed immediately. Applicable to Braintree Marketplace transactions only.",
      "default": false
    }
  }
}