GetVcaDetailsInboundRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-get-vca-details-inbound-request-schema.json",
  "title": "GetVcaDetailsInboundRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-getvcadetails-api-openapi.yml#/components/schemas/GetVcaDetailsInboundRequest",
  "properties": {
    "messageId": {
      "description": "Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per request.",
      "type": "string",
      "format": "alphanumeric",
      "maxLength": 36
    },
    "vcaId": {
      "description": "A reference number that uniquely identifies the virtual card account. Mandatory field if originalCreateMessageId is not included in the request.",
      "type": "string",
      "format": "long"
    },
    "programId": {
      "description": "Unique ID of the company record defined in the virtual cards system.<br><br>Mastercard - This value is returned in the ID Provisioning API. This value is generated when the VCA program is onboarded to Mastercard's VCA platform. Data format - Long (Numeric). Max character length - 19<br><br>Visa - This value is generated when the VCA program is onboarded to Visa's VCA platform. Data format - Alphanumeric. Max character length - 25",
      "type": "string",
      "format": "long"
    },
    "virtualCardAccountNumber": {
      "description": "The virtual card account number to use for transactions. <br>virtualCardAccountNumber is mandatory only for Visa if originalCreateMessageId is not included in the request.<br><br>Mastercard - Not applicable<br>Visa - Required",
      "type": "string",
      "format": "alphanumeric",
      "maxLength": 19
    },
    "getCardImage": {
      "description": "* Specifies whether cardImage field needs to be included in the response.<br><br>Mastercard - Optional<br>Visa - Not applicable<br>          <br>          <br>          * True = cardImage field will be sent in the response<br>          <br>          * False = cardImage field will not be sent in the response.<br>          <br>          * `Optional field` if not included, cardImage will be sent in the response.",
      "type": "string",
      "format": "boolean"
    },
    "originalCreateMessageId": {
      "description": "The API messageId sent in the Create VCA API request. It can be used to check card creation status of the original message ID for up to 4 days since the messageId was used in the VCA Create API request. If originalCreateMessageId is populated in the request, then vcaId and virtualCardAccountNumber are not required in the request",
      "type": "string",
      "format": "alphanumeric",
      "maxLength": 36
    }
  },
  "required": [
    "messageId",
    "programId"
  ]
}