
doGetCyclicActions	Retrieves a list of currently due actions, according to standard rules This includes due Reconciliations, and pending Completions
doGetPendingTransactions	Retrieves a list of currently uncompleted transactions, ignoring retry rules. This is intended for “last tries”, or retrieving a list of problematic transactions before a closeBatch operation
doPrepareCompletionMessage	Prepare a Completion message for a given uncompleted transaction
doParseCompletionResponse	Process the result of an external transmission attempt of a Completion
doReconciliation	Execute a reconciliation exchange with the given acquirer(s)
doCloseBatch	Closes the batch for the given acquirer(s). This operation is destructive - in most cases, it is recommended to try to transmit Pending transactions first, and log, save or print the remaining uncompleted transactions
doGetTrxInfo	Retrieves the available transaction data for the given Transaction Reference. The amount of information available depends on the context and state of the transaction
doDiagnostic	Executes a Diagnostic exchange with the given acquirer(s)
doGetTotals	Retrieves every transaction from the lot without executing a reconciliation.

API Functions Definition

Anchor

	doGetPendingTransactions
	doGetPendingTransactions

...

Name

Tag

Format

Usage

Updated Configuration

FF02

DO

Container for Updated Configuration. This should be used as the new active configuration.

Cyclic Function Results

FFBF3C

DO

Container for the results

Cyclic Action Occurrence

FFBF3C.FF01

DO

Container for the data of one reconciliation result

Cyclic Action Type

FFBF3C.FF01. DF01

Expand

title	Possible Values

01: Acquirer Reconciliation

Define action that was done

Cyclic Action ID

FFBF3C.FF01. DF03

n; 2

Ex : [01], [03]

AcquirerNumber, as defined in the configuration.

Acquirer number of the closed reconciliation

Reconciliation ID

FFBF3C.FF01. DF06

i32

Value between 1 and 999999

Reconciliation Period Identification assigned by the POI

Cyclic Action Status

FFBF3C.FF01. DF02

Expand

title	Possible Values

00: Approved

01: Declined

02: Unable to connect

04: Error

Result of the reconciliation

Reconciliation Totals

FFBF3C.FF01. FF05

DO

Container for totals

Reconciliation Total Group

FFBF3C.FF01. FF05.FF01

DO

Container for totals, includes a total for all schemes, and totals by schemes

For all subsequent totals, all will contain the following two tags

Totals Count

DF9F25

i32

Number of transaction for that category

Total Amount

D5

BCD, 6

Total amount for that category

Reconcilation Totals Debit

FFBF3C.FF01. FF05.FF01. FF9F26

DO

Container for debit totals

Reconcilation Totals Debit Reverse

FFBF3C.FF01. FF05.FF01.FF9F27

DO

Container for debit reverse totals

Reconcilation Totals Credit

FFBF3C.FF01. FF05.FF01.FF9F28

DO

Container for credit totals

Reconcilation Totals Credit Reverse

FFBF3C.FF01. FF05.FF01.FF9F29

DO

Container for credit reverse totals

Reconcilation Totals Declined

FFBF3C.FF01. FF05.FF01.FF9F2A

DO

Container for declined totals

Reconcilation Totals Failed

FFBF3C.FF01. FF05.FF01.FF9F2B

DO

Container for failed totals

Reconcilation Totals Reservations

FFBF3C.FF01. FF05.FF01.FF9F24

DO

Container for Pre-Auths and Update Pre-Auths totals

Reconcilation Acquirer Totals Debit

FFBF3C.FF01. FF05.FF01.FF9F2C

DO

Container for debit totals from acquirer’s response

Reconcilation Acqurier Totals Debit Reverse

FFBF3C.FF01. FF05.FF01.FF9F2D

DO

Container for debit reverse totals from acquirer’s response

Reconcilation Acquirer Totals Credit

FFBF3C.FF01. FF05.FF01.FF9F2E

DO

Container for credit totals from acquirer’s response

Reconcilation Acquirer Totals Credit Reverse

FFBF3C.FF01. FF05.FF01.FF9F2F

DO

Container for credit reverse totals from acquirer’s response

Reconcilation Acquirer Totals Declined

FFBF3C.FF01. FF05.FF01.FF9F30

DO

Container for declined totals from acquirer’s response

Reconcilation Acquirer Totals Failed

FFBF3C.FF01. FF05.FF01.FF9F31

DO

Container for failed totals from acquirer’s response

...

Code Block

breakoutMode	full-width

- FFBF3C
  - FF01
      - DF01 : 01
      - DF02 : 00
      - DF03 : 01      
      - FF05DF06 : 5
      - FF9F26
FF01:
         - DF9F25FF05
: 42           - D5 :FF9F26
00 00 00 04 20 00         - FF9F27DF9F25 : 42
        - DF9F25 : 1   - D5 : 00 00 00 04 20 -00
D5 : 00 00 00 00 10 00     - FF9F27
  - FF9F28           - DF9F25 : 31
              - D5 : 00 00 00 00 13 3710 00
            - FF9F28
  FF9F29            - DF9F25 : 13
              - D5 : 00 00 00 00 10 0013 37
            - FF9F2AFF9F29
              - DF9F25 : 1
6              - D5 : 00 00 00 66 00 10 00
            - FF9F2A
FF9F2B              - DF9F25 : 16
              - D5 : 00 8000 00 66 00 00
   00         - FF9F2CFF9F2B
              - DF9F25 : 421
              - D5 : 00 80 00 00 00 00
 04 20 00         - FF9F2DFF9F2C
              - DF9F25 : 142
              - D5 : 00 00 00 04 20 00
  10 00         - FF9F2EFF9F2D
              - DF9F25 : 31
              - D5 : 00 00 00 00 10 00
13   37         - FF9F2FFF9F2E
              - DF9F25 : 3
1              - D5 : 00 00 00 00 10 00 13 37
            - FF9F30FF9F2F
              - DF9F25 : 61
              - D5 : 00 00 00 6600 10 00
00            - FF9F31FF9F30
              - DF9F25 : 16
              - D5 : 00 8000 00 66 00 00
00

Anchor

            - FF9F31
              - DF9F25 : 1
              - D5 : 00 80 00 00 00 00

Anchor

	doGetTrxInfo
	doGetTrxInfo

doGetTrxInfo

...

Name

Tag

Format

Usage

Cyclic Function Results

FFBF3C

DO

Container for the results

Cyclic Action Occurrence

FFBF3C.FF01

DO

Container for the data of one result

Cyclic Action Type

FFBF3C.FF01. DF01

Expand

title	Possible Values

04: Diagnostic

Define action that was done

Cyclic Action ID

FFBF3C.FF01. DF03

n; 2

Ex : [01], [03]

AcquirerNumber, as defined in the configuration.

Acquirer number of the diagnostic result

Cyclic Action Status

FFBF3C.FF01. DF02

Expand

title	Possible Values

02: Unable to connect

03: Done

04: Error

Result of the diagnostic

...

Example Output TLV Tree

Code Block

breakoutMode	full-width

- FFBF3C
  - FF01
      - DF01 : 00
      - DF02 : 03
      - DF03 : 01
      
  - FF01
      - DF01 : 01
      - DF02 : 03
      - DF03 : 02

Anchor

	doGetTotals
	doGetTotals

doGetTotals

Retrieves every transaction from the lot without executing a reconciliation.

Data Parameters

Name

Tag

Format

Usage

AcquirerNumber

DF1B

n; 2

Ex : [01], [03]

AcquirerNumber, as defined in the configuration.

List of wanted acquirer numbers.

Output Parameters

Name

Tag

Format

Usage

Cyclic Function Results

FFBF3C

DO

Container for the results

Cyclic Action Occurrence

FFBF3C.FF01

DO

Container for the data of one result

Cyclic Action Type

FFBF3C.FF01. DF01

Expand

title	Possible Values

05: Get Totals

Define action that was done

Reconciliation Totals

FFBF3C.FF01. FF05

DO

Container for totals

Reconciliation Total Group

FFBF3C.FF01. FF05.FF01

DO

Container for totals, includes a total for all schemes, and totals by schemes

For all subsequent totals, all will contain the following two tags

Totals Count

DF9F25

i32

Number of transaction for that category

Total Amount

D5

BCD, 6

Total amount for that category

Reconcilation Totals Debit

FFBF3C.FF01. FF05.FF01. FF9F26

DO

Container for debit totals

Reconcilation Totals Debit Reverse

FFBF3C.FF01. FF05.FF01.FF9F27

DO

Container for debit reverse totals

Reconcilation Totals Credit

FFBF3C.FF01. FF05.FF01.FF9F28

DO

Container for credit totals

Reconcilation Totals Credit Reverse

FFBF3C.FF01. FF05.FF01.FF9F29

DO

Container for credit reverse totals

Reconcilation Totals Declined

FFBF3C.FF01. FF05.FF01.FF9F2A

DO

Container for declined totals

Reconcilation Totals Failed

FFBF3C.FF01. FF05.FF01.FF9F2B

DO

Container for failed totals

Reconcilation Totals Reservations

FFBF3C.FF01. FF05.FF01.FF9F24

DO

Container for Pre-Auths and Update Pre-Auths totals

Example Output TLV Tree

Code Block

breakoutMode	full-width

    [ 0xFFBF3C: 
        [ 0xFF01: 
            [ 0xDF01: 01
            , 0xFF05: 
                  [ 0xFF01: 
                    [ 0xFF9F26: 
                      [ 0xDF9F25: 00000002
                      , 0xD5: 000000001100
                      ]
                  , 0xFF9F27: 
                      [ 0xDF9F25: 00000000
                      , 0xD5: 000000000000
                      ]
                  , 0xFF9F28: 
                      [ 0xDF9F25: 00000000
                      , 0xD5: 000000000000
                      ]
                  , 0xFF9F29: 
                      [ 0xDF9F25: 00000000
                      , 0xD5: 000000000000
                      ]
                  , 0xFF9F2A: 
                      [ 0xDF9F25: 00000000
                      , 0xD5: 000000000000
                      ]
                  , 0xFF9F2B: 
                      [ 0xDF9F25: 00000000
                      , 0xD5: 000000000000
                      ]
                  , 0xFF9F24: 
                      [ 0xDF9F25: 00000000
                      , 0xD5: 000000000000
                      ]
                  ]
                ]  
            ]
        ]

Versions Compared

Old Version 19

New Version Current

Key

API Functions Definition

Example Output TLV Tree

doGetTotals

Data Parameters

Output Parameters

Example Output TLV Tree

Page Comparison

Versions Compared

Old Version 19

New Version Current

Key

API Functions Definition

Example Output TLV Tree

doGetTotals

Data Parameters

Output Parameters

Example Output TLV Tree