Transaction list
This API can be used to get a list of transactions for the given list type value. Supported list types are:
List options
ListType | List Screen |
---|---|
Refund List | 3000 |
Void List | 4000 |
HistoryList | 5000 |
When this API is called with list-type information, the payment app will open and display the list of transactions within the app. Please note that this API does not return the transaction list as a response to the merchant (sales) app.
As the name suggests, the void/refund list shows transactions eligible for voiding or refunding. From here, you can initiate a void/refund operation externally by clicking the button next to each transaction. In this case, the transaction result will only appear on the payment app screen, and no result will be sent to the merchant app. If you need the payment response, refer to the 'Payment API'.
The history list allows you to view all past transactions. You can also create or recreate a receipt for any transaction by clicking the 'Receipt' button next to each transaction in the list.
Fields
Field | Desc | Value |
---|---|---|
listType | List type definition for transactions. See table 6.1 | 3000 4000 5000 |
Call example
App2AppRequest app2AppRequest = new App2AppRequest(); 2
//Optional to add register/config parameters
app2AppRequest.setListType("3000")
app2AppService.gotoList(app2AppRequest, eventLister);
Example request
"gotoList": {
"listType": "3000",
}
Example response
Success
"response":
{
"a2aCode":"1010",
"a2aMessage":"SoftposApp Stoped"
}
Error
"response":
{
"a2aCode":"1003",
"a2aMessage":"Register error : Server Error please contact with your administrator",
"errorCode":"104",
"errorMainCode":"9",
"errorSubCode":"32"
}
Parameters | Explanation |
---|---|
a2aCode | Response code has been created in Softpos application. |
a2aMessage | a2aMessage is the message of a2aCode .Backend message can be added to the continuation |
errorCode | errorCode returns from the backend.If error code is returned from the backend, the errorCode is not null. |
errorMainCode | errorMainCode returning from backendAll error codes and explanations are available in Softpos SDK document. |
errorSubCode | errorSubCode returning from backend |
Updated 10 days ago