Batch file JSON schema

Use these JSON Schema definitions to validate batch files used for token synchronization.

For a human-readable field reference and examples, see:

• Batch file structure

• Output batch file structure

• Error codes table

These schemas target JSON Schema draft 2020-12.

Some validators may treat the nullable keyword as non-standard. Validate with the tooling you use in your issuer backend.

Input batch file schema

Virtual card registration

Use this schema to validate an input file where:

• header.operation is VIRTUAL_CARD_REGISTRATION.

• Each record contains rowId and virtualCardRegistrationRequest.card.

• signature is a detached JWS (see Batch file structure).

input-virtual-card-registration.schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "header": {
      "type": "object",
      "properties": {
        "batchId": { "type": "string", "nullable": false },
        "seqNumber": { "type": "string", "nullable": false },
        "operation": {
          "type": "string",
          "enum": ["VIRTUAL_CARD_REGISTRATION"]
        },
        "issuerId": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "batchId",
        "seqNumber",
        "operation",
        "issuerId"
      ]
    },
    "records": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rowId": {
            "type": "integer"
          },
          "virtualCardRegistrationRequest": {
                "type": "object",
                "properties": {
                    "card": {
                        "type": "object",
                        "required": ["id", "scheme", "encryptedData"],
                        "properties": {
                            "id": { "type": "string", "nullable": false },
                            "scheme": { "type": "string", "enum": ["MASTERCARD", "VISA"] },
                            "encryptedData": { "type": "string" }
                        }
                    }
                },
                "required": ["card"],
                "additionalProperties": false
            }
        },
        "required": [
          "rowId",
          "virtualCardRegistrationRequest"
        ]
      },
      "additionalItems": false
    },
    "signature": { "type": "string", "nullable": false, "minLength": 1 }
  },
  "additionalProperties": false,
  "required": [
    "header",
    "records",
    "signature"
  ]
}

Output batch file schema

Virtual card registration result

Use this schema to validate the output results file produced after processing an input batch file.

output-virtual-card-registration.schema.json

{
    "type": "object",
    "properties": {
        "header": {
            "type": "object",
            "properties": {
                "batchId": { "type": "string" },
                "seqNumber": { "type": "string" },
                "operation": { "type": "string", "enum": ["VIRTUAL_CARD_REGISTRATION"] },
                "issuerId": { "type": "string", "minLength": 10, "maxLength": 10 },
                "errorCode": { "type": "string" },
                "totalRecords": { "type": "integer" }
            },
            "additionalProperties": false
        },
        "recordsResults": {
            "type": "array",
            "items": [
                {
                    "type": "object",
                    "properties": {
                        "rowId": {
                            "type": "integer"
                        },
                        "virtualCardRegistrationResult": {
                            "type": "object",
                            "properties": {
                                "card": {
                                  "type": "object",
                                  "properties": {
                                    "id": { "type": "string" },
                                    "status": { "type": "string" },
                                    "digitalCardIds": {
                                        "type": "array",
                                        "items": [
                                          {
                                            "type": "string"
                                          }
                                        ]
                                    }
                                    "errorCode": { "type": "string" }
                                  },
                                  "required": ["id", "status"],
                                  "additionalProperties": false
                                },
                                "errorCode": { "type": "string" },
                                "status": { "type": "string" }
                            },
                            "required": ["card"],
                            "additionalProperties": false
                        }
                    },
                    "required": ["rowId", "virtualCardRegistrationResult"]
                }
            ]
        }
    },
    "required": ["header"],
    "additionalProperties": false
}