These API are only available starting API V1.2
Description
Cylic functions have been split into multiple operations in order to allow fine tuning of the expected behaviour and to allow transmission of completions on a separate thread.
Each functions all have the same signature :
byte[] functionName(byte[] tlvConfigData, byte[] tlvRequestData)
All byte[] are binary TLV Tree.
The expected tlvRequestData tree and the return TLV tree will be documented for each function.
The tlvConfigData is documented here : Arkos Configuration
doGetPendingTransactions
This function is used to get the transactions for which the completion is still required to be sent.
Data Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Transaction Time |
|
| Time at which the current action is performed |
Transaction Date |
|
| Date at which the current action is performed |
Local Time Zone |
|
| Local Timezone in which the current action is performed |
AcquirerNumber |
|
Ex : [01], [03] AcquirerNumber, as defined in the configuration. | List of wanted acquirer numbers. |
Output Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Cyclic Function Results |
|
| Container for the results |
Cyclic Pending Transactions Occurrence |
|
| Container for the data of one pending transaction |
Transaction ID |
|
| Transaction ID of the transaction with pending completion |
AcquirerNumber |
|
Ex : [01], [03] AcquirerNumber, as defined in the configuration. | AcquirerNumber of the transaction with pending completion |
Exemple Output TLV Tree
- FFBF3C - FF02 - DF01 : "TRX001" - DF1B : 01 - FF02 - DF01 : "TRX002" - DF1B : 01 - FF02 - DF01 : "TRX003" - DF1B : 02
doGetCylicActions
This function is used to get all tasks that are scheduled now. This include completions to send and reconciliation to do.
Name | Tag | Format | Usage |
---|---|---|---|
Transaction Time |
|
| Time at which the current action is performed |
Transaction Date |
|
| Date at which the current action is performed |
Local Time Zone |
|
| Local Timezone in which the current action is performed |
AcquirerNumber |
|
Ex : [01], [03] AcquirerNumber, as defined in the configuration. | List of wanted acquirer numbers. |
Output Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Cyclic Function Results |
|
| Container for the results |
Cyclic Pending Action Occurrence |
| DO | Container for the data of one pending reconciliation |
Cyclic Pending Action Type |
| Define action do be done | |
Cyclic Pending Action ID |
|
Ex : [01], [03] AcquirerNumber, as defined in the configuration. | Acquirer number of the reconciliation to be performed |
Cyclic Pending Transactions Occurrence |
|
| Container for the data of one pending transaction |
Transaction ID |
|
| Transaction ID of the transaction with pending completion |
AcquirerNumber |
|
Ex : [01], [03] AcquirerNumber, as defined in the configuration. | AcquirerNumber of the transaction with pending completion |
Exemple Output TLV Tree
- FFBF3C - FF02 - DF01 : "TRX001" - DF1B : 01 - FF02 - DF01 : "TRX002" - DF1B : 01 - FF02 - DF01 : "TRX003" - DF1B : 02 - FF01 - DF01 : 01 - DF03 : 01 - FF01 - DF01 : 01 - DF03 : 02
doPrepareCompletionMessage
Use to prepare acquirer messsage to send for completion with the required host acquirer information.
Data Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Transaction Time |
|
| Time at which the current action is performed |
Transaction Date |
|
| Date at which the current action is performed |
Local Time Zone |
|
| Local Timezone in which the current action is performed |
Reference Data |
|
Ex : [01], [03] | Reference of the transaction to produce the completion message. Previously sent in the Transaction ID response of either doGetCylicActions or doGetPendingTransactions function return. |
Output parameters
Name | Tag | Format | Usage |
---|---|---|---|
External Message |
|
| Message to send |
Reference Data |
|
| Echo of the reference sent in the parameters |
Status |
| Status of the message creation | |
Host Identification | |||
Exemple Output TLV Tree
- DF9F14 : "</xml>...." - DF37 : "TRX001" - DF9F34 : 00
doParseCompletionResponse
Use to parse received completion and process the transaction
Data Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Transaction Time |
|
| Time at which the current action is performed |
Transaction Date |
|
| Date at which the current action is performed |
Local Time Zone |
|
| Local Timezone in which the current action is performed |
Reference Data |
|
Ex : [01], [03] | Reference of the transaction to produce the completion message. Previously sent in the Transaction ID response of either doGetCylicActions or doGetPendingTransactions or doPrepareCompletionMessage function return |
Status |
| Status of the transmission | |
External Message |
|
| Message Received |
Output parameters
Name | Tag | Format | Usage |
---|---|---|---|
Status |
| Status of the message parsing. If a response was received, you will received OK/NOK according to the parsing. Else it will be an echo. |
Exemple Output TLV Tree
- DF9F34 : 00
doCloseBatch
This function is used to close the current acquirer reconciliation period. It deletes all transaction from specified acquirers
Data Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Transaction Time |
|
| Time at which the current action is performed |
Transaction Date |
|
| Date at which the current action is performed |
Local Time Zone |
|
| Local Timezone in which the current action is performed |
AcquirerNumber |
|
Ex : [01], [03] AcquirerNumber, as defined in the configuration. | List of wanted acquirer numbers. |
Output Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Cyclic Function Results |
|
| Container for the results |
Cyclic Action Occurrence |
| DO | Container for the data of one result |
Cyclic Action Type |
| Define action that was done | |
Cyclic Action ID |
|
Ex : [01], [03] AcquirerNumber, as defined in the configuration. | Acquirer number of the closed reconciliation |
Cyclic Action Status |
| Result of the closing of the period |
Exemple Output TLV Tree
- FFBF3C - FF01 - DF01 : 00 - DF02 : 03 - DF03 : 01 - FF01 - DF01 : 01 - DF02 : 03 - DF03 : 02
doReconciliation
This function is used to send the reconciliation message for each specified acquirer
Data Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Transaction Time |
|
| Time at which the current action is performed |
Transaction Date |
|
| Date at which the current action is performed |
Local Time Zone |
|
| Local Timezone in which the current action is performed |
AcquirerNumber |
|
Ex : [01], [03] AcquirerNumber, as defined in the configuration. | List of wanted acquirer numbers. |
Output Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Cyclic Function Results |
|
| Container for the results |
Cyclic Action Occurrence |
|
| Container for the data of one reconciliation result |
Cyclic Action Type |
| Define action that was done | |
Cyclic Action ID |
|
Ex : [01], [03] AcquirerNumber, as defined in the configuration. | Acquirer number of the closed reconciliation |
Cyclic Action Status |
| Result of the reconciliation | |
Reconciliation Totals |
|
| Container for totals |
Totals Count |
|
| Number of transaction for that category |
Total Amount |
|
| Total amount for that category |
Reconcilation Totals Debit |
|
| Container for debit totals |
Reconcilation Totals Debit Reverse |
|
| Container for debit reverse totals |
Reconcilation Totals Credit |
|
| Container for credit totals |
Reconcilation Totals Credit Reverse |
|
| Container for credit reverse totals |
Reconcilation Totals Declined |
|
| Container for declined totals |
Reconcilation Totals Failed |
|
| Container for failed totals |
Reconcilation Acquirer Totals Debit |
|
| Container for debit totals from acquirer’s response |
Reconcilation Acqurier Totals Debit Reverse |
|
| Container for debit reverse totals from acquirer’s response |
Reconcilation Acquirer Totals Credit |
|
| Container for credit totals from acquirer’s response |
Reconcilation Acquirer Totals Credit Reverse |
|
| Container for credit reverse totals from acquirer’s response |
Reconcilation Acquirer Totals Declined |
|
| Container for declined totals from acquirer’s response |
Reconcilation Acquirer Totals Failed |
|
| Container for failed totals from acquirer’s response |
Exemple Output TLV Tree
- FFBF3C - FF01 - DF01 : 01 - DF02 : 00 - DF03 : 01 - FF05 - FF9F26 - DF9F25 : 42 - D5 : 00 00 00 04 20 00 - FF9F27 - DF9F25 : 1 - D5 : 00 00 00 00 10 00 - FF9F28 - DF9F25 : 3 - D5 : 00 00 00 00 13 37 - FF9F29 - DF9F25 : 1 - D5 : 00 00 00 00 10 00 - FF9F2A - DF9F25 : 6 - D5 : 00 00 00 66 00 00 - FF9F2B - DF9F25 : 1 - D5 : 00 80 00 00 00 00 - FF9F2C - DF9F25 : 42 - D5 : 00 00 00 04 20 00 - FF9F2D - DF9F25 : 1 - D5 : 00 00 00 00 10 00 - FF9F2E - DF9F25 : 3 - D5 : 00 00 00 00 13 37 - FF9F2F - DF9F25 : 1 - D5 : 00 00 00 00 10 00 - FF9F30 - DF9F25 : 6 - D5 : 00 00 00 66 00 00 - FF9F31 - DF9F25 : 1 - D5 : 00 80 00 00 00 00
doGetTrxInfo
Use to get transaction information. This can be used to reprint a transaction or to print list of pending transactions.
Data Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Transaction Time |
|
| Time at which the current action is performed |
Transaction Date |
|
| Date at which the current action is performed |
Local Time Zone |
|
| Local Timezone in which the current action is performed |
Reference Data |
|
Ex : [01], [03] | Reference of the transaction to produce the completion message. Previously sent in the Transaction ID response of either doGetCylicActions or doGetPendingTransactions function return. |
Output parameters
Name | Tag | Format | Usage |
---|---|---|---|
Transaction Context |
|
| Persisted data for this transaction |
Reference Data |
|
| Echo of the reference sent in the parameters |
Status |
| Status of the message creation | |
Exemple Output TLV Tree
- FFC107 : {...} - DF37 : "TRX001" - DF9F34 : 00
doDiagnostic
This function is used to trigger a diagnostic request for the specified acquirer
Data Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Transaction Time |
|
| Time at which the current action is performed |
Transaction Date |
|
| Date at which the current action is performed |
Local Time Zone |
|
| Local Timezone in which the current action is performed |
AcquirerNumber |
|
Ex : [01], [03] AcquirerNumber, as defined in the configuration. | List of wanted acquirer numbers. |
Output Parameters
Name | Tag | Format | Usage |
---|---|---|---|
Cyclic Function Results |
|
| Container for the results |
Cyclic Action Occurrence |
| DO | Container for the data of one result |
Cyclic Action Type |
| Define action that was done | |
Cyclic Action ID |
|
Ex : [01], [03] AcquirerNumber, as defined in the configuration. | Acquirer number of the diagnostic result |
Cyclic Action Status |
| Result of the diagnostic |
Exemple Output TLV Tree
- FFBF3C - FF01 - DF01 : 00 - DF02 : 03 - DF03 : 01 - FF01 - DF01 : 01 - DF02 : 03 - DF03 : 02