PaymentMethodRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/braintree/json-schema/braintree-payment-method-request-schema.json",
  "title": "PaymentMethodRequest",
  "description": "Request body for vaulting a new payment method for an existing customer.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/braintree-payment-methods-api-openapi.yml#/components/schemas/PaymentMethodRequest",
  "type": "object",
  "required": [
    "customer_id",
    "payment_method_nonce"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "description": "The identifier of the customer to associate this payment method with.",
      "maxLength": 36
    },
    "payment_method_nonce": {
      "type": "string",
      "description": "A one-time-use reference to payment information provided by the Braintree client SDK. Consumed upon vaulting."
    },
    "token": {
      "type": "string",
      "description": "Custom token to assign to this payment method. If omitted, Braintree generates a unique token.",
      "maxLength": 36
    },
    "billing_address": {
      "$ref": "#/$defs/Address"
    },
    "options": {
      "type": "object",
      "description": "Options that modify the payment method vaulting behavior.",
      "properties": {
        "make_default": {
          "type": "boolean",
          "description": "If true, this payment method becomes the customer's default payment method.",
          "default": false
        },
        "fail_on_duplicate_payment_method": {
          "type": "boolean",
          "description": "If true, the request fails if a duplicate payment method already exists in the customer's vault.",
          "default": false
        },
        "verify_card": {
          "type": "boolean",
          "description": "If true, runs a card verification before vaulting the payment method.",
          "default": false
        }
      }
    }
  },
  "$defs": {
    "Address": {
      "type": "object",
      "description": "A billing or shipping address associated with a transaction or customer.",
      "properties": {
        "first_name": {
          "type": "string",
          "description": "First name of the address holder.",
          "maxLength": 255
        },
        "last_name": {
          "type": "string",
          "description": "Last name of the address holder.",
          "maxLength": 255
        },
        "company": {
          "type": "string",
          "description": "Company or organization name at this address.",
          "maxLength": 255
        },
        "street_address": {
          "type": "string",
          "description": "Primary street address line.",
          "maxLength": 255
        },
        "extended_address": {
          "type": "string",
          "description": "Secondary address line such as apartment or suite number.",
          "maxLength": 255
        },
        "locality": {
          "type": "string",
          "description": "City or locality of the address.",
          "maxLength": 255
        },
        "region": {
          "type": "string",
          "description": "State, province, or region code of the address.",
          "maxLength": 255
        },
        "postal_code": {
          "type": "string",
          "description": "Postal or ZIP code of the address.",
          "maxLength": 9
        },
        "country_code_alpha2": {
          "type": "string",
          "description": "Two-letter ISO 3166-1 alpha-2 country code.",
          "pattern": "^[A-Z]{2}$"
        }
      }
    }
  }
}