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 |
| DO | Echo of the reference sent in the parameters |
Status |
| Status of the message creation | |
Host Identification | |||