Esquema JSON del archivo por lotes

Use estas definiciones de JSON Schema para validar archivos por lotes utilizados para la sincronización de tokens.

Para una referencia de campos legible por humanos y ejemplos, vea:

• Estructura del archivo por lotes

• Estructura del archivo de resultados por lotes

• Tabla de códigos de error

Estos esquemas apuntan a JSON Schema draft 2020-12.

Algunos validadores pueden tratar la nullable palabra clave como no estándar. Valide con las herramientas que use en su backend emisor.

Esquema de archivo de entrada por lotes

Registro de tarjeta virtual

Use este esquema para validar un archivo de entrada donde:

• header.operation es VIRTUAL_CARD_REGISTRATION.

• Cada registro contiene rowId y virtualCardRegistrationRequest.card.

• firma es un JWS desacoplado (ver Estructura del archivo por lotes).

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"
  ]
}

Esquema de archivo de resultados por lotes

Resultado del registro de tarjeta virtual

Use este esquema para validar el archivo de resultados de salida producido después de procesar un archivo por lotes de entrada.

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
}