Query Transactions

Methods for obtaining information about transactions.

Get Operation Status

Endpoint

GET /api/v1/payment/statusPublic/{tranId}

Example Request: https://processing-demo.cardport.net/api/v1/payment/statusPublic/9EBA5467-DFEE-48F8-8238-402028A2183C

Response Body

Field Name	Type	Description
`ID`	String	Operation ID
`State`	Integer	Transaction status
`Substate`	Integer	Transaction substatus
`ResultCode`	Integer	Result code
`ResultMessage`	String	Result message
`Status`	String	Status
`IsArchive`	Boolean	Archived status
`ErrorCode`	Integer	Execution result code
`ErrorMessage`	String	Execution result message
`Validations`	Array	Validation results

Example Response

{
  "Transaction": {
    "ID": "9EBA5467-DFEE-48F8-8238-402028A2183C",
    "State": 400,
    "Substate": 411,
    "ResultCode": 0,
    "ResultMessage": null,
    "Status": "DEPOSITED",
    "IsArchive": true
  },
  "ErrorCode": 0,
  "ErrorMessage": null,
  "Validations": null
}

Get Information by ID

Endpoint

GET /api/v1/payment/{tranId}

Example Request: https://processing-demo.cardport.net/api/v1/payment/9EBA5467-DFEE-48F8-8238-402028A2183C

Response Body

The response will contain the full transaction object. See the `Transaction` object definition in the "Get Transaction History" section for a detailed field breakdown.

Field Name	Type	Description
`Days`	Object Array	Array of transactions distributed by day.
`NotFinishedActualTrans`	Object Array	Unfinished current transactions.
`InProcess`	Object Array	Array of pending transactions.
`Transactions`	Object Array	Array of completed transactions.
`TransactionsCounters`	Object	Transaction counters for pagination.
`ErrorCode`	Integer	Execution result code.
`ErrorMessage`	String	Execution result message.
`Validations`	Array	Validation results.

Example Response

{
  "Days": null,
  "NotFinishedActualTrans": null,
  "InProcess": null,
  "Transactions": [    
    {
      "ID": "9EBA5467-DFEE-48F8-8238-402028A2183C",
      "Date": "2024-09-14T11:12:40.977",
      "Deadline": "2024-09-14T11:27:43.517",
      "Description": "Payment for goods",
      "Invoice": "ZAF-INV-00123",
      "AcquirerID": "CASH",
      "AcquirerApprovalCode": "CASH",
      "Status": "DEPOSITED",
      "RRN": "9EBA5467-DFEE-48F8",
      "Amount": 50,
      "AmountCashGot": 51,
      "CurrencyID": "ZAR",
      "PosID": 18351,
      "State": 400,
      "Substate": 411,
      "InputType": 10,
      "Card": {
        "IIN": "cash"
      },
      "ExtID": "TEST_APP_SA"
    }
  ],
  "TransactionsCounters": {
    "AmountCvt": 50.0,
    "Pagesize": 100,
    "ItemCountPage": 1,
    "ItemCountTtl": 1,
    "PageCount": 1
  },
  "ErrorCode": 0,
  "ErrorMessage": null,
  "Validations": null
}

Get Information by External ID

Endpoint

POST /api/v1/payment/listHistoryEx

Request Body

Field Name	Type	Description
`ListBasicModel`	JsonObject
`ExtID`	String	External ID of the operation
`Location`	JsonObject	Location object
`DeviceInfo`	JsonObject	Device object

Example Request

{
  "ListBasicModel": {
    "ExtID": "SA-ORD-111222333"
  },
  "DeviceInfo": {
    "PhoneManufacturer": "Generic",
    "PhoneModel": "RestAPI",
    "OS": "Windows"
  },
  "Location": {
    "Latitude": -26.2041,
    "Longitude": 28.0473
  },
  "CountryCode": "ZA",
  "Lang": "en"
}

Response Body

Field Name	Type	Description
`Days`	Object	Array of transactions distributed by day.
`NotFinishedActualTrans`	Object Array	Unfinished current transactions.
`InProcess`	Object Array	Array of pending transactions.
`Transactions`	Object Array	Array of completed transactions.
`ErrorCode`	Integer	Error code
`ErrorMessage`	String	Description of the error
`Validations`	Array	Array of execution checks

Example Response

{
  "Days": null,
  "NotFinishedActualTrans": null,
  "InProcess": null,
  "Transactions": [
    {
      "ID": "4F99A089-19A8-41A5-A21C-A032A07396B0",
      "Date": "2024-09-21T17:15:21.8",
      "Description": "Online Order",
      "Invoice": "ZAF-INV-00456",
      "AcquirerID": "ABSA",
      "AcquirerApprovalCode": "SIMULATION",
      "Status": "IN-TRANSFER",
      "RRN": "257990",
      "TerminalName": "online.demo.za",
      "Amount": 2522,
      "CurrencyID": "ZAR",
      "PosID": 18351,
      "State": 400,
      "Substate": 411,
      "InputType": 3,
      "Card": {
        "IIN": "mastercard",
        "PANMasked": "*9355"
      },
      "ExtID": "SA-ORD-111222333"
    }
  ],
  "TransactionsCounters": {
    "Pagesize": 100,
    "ItemCountPage": 1,
    "ItemCountTtl": 1,
    "PageCount": 1
  },
  "ErrorCode": 0,
  "ErrorMessage": null,
  "Validations": null
}

Get Transaction History

Endpoints

POST /api/v1/payment/listHistoryEx

Displays operations with a page limit of 100.

POST /api/v1/payment/listByDaysEx

Selects operations for a specific day and fills up to 100 results with entries from previous days if needed.

Important Notes

To get transactions for the current day, you must specify a date range from today to tomorrow.
Do not query for all transactions for the current day more than once per day. Use a query by ID for specific updates.
Specifying a transaction ID in the request will override all other parameters and return only that transaction.

Request Body

Field Name	Type	Description
`Period`	JsonObject	Period object
`To`	String	End date (yyyy-MM-dd)
`From`	String	Start date (yyyy-MM-dd)
`ListBasicModel`	JsonObject	Search parameters
`Search`	String	Text to search within a transaction
`AccountID`	Integer	Account ID
`Sort`	String	Sorting
`ID`	String	Transaction identifier
`Invoice`	String	Receipt number
`InvoiceOriginal`	String	Original transaction receipt
`RRN`	String	Retrieval Reference Number
`InputType`	Integer	Input type
`AcquirerCode`	String	Acquirer code
`ExtID`	String	External transaction ID
`Fiscal`	JsonObject	Fiscal parameters
`OfflineRequestModel`	JsonObject	Offline transaction parameters
`Page`	Integer	Page number for pagination
`ClientProductCode`	String	Client application code
`Location`	JsonObject	Location object
`DeviceInfo`	JsonObject	Device object

Example Request

{
  "Period": {
    "To": "2024-11-16",
    "From": "2024-08-15"
  },
  "Location": {
    "Latitude": -26.2041,
    "Longitude": 28.0473
  },
  "Country": "South Africa",
  "CountryCode": "ZA",
  "DeviceInfo": {
    "PhoneManufacturer": "Generic",
    "PhoneModel": "Windows_RestAPI",
    "DeviceID": "",
    "DeviceType": "1",
    "AppFramework": "java",
    "OS": "Windows",
    "OSVersion": "10",
    "AppID": "RestAPI",
    "BuildNumber": "2.4.390248"
  },
  "GMT": 2,
  "AppFramework": "java",
  "Lang": "en"
}

Response Body

Field Name	Type	Description
`Days`	Object	Array of transactions distributed by day.
`NotFinishedActualTrans`	Object Array	Unfinished current transactions.
`InProcess`	Object Array	Array of pending transactions.
`Transactions`	Object Array	Array of completed transactions.
`TransactionsCounters`	Object	Transaction counters for pagination.
`ErrorCode`	Integer	Error code
`ErrorMessage`	String	Description of the error
`Validations`	Array	Array of execution checks

Example Response

{
  "Days": null,
  "NotFinishedActualTrans": null,
  "InProcess": null,
  "Transactions": [
    {
      "ID": "A54A8B97-FBC2-459B-A48D-76BC572F3A9C",
      "Date": "2024-11-12T15:13:23.45",
      "Deadline": "2024-11-12T15:28:27.023",
      "Invoice": "4B6R4EOAAX2P",
      "AcquirerID": "ABSA",
      "AcquirerApprovalCode": "SIMULATION",
      "Status": "IN-TRANSFER",
      "RRN": "908033871579",
      "TerminalName": "sandton.demo.za",
      "ClientProductCode": "CYCLE_SDK_EXAMPLE",
      "Amount": 100.00,
      "CurrencyID": "ZAR",
      "PosID": 21261,
      "State": 400,
      "Substate": 411,
      "InputType": 4,
      "Card": {
        "IIN": "visa",
        "BIN": "427638",
        "EXP": "2607",
        "PANMasked": "*5239"
      },
      "ExtID": "TEST_APP_SA_001",
      "TransPos": {
        "ID": 21261,
        "Email": "agent1@cyclepay.africa",
        "Name": "CyclePay Test Agent"
      }
    },
    {
      "ID": "E3997556-4D91-451C-83F7-54B21C2B56A4",
      "Date": "2024-11-12T15:12:39.477",
      "Deadline": "2024-11-12T15:27:42.313",
      "Invoice": "4B6RYZZAAX2P",
      "AcquirerID": "ABSA",
      "AcquirerApprovalCode": "SIMULATION",
      "Status": "IN-TRANSFER",
      "RRN": "907593810147",
      "TerminalName": "sandton.demo.za",
      "ClientProductCode": "CYCLE_SDK_EXAMPLE",
      "Amount": 100.00,
      "CurrencyID": "ZAR",
      "PosID": 21261,
      "State": 400,
      "Substate": 411,
      "InputType": 4,
      "Card": {
        "IIN": "mastercard",
        "BIN": "557073",
        "EXP": "2511",
        "PANMasked": "*9259"
      },
      "ExtID": "TEST_APP_SA_002",
      "TransPos": {
        "ID": 21261,
        "Email": "agent1@cyclepay.africa",
        "Name": "CyclePay Test Agent"
      }
    }
  ],
  "TransactionsCounters": {
    "Pagesize": 100,
    "ItemCountPage": 100,
    "ItemCountTtl": 149,
    "PageCount": 2,
    "AmountCvt": 83062.92
  },
  "ErrorCode": 0,
  "ErrorMessage": null,
  "Validations": null
}