Authentication Payer Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-authentication-payer-response-schema.json",
  "title": "Authentication Payer Response",
  "description": "Payment Request",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-authentication-api-openapi.yml#/components/schemas/Authentication-Payer-Response",
  "type": "object",
  "required": [
    "authentication",
    "customer",
    "order",
    "transaction"
  ],
  "properties": {
    "authentication": {
      "$ref": "#/$defs/Authentication-Payer-Initiate-Response"
    },
    "customer": {
      "$ref": "#/$defs/Customer-Authentication-Response"
    },
    "method": {
      "$ref": "#/$defs/Authentication-Payer-Method-Response"
    },
    "transaction": {
      "$ref": "#/$defs/Authentication-Transaction-Response"
    },
    "order": {
      "$ref": "#/$defs/Authentication-Payer-Order-Response"
    },
    "mandate": {
      "$ref": "#/$defs/Authentication-Mandate"
    },
    "shipping": {
      "$ref": "#/$defs/Authentication-Payer-Shipping"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "Additional-Info": {
      "title": "Additional-Info /n- For Brazil and CARD transactions allowed maxmium of 50 lines /n- For India CARD transactions allowed maxmium of 10 lines",
      "properties": {
        "name": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string",
          "description": "Specifies a character string with a maximum length of 50 characters. If transaction.Additional-Info.name is provided by merchant then transaction.Additional-Info.value is mandatory.",
          "title": "name"
        },
        "value": {
          "maxLength": 500,
          "minLength": 1,
          "type": "string",
          "description": "Specifies a character string with a maximum length of 200 characters.  if transaction.Additional-Info.value is provided by merchant then transaction.Additional-Info.name is mandatory.",
          "title": "value"
        }
      }
    },
    "Authentication-Address": {
      "type": "object",
      "description": "Authentication Address",
      "title": "Authentication Address",
      "properties": {
        "city": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string",
          "description": "City.",
          "title": "city"
        },
        "postal_code": {
          "maxLength": 16,
          "minLength": 1,
          "type": "string",
          "description": "Postal code.",
          "title": "postal_code"
        },
        "state": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "description": "State.",
          "title": "state"
        },
        "country_code": {
          "type": "string",
          "pattern": "^[A-Z]{2,2}$",
          "description": "Country.",
          "title": "country_code"
        },
        "province_code": {
          "description": "The three character ISO 3166-2 country subdivision code for the state or province of the address",
          "maxLength": 3,
          "minLength": 1,
          "type": "string",
          "title": "province_code"
        },
        "lines": {
          "type": "array",
          "minItems": 1,
          "maxItems": 7,
          "items": {
            "$ref": "#/$defs/Lines"
          },
          "title": "lines"
        }
      }
    },
    "Authentication-Customer-Device-Response": {
      "title": "Authentication Customer Device Response",
      "description": "Customer-Device.",
      "required": [
        "ciphertext",
        "nonce",
        "tag"
      ],
      "properties": {
        "ani": {
          "description": "The telephone number captured by ANI (Automatic Number Identification) when the customer calls to place the order.",
          "maxLength": 10,
          "minLength": 1,
          "type": "string",
          "title": "ani"
        },
        "ani_call_type": {
          "description": "The 2 digit ANI information identifier provided by the telephone company to indicate the call type, for example, cellular (61-63), toll free (24,25), etc.",
          "maxLength": 2,
          "minLength": 1,
          "type": "string",
          "title": "ani_call_type"
        },
        "browser": {
          "description": "The User-Agent header of the browser the customer used to place the order.",
          "maxLength": 2048,
          "minLength": 1,
          "type": "string",
          "title": "browser"
        },
        "hostname": {
          "description": "The name of the server to which the customer is connected.",
          "maxLength": 60,
          "minLength": 1,
          "type": "string",
          "title": "hostname"
        },
        "ip_address": {
          "description": "The name of the server to which the customer is connected.",
          "maxLength": 15,
          "minLength": 7,
          "type": "string",
          "title": "ip_address"
        },
        "mobile_phone_model": {
          "description": "The name of the server to which the customer is connected.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string",
          "title": "mobile_phone_model"
        },
        "ciphertext": {
          "description": "Base64 encoded ciphertext.",
          "maxLength": 10000,
          "minLength": 1,
          "type": "string",
          "title": "ciphertext"
        },
        "nonce": {
          "description": "Base64 encoded GCM nonce.",
          "maxLength": 16,
          "minLength": 16,
          "type": "string",
          "title": "nonce"
        },
        "tag": {
          "description": "Base64 encoded GCM tag.",
          "maxLength": 24,
          "minLength": 24,
          "type": "string",
          "title": "tag"
        }
      }
    },
    "Authentication-Customer-History-Payer-Request": {
      "title": "Authentication Customer History Payer Request",
      "description": "Authentication-Customer-Payer-Request",
      "properties": {
        "attempts": {
          "description": "Number of attempts to add/change a card in the last 24 hours (0-99).",
          "maximum": 99,
          "minimum": 1,
          "type": "number",
          "title": "attempts"
        },
        "annual_activity": {
          "description": "Number of transactions (successful/abandoned) in the last year (0-999).",
          "maximum": 999,
          "minimum": 1,
          "type": "number",
          "title": "annual_activity"
        },
        "creation_date": {
          "type": "string",
          "format": "date",
          "description": "The date the payer created an account (yyyy-mm-dd).",
          "title": "creation_date"
        },
        "issuer_acs_id": {
          "description": "The unique transaction identifier used by the issuer's ACS.",
          "maxLength": 36,
          "minLength": 1,
          "type": "string",
          "title": "issuer_acs_id"
        },
        "authentication_token": {
          "description": "The authentication token obtained from a previous request.",
          "maxLength": 32,
          "minLength": 28,
          "type": "string",
          "title": "authentication_token"
        },
        "directory_server_id": {
          "description": "A unique transaction identifier assigned by the scheme Directory Server.",
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "title": "directory_server_id"
        },
        "authentication_time": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time the payer was authenticated for the prior transaction (YYYY-MM-DDThh:mm:ss.SSSZ).",
          "title": "authentication_time"
        },
        "authentication_id": {
          "description": "The gateway transaction ID of a previous Authenticate Payer request to reuse authentication data.",
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "title": "authentication_id"
        },
        "authentication_type": {
          "description": "The method used to authenticate the payer for a prior transaction.",
          "enum": [
            "3DS_FRICTIONLESS",
            "3DS_CHALLENGE",
            "ADDRESS_VERIFICATION",
            "OTHER"
          ],
          "type": "string",
          "title": "authentication_type"
        },
        "last_updated_date": {
          "type": "string",
          "format": "date",
          "description": "The date the payer's account with you was last updated (yyyy-mm-dd).",
          "title": "last_updated_date"
        },
        "password_last_changed_date": {
          "type": "string",
          "format": "date",
          "description": "The date the payer's account with you was last updated (yyyy-mm-dd).",
          "title": "password_last_changed_date"
        },
        "transaction_activity": {
          "description": "Number of transactions (successful/abandoned) in the last 24 hours (0-99).",
          "maximum": 99,
          "minimum": 1,
          "type": "number",
          "title": "transaction_activity"
        },
        "shipping_address_date": {
          "type": "string",
          "format": "date",
          "description": "The date you first shipped goods to the provided shipping address (yyyy-mm-dd).",
          "title": "shipping_address_date"
        },
        "suspicious_activity": {
          "description": "Have you experienced suspicious activity on the account in the past (true/false).",
          "type": "boolean",
          "title": "suspicious_activity"
        }
      }
    },
    "Authentication-Customer-Payer-Response": {
      "title": "Authentication Customer Payer Response",
      "description": "Authentication-Customer-Payer-Response",
      "properties": {
        "action": {
          "description": "Behaviour relating to the association between the customer account and their card.",
          "enum": [
            "AUTHENTICATION",
            "REGISTRATION"
          ],
          "type": "string",
          "title": "action"
        },
        "status": {
          "description": "Status of the card association functionality.",
          "enum": [
            "FAILED",
            "NOT_SUPPORTED",
            "SUCCESSFUL",
            "SUPPORTED"
          ],
          "type": "string",
          "title": "status"
        },
        "method": {
          "description": "The method used to authenticate the payer.",
          "enum": [
            "CUSTOMER_ACCOUNT_LOGIN",
            "FEDERATED_IDENTITY_LOGIN",
            "FIDO_AUTHENTICATION",
            "ISSUER_ACCOUNT_LOGIN",
            "NONE",
            "THIRD_PARTY_ACCOUNT_LOGIN"
          ],
          "type": "string",
          "title": "method"
        },
        "time": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time the payer was authenticated (YYYY-MM-DDThh:mm:ss.SSSZ).",
          "title": "update_time"
        }
      }
    },
    "Authentication-Device-Payment-Response": {
      "title": "Authentication Device Payment Response",
      "type": "object",
      "description": "Device",
      "properties": {
        "cryptogram_format": {
          "description": "The format of the cryptogram provided for the digital payment.",
          "enum": [
            "3DSECURE",
            "EMV"
          ],
          "type": "string",
          "title": "cryptogram_format"
        }
      }
    },
    "Authentication-Mandate": {
      "title": "Mandate",
      "properties": {
        "amount_variability": {
          "description": "Indicates if all the payments within the agreement use the same amount or if the amount differs between the payments. The parameter must be provided for recurring payment agreements.",
          "enum": [
            "FIXED",
            "VARIABLE"
          ],
          "type": "string",
          "title": "amount_variability"
        },
        "custom_data": {
          "description": "Additional information requested for the agreement which cannot be passed using other available data parameters. This parameter must not contain sensitive data.",
          "maxLength": 2048,
          "minLength": 1,
          "type": "string",
          "title": "custom_data"
        },
        "expiry_date": {
          "description": "Date at which your agreement with the payer to process payments expires.",
          "format": "date",
          "type": "string",
          "title": "expiry_date"
        },
        "id": {
          "description": "Your identifier for the agreement you have with the payer to process payments.When you collect cards from your payers and store them for later use, you must provide an agreement ID when you use the stored values for: Recurring payments: you have an agreement with the payer that authorizes you to automatically debit their account at agreed intervals for fixed or variable amounts. For example, gym membership, phone bills, or magazine subscriptions. Installment payments: you have an agreement with the payer that authorizes you to process multiple payments over an agreed period of time for a single purchase. For example, the payer purchases an item for $1000 and pays for it in four monthly installments. Unscheduled: you have an agreement with the payer that authorizes you to process future payments when required. For example, the payer authorizes you to process an account top-up transaction for a transit card when the account balance drops below a certain threshold.Industry Practice: you have an agreement with the payer that authorizes you to initiate additional transactions to fulfil a standard business practice related to an original payment initiated by the payer. For example, a delayed charge for use of the hotel mini bar after the payer has checked out or a no show penalty charge when the payer fails to show for a booking. When you first establish an agreement with the payer you should also specify the type of agreement in agreement.type. \n- For Brazil PIX Initiation, this parameter is mandatory with max length 29 in format RR33479023yyyyMMddBRkkkkkkkkk and this should be same id received as part of push notification while creating the mandate",
          "maxLength": 100,
          "minLength": 1,
          "type": "string",
          "title": "id"
        },
        "maximum_amount": {
          "description": "The maximum amount for a single payment in the series as agreed with the payer under your agreement with them. The amount must be provided in the currency of the order.",
          "maxLength": 14,
          "minLength": 1,
          "type": "string",
          "title": "maximum_amount"
        },
        "minimum_amount": {
          "description": "The minimum amount for a single payment in the series as agreed with the payer under your agreement with them. The amount must be provided in the currency of the order.",
          "maxLength": 14,
          "minLength": 1,
          "type": "string",
          "title": "minimum_amount"
        },
        "minimum_days": {
          "description": "The minimum number of days between payments agreed with the payer under your agreement with them.",
          "maximum": 9999,
          "minimum": 1,
          "type": "number",
          "title": "minimum_days"
        },
        "number_of_payments": {
          "description": "The number of merchant-initiated payments within the recurring payment agreement.",
          "maximum": 999,
          "minimum": 1,
          "type": "number",
          "title": "number_of_payments"
        },
        "frequency": {
          "description": "The frequency of the payments within the series as agreed with the payer under your agreement with them.",
          "enum": [
            "AD_HOC",
            "DAILY",
            "FORTNIGHTLY",
            "MONTHLY",
            "OTHER",
            "QUARTERLY",
            "TWICE_YEARLY",
            "WEEKLY",
            "YEARLY"
          ],
          "type": "string",
          "title": "frequency"
        },
        "type": {
          "description": "The type of commercial agreement that the payer has with you.Specify the agreement type when you have provided a value for agreement.id and this payment is the first in a series of payments. The default value is OTHER.",
          "enum": [
            "INSTALLMENT",
            "OTHER",
            "RECURRING",
            "UNSCHEDULED"
          ],
          "type": "string",
          "title": "frequency"
        },
        "start_date": {
          "description": "This is the effective start date for the payment agreement.",
          "format": "date",
          "type": "string",
          "title": "start_date"
        }
      },
      "type": "object"
    },
    "Authentication-Payer-Card-Response": {
      "title": "Authentication Payer Card Response",
      "description": "Card informations",
      "properties": {
        "account_type": {
          "description": "Savings/checking option for some cards (e.g., Maestro).",
          "enum": [
            "CHECKING",
            "SAVINGS"
          ],
          "type": "string",
          "title": "account_type"
        },
        "brand": {
          "description": "The brand name used to describe the card that is recognized and accepted globally. For many major card types this will match the scheme name. In some markets, a card may also be co-branded with a local brand that is recognized and accepted within its country/region of origin (see card.localBrand).You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.",
          "enum": [
            "AMEX",
            "CHINA_UNIONPA",
            "DINERS_CLUB",
            "DISCOVER",
            "JCB",
            "LOCAL_BRAND_ONLY",
            "MAESTRO",
            "MASTERCARD",
            "RUPAY",
            "UATP",
            "UNKNOWN",
            "VISA"
          ],
          "type": "string",
          "title": "brand"
        },
        "scheme": {
          "description": "The organization that owns a card brand and defines operating regulations for its use. The card scheme also controls authorization and settlement of card transactions among issuers and acquirers.",
          "enum": [
            "AMEX",
            "CHINA_UNIONPA",
            "DINERS_CLUB",
            "DISCOVER",
            "JCB",
            "LOCAL_BRAND_ONLY",
            "MAESTRO",
            "MASTERCARD",
            "RUPAY",
            "UATP",
            "UNKNOWN",
            "VISA"
          ],
          "type": "string",
          "title": "scheme"
        },
        "number": {
          "description": "The customer’s payment card number, also known as the Primary Account Number (PAN).",
          "maxLength": 23,
          "minLength": 9,
          "type": "string",
          "title": "number"
        },
        "issuer": {
          "description": "The issuer of the card, if known.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string",
          "title": "cvv"
        },
        "funding_method": {
          "description": "The method used by the payer to provide the funds (Charge, Credit, Debit).",
          "enum": [
            "CHARGE",
            "CREDIT",
            "DEBIT",
            "UNKNOWN"
          ],
          "type": "string",
          "title": "funding_method"
        },
        "expiry_month": {
          "description": "Two-digit month in which the payment card expires.",
          "type": "string",
          "pattern": "^(0?[1-9]|1[0-2])$",
          "title": "expiry_month"
        },
        "expiry_year": {
          "description": "Two-digit year in which the payment card expires.",
          "type": "string",
          "pattern": "^[0-9]{2,2}$",
          "title": "expiry_year"
        },
        "encryption": {
          "description": "The encryption framework used for the payment details received by the gateway.",
          "enum": [
            "DEVICE",
            "DIGITAL_WALLET",
            "DUKPT"
          ],
          "type": "string",
          "title": "encryption"
        },
        "device_payment": {
          "$ref": "#/$defs/Authentication-Device-Payment-Response"
        },
        "device_specific": {
          "$ref": "#/$defs/Device-Specific-Response"
        }
      }
    },
    "Authentication-Payer-Initiate-Response": {
      "title": " Payer Authentication Response",
      "required": [
        "method_completed",
        "method_supported",
        "requestor_id",
        "requestor_name",
        "payer_interaction"
      ],
      "properties": {
        "acs_eci": {
          "description": "Electronic Commerce Indicator (ECI) value provided by the issuer's ACS.",
          "maxLength": 2,
          "minLength": 1,
          "type": "string",
          "title": "acs_eci"
        },
        "token": {
          "description": "The base64 encoded value generated by the issuer (CAVV/AAV/AEVV/Authentication Value).",
          "maxLength": 32,
          "minLength": 28,
          "type": "string",
          "title": "token"
        },
        "3ds_transaction_id": {
          "description": "A unique identifier for the 3-D Secure authentication transaction (XID for v1, DS ID for v2).",
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "title": "3ds_transaction_id"
        },
        "server_transaction_id": {
          "description": "Unique identifier assigned by the 3DS Server (threeDSServerTransID).",
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "title": "server_transaction_id"
        },
        "acs_transaction_id": {
          "description": "A unique transaction identifier assigned by the Access Control Server (ACS).",
          "maxLength": 36,
          "minLength": 36,
          "type": "string",
          "title": "acs_transaction_id"
        },
        "scheme": {
          "description": "The EMV 3DS authentication scheme used (e.g., MADA, MASTERCARD, VISA).",
          "maxLength": 50,
          "minLength": 2,
          "type": "string",
          "title": "scheme"
        },
        "custom": {
          "description": "Additional information returned by the scheme or issuer in the authentication response.",
          "maxLength": 4000,
          "minLength": 1,
          "type": "string",
          "title": "custom"
        },
        "directory_server_id": {
          "description": "Additional information returned by the scheme or issuer in the authentication response.",
          "maxLength": 10,
          "minLength": 10,
          "type": "string",
          "title": "directory_server_id"
        },
        "directory_server_reference": {
          "description": "Reference number assigned to the Directory Server (DS) by EMV Co.",
          "maxLength": 32,
          "minLength": 1,
          "type": "string",
          "title": "directory_server_reference"
        },
        "directory_transaction_id": {
          "description": "A unique transaction identifier assigned by the scheme Directory Server.",
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "title": "directory_transaction_id"
        },
        "method_completed": {
          "description": "Indicates if the issuer's ACS completed the method call to obtain browser info.",
          "type": "boolean",
          "title": "method_completed"
        },
        "method_supported": {
          "description": "Indicates if the issuer's ACS supports the method call protocol.",
          "enum": [
            "NOT_SUPPORTED",
            "SUPPORTED"
          ],
          "type": "string",
          "title": "method_supported"
        },
        "protocol_version": {
          "description": "The version of the EMV 3-D Secure protocol used (e.g., 2.1.0).",
          "maxLength": 20,
          "minLength": 1,
          "type": "string",
          "title": "protocol_version"
        },
        "requestor_id": {
          "description": "The unique identifier assigned to the merchant by the card scheme directory server for 3DS2.",
          "maxLength": 20,
          "minLength": 1,
          "type": "string",
          "title": "requestor_id"
        },
        "requestor_name": {
          "description": "The unique name assigned to the merchant by the card scheme directory server for 3DS2.",
          "maxLength": 40,
          "minLength": 1,
          "type": "string",
          "title": "requestor_name"
        },
        "sdk": {
          "$ref": "#/$defs/Sdk-Payer-Authentication-Response"
        },
        "status_reason_code": {
          "description": "A code indicating the reason for the transaction status (EMVCo specification).",
          "maxLength": 2,
          "minLength": 2,
          "type": "string",
          "title": "status_reason_code"
        },
        "status": {
          "description": "Indicates the result of payer authentication with the issuer (e.g., Y, N, U, A, R).",
          "maxLength": 1,
          "minLength": 1,
          "type": "string",
          "title": "status"
        },
        "acs_reference": {
          "description": "Reference number assigned to the issuer's ACS by EMV Co.",
          "maxLength": 32,
          "minLength": 1,
          "type": "string",
          "title": "acs_reference"
        },
        "signed_content": {
          "description": "A JSON Web Signature (JWS) object returned by the issuer's ACS (acsSignedContent).",
          "maxLength": 13684,
          "minLength": 1,
          "type": "string",
          "title": "signed_content"
        },
        "amount": {
          "description": "Product amount",
          "maximum": 1000000000000000000,
          "minimum": 0.01,
          "type": "number",
          "title": "amount"
        },
        "method": {
          "description": "The method that the issuer will use to authenticate the payer.",
          "enum": [
            "DYNAMIC",
            "OUT_OF_BAND",
            "STATIC"
          ],
          "type": "string",
          "title": "method"
        },
        "payer_interaction": {
          "description": "Indicates if payer interaction was used to complete the authentication process.",
          "enum": [
            "NOT_POSSIBLE",
            "NOT_REQUIRED",
            "REQUIRED"
          ],
          "type": "string",
          "title": "payer_interaction"
        },
        "payment_exemption": {
          "description": "Indicates why this payment qualifies for an SCA exemption.",
          "enum": [
            "AUTO",
            "LOW_RISK",
            "LOW_VALUE_PAYMENT",
            "TRUSTED_MERCHANT",
            "MERCHANT_INITIATED_TRANSACTION",
            "RECURRING_PAYMENT",
            "SECURE_CORPORATE_PAYMENT",
            "TRUSTED_MERCHANT"
          ],
          "type": "string",
          "title": "payment_exemption"
        },
        "trusted_merchant_status": {
          "description": "Indicates if the payer has added you to their list of trusted merchants for this card.",
          "enum": [
            "NOT_ON_LIST",
            "ON_LIST"
          ],
          "type": "string",
          "title": "trusted_merchant_status"
        },
        "redirect_acs_url": {
          "type": "string",
          "maxLength": 500,
          "minLength": 1,
          "description": "The URL of the issuer's ACS to be used for the challenge flow (valid RFC 1738 URL).",
          "title": "redirect_acs_url"
        },
        "redirect_c_req": {
          "type": "string",
          "maxLength": 4000,
          "minLength": 1,
          "description": "The Base64 URL encoded CReq message to be used for the challenge flow.",
          "title": "redirect_c_req"
        },
        "redirect_html": {
          "type": "string",
          "maxLength": 40960,
          "minLength": 1,
          "description": "The Base64 URL encoded CReq message to be used for the challenge flow.",
          "title": "redirect_html"
        },
        "redirect_domain_name": {
          "type": "string",
          "maxLength": 253,
          "minLength": 1,
          "description": "The domain name of the site where payer authentication was performed (e.g., ACS domain name).",
          "title": "redirect_domain_name"
        },
        "status_code": {
          "type": "string",
          "maxLength": 100,
          "minLength": 1,
          "description": "Indicates the status of payer authentication with the issuer (e.g., NPCI BEPG status code).",
          "title": "status_code"
        },
        "status_description": {
          "type": "string",
          "maxLength": 1024,
          "minLength": 1,
          "description": "Indicates the status of payer authentication with the issuer (e.g., NPCI BEPG status code).",
          "title": "status_description"
        },
        "line_of_business": {
          "type": "string",
          "maxLength": 100,
          "minLength": 1,
          "description": "Identifier for different lines of business configured in the merchant profile.",
          "title": "line_of_business"
        },
        "time": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time of the payer authentication being performed (YYYY-MM-DDThh:mm:ss.SSSZ).",
          "title": "time"
        },
        "version": {
          "description": "The form of payer authentication selected or available for use by the gateway.",
          "enum": [
            "3DS2",
            "RUPAY",
            "PASSKEY",
            "NONE"
          ],
          "type": "string",
          "title": "version"
        }
      }
    },
    "Authentication-Payer-Method-Response": {
      "type": "object",
      "title": "Authentication Payer Method Response",
      "required": [
        "type"
      ],
      "properties": {
        "card": {
          "$ref": "#/$defs/Authentication-Payer-Card-Response"
        },
        "holder_name": {
          "$ref": "#/$defs/Holder-Name"
        },
        "type": {
          "description": "Method specified by the customer for the transaction  \n- Provide CARD for CARD transactions",
          "type": "string",
          "enum": [
            "CARD",
            "GOOGLEPAY",
            "APPLEPAY"
          ],
          "title": "type"
        },
        "token_id": {
          "description": "Session identification number",
          "type": "string",
          "minLength": 1,
          "maxLength": 50,
          "title": "token_id"
        },
        "token_type": {
          "description": "Token type.",
          "enum": [
            "ALT_TOKEN",
            "NETWORK_TOKEN",
            "ISSUER_TOKEN",
            "CITI_TOKEN"
          ],
          "type": "string",
          "title": "token_type"
        }
      }
    },
    "Authentication-Payer-Order-Response": {
      "title": "Authentication Payer Order",
      "required": [
        "id",
        "amount",
        "currency_code",
        "creation_date_time",
        "update_time",
        "charge_amount",
        "charge_type",
        "total_auth_amount",
        "total_captured_amount",
        "total_refunded_amount",
        "avs_action",
        "avs_response"
      ],
      "properties": {
        "id": {
          "description": "A unique identifier for this order.",
          "maxLength": 40,
          "minLength": 1,
          "type": "string",
          "title": "id"
        },
        "amount": {
          "description": "The total amount for the order.  This is the net amount plus any merchant charge amounts.If you provide any sub-total amounts, then the sum of these amounts (order.itemAmount, order.taxAmount, order.shippingAndHandlingAmount, order.cashbackAmount, order.gratuityAmount, order.merchantCharge.amount and order.dutyAmount), minus the order.discountAmount must equal the net amount.The value of this parameter in the response is zero if payer funds are not transferred.",
          "maximum": 1000000000000000000,
          "minimum": 0.01,
          "type": "number",
          "title": "amount"
        },
        "authentication_status": {
          "description": "Indicates the result of payer authentication.",
          "enum": [
            "AUTHENTICATION_ATTEMPTED",
            "AUTHENTICATION_AVAILABLE",
            "AUTHENTICATION_EXEMPT",


# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/json-schema/citi-authentication-payer-response-schema.json