Welcome to our new developer portal! Use the "Ask" button to chat with our AI Agent.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Output batch file structure

Output batch file structure

The output file has a similar structure to the input batch file.

The output file structure is as follows:

NAME
TYPE
SIZE
M/O/C
DESCRIPTION

header

Object

-

M

Summary of token synchronization results.

recordsResults

Array

-

C

An array of records. Each record contains the result of the operation. This field may not be present if a file-level error occurs.

The header has the following structure:

NAME
TYPE
SIZE
M/O/C
DESCRIPTION

batchId

String

48

M

Identifier from the input file batch header.

seqNumber

String

48

M

Sequence number from the input file batch header.

issuerId

String

48

M

Issuer identifier from the input file batch header.

operation

String

48

M

Operation from the input file batch header.

totalRecords

Integer

N/A

M

Total number of records included in the report.

errorCode

String

3

C

Present only when a file-level error occurs. See Error codes.

Record results

Each record has the following structure:

NAME
TYPE
SIZE
M/O/C
DESCRIPTION

rowId

Integer

-

M

Value provided in the input batch file.

virtualCardRegistrationResult

Object

-

M

Virtual card registration result

NAME
TYPE
SIZE
M/O/C
DESCRIPTION

status

String

2

M

- OK (Batch registration completes successfully.) - KO (Batch registration fails.)

card

Card (Object)

N/A

M

Object containing the card identification data and the result.

errorCode

String

3

C

Error code returned when status is KO. See Error codes.

Card

NAME
TYPE
SIZE
M/O/C
DESCRIPTION

id

String

1...48

M

Unique identifier assigned by the Issuer.

status

String

2

M

- OK (Card record registration completes successfully.) - KO (Card record registration fails.)

virtualCardIds

Array of String

N/A

O

List of virtual card IDs that TIG registers for the card.

errorCode

String

3

C

Error code returned when status is KO. See Error codes.

Batch file example

Last updated

Was this helpful?