Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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
titlePossible 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
titlePossible Values

02: Unable to connect

03: Done

04: Error

Result of the diagnostic

...

Example Output TLV Tree

Code Block
breakoutModefull-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
titlePossible Values

05: Get Totals

Define action that was done

Example Output TLV Tree

Code Block
breakoutModefull-width
    [ 0xFFBF3C: 
        [ 0xFF01: 
            [ 0xDF01: 05
            , 0xFF05: 
                [ 0xFF9F26: 
                    [ 0xDF9F25: 00000000
                    , 0xD5: 000000000000
                    ]
                , 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
                    ]
                ]
            ]
        ]