Verifone · Schema

stored_credential

Used for transactions with Stored Credentials

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel

Properties

Name Type Description
stored_credential_type string must be one of SIGNUP CHARGE
first_payment boolean Set to true if this signup request also is the first payment. Most relevant for signup using a minor amount, to indicate if that minor amount is just a signup account verification amount or an actual
consent_text string Optional merchant provided text to display to the shopper as a checkbox, requiring their consent for the given sign up, detailing the terms at which the shopper agrees to be charged in the future. If
consent_text_dynamic_values object
processing_model_details object
reference string
scheme_reference string
View JSON Schema on GitHub

JSON Schema

checkout-api-stored_credential.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/checkout-api-stored_credential.json",
  "title": "stored_credential",
  "description": "Used for transactions with <a target=\"_blank\" href=\"https://docs.verifone.com/online-payments/stored-credentials\">Stored Credentials</a>",
  "required": [
    "processing_model_details",
    "stored_credential_type"
  ],
  "type": "object",
  "properties": {
    "stored_credential_type": {
      "type": "string",
      "description": "must be one of  SIGNUP CHARGE",
      "enum": [
        "SIGNUP",
        "CHARGE"
      ]
    },
    "first_payment": {
      "type": "boolean",
      "description": "Set to true if this signup request also is the first payment.\nMost relevant for signup using a minor amount, to indicate if that minor amount is just a signup account verification amount or an actual first payment amount as well.\nDefault on this endpoint is that zero amount is not a payment, but any amount provided is a payment.\nUse this indicator to explicitly tell the intention.\n"
    },
    "consent_text": {
      "maxLength": 2048,
      "pattern": "[\\p{L}\\p{N}.,_\\-+\\s\\\\{\\\\}]",
      "type": "string",
      "description": "Optional merchant provided text to display to the shopper as a checkbox, requiring their consent for the given sign up, detailing the terms at which the shopper agrees to be charged in the future. If not provided, there will be no consent checkbox."
    },
    "consent_text_dynamic_values": {
      "$ref": "#/components/schemas/consentTextDynamicValues"
    },
    "processing_model_details": {
      "$ref": "#/components/schemas/processing_model_details"
    },
    "reference": {
      "type": "string"
    },
    "scheme_reference": {
      "type": "string"
    }
  }
}