Get all transactions

GET /transactions

Description

Retrieve information about all transactions.

Optional Path Parameters

Name	Type	Description	Required
filterByStatuses	array[string]	Filter transactions by status. Available values: PENDING, APPROVED, REJECTED, REVERSED.	Optional
filterBySources	array[string]	Filter transactions by source. Available values: CORAL_PAY, AMETA, _9BSP.	Optional
filterByPaymentMethods	array[string]	Filter transactions by payment method. Available values: USSD, NQR, BANK, WALLET, CARD, PAYLINK, DEPOSIT_DEBIT, DEPOSIT_CREDIT.	Optional
filterByTypes	array[string]	Filter transactions by type. Available values: CREDIT, DEBIT.	Optional
filterByCategories	array[string]	Filter transactions by category. Available values: Sales, Cash-in, Cash-out, Top-up, Bills, Transfer, Deposit, Withdraw, CHARGE.	Optional
filterByTenantIds	array[string]	Filter transactions by tenant IDs.	Optional
filterByCustomerIds	array[string]	Filter transactions by customer IDs.	Optional
filterByAccountIds	array[string]	Filter transactions by account IDs.	Optional
filterByCurrencies	array[string]	Filter transactions by currencies.	Optional
filterByPaymentCodes	array[string]	Filter transactions by payment codes.	Optional
filterBySubSource	array[string]	Filter transactions by sub-source.	Optional
filterBySubSourceStatuses	array[string]	Filter transactions by sub-source statuses.	Optional
filterByPaymentIds	array[string]	Filter transactions by payment IDs.	Optional
filterByTerminalIds	array[string]	Filter transactions by terminal IDs.	Optional
filterByRequestIds	array[string]	Filter transactions by request IDs.	Optional
filterByTransactionIds	array[string]	Filter transactions by transaction IDs.	Optional
filterByReferenceIds	array[string]	Filter transactions by reference IDs.	Optional
preDebit	boolean	Filter transactions by pre-debit status.	Optional
pageNumber	integer($int32)	Page number for paginated results.	Optional
pageSize	integer($int32)	Page size for paginated results.	Optional

StartFragment

Response Code: 200 - OK

Description

Transaction returned successfully.

Response Field

Field	Type	Description
status	boolean	Indicates the overall success of the operation.
statusCode	integer	Represents the specific status code for the response.
message	string	Provides additional information about the response.
data	object	Contains the main data payload of the response.
errors	array	An array containing error details if issues occurred.
- message	string	Describes the error.
- descriptiveMessage	string	Provides a more detailed and descriptive message about the error.

Example

<response>
  <status>true</status>
  <statusCode>0</statusCode>
  <message>string</message>
  <data></data>
  <errors>
    <error>
      <message>string</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</response>

---

Response Code: 400 - Bad Request

Description

Invalid transaction id.

Example

<response>
  <status>false</status>
  <statusCode>400</statusCode>
  <message>Invalid transaction id</message>
  <data></data>
  <errors>
    <error>
      <message>Invalid transaction id</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</response>

curlUrl: "/transactions" curlMethod: GET

Response Code: 404 - Not Found

Description

Transaction id not found.

Example

<response>
  <status>false</status>
  <statusCode>404</statusCode>
  <message>Transaction id not found</message>
  <data></data>
  <errors>
    <error>
      <message>Transaction id not found</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</response>

Method: GET

>http://20.87.230.105/platform/wallets/transactions

Headers

Content-Type	Value
apiKey	{{apiKey}}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string