Skip to content

GET Get Cashier Transactions

Endpoint

GET /cashier/transactions

Command

GetCashierTransactions

Authorization

Requires SESSION_CUSTOMER.

Description

Returns Cashier transactions that belong to the authenticated customer using the standard filter format.

The method always filters by the customer id from the session. A customer cannot request another customer's transactions through this endpoint. When login is provided, the account must belong to the authenticated customer.

Query Parameters

Name Type Required Description
limit int No Page size. Defaults to 100
offset int No Pagination offset. Defaults to 0
login int No Trading account login owned by the authenticated customer
where array No AND filters
whereNot array No Negative filters
whereIn array No Include-by-list filters
whereNotIn array No Exclude-by-list filters
whereBetween array No Range filters
whereNotBetween array No Negative range filters
orderBy array No Sort expression

Supported filter fields:

Field Type
id int
customer_id int
login int
type int
status int
source int
provider string
method string
currency string
provider_payment_id string
approved_time int64
processed_time int64
created_time int64

Request Example

GET /cashier/transactions?limit=50&offset=0&login=2000009&where[0][0]=status&where[0][1]==&where[0][2]=1&orderBy[0][0]=created_time&orderBy[0][1]=desc
Authorization: <CUSTOMER_JWT>

Response Fields

Name Type Description
rows array Cashier transaction objects
count int Total number of matching rows before pagination

Each transaction object contains:

Name Type Description
id int Cashier transaction id
customer_id int Customer id
login int Trading account login
type int 0 deposit, 1 withdrawal
provider string Provider code
method string Provider method
provider_payment_id string External payment id
amount double Transaction amount
currency string Transaction currency
account_currency string Account currency
converted_amount double Converted account-currency amount
conversion_rate double Conversion rate
status int Cashier transaction status
failure_reason string Failure reason
idempotency_key string Idempotency key
comment string Comment
metadata_json string Metadata JSON string
source int 0 provider, 1 manual
approved_by int Manager id that approved manual transaction
approved_time int64 Approval timestamp
processed_by int Manager id that processed manual transaction
processed_time int64 Processing timestamp
reject_reason string Rejection reason
created_time int64 Creation timestamp
updated_time int64 Last update timestamp

Response Example

{
  "rows": [
    {
      "id": 15,
      "customer_id": 5,
      "login": 2000009,
      "type": 0,
      "provider": "stripe",
      "method": "card",
      "provider_payment_id": "pi_123",
      "amount": 250.0,
      "currency": "USD",
      "account_currency": "USD",
      "converted_amount": 250.0,
      "conversion_rate": 1.0,
      "status": 1,
      "failure_reason": "",
      "idempotency_key": "0f9bb0e7-642d-4b70-b458-62e3993c7d2d",
      "comment": "",
      "metadata_json": "{}",
      "source": 0,
      "approved_by": 0,
      "approved_time": 0,
      "processed_by": 0,
      "processed_time": 0,
      "reject_reason": "",
      "created_time": 1779270000,
      "updated_time": 1779270000
    }
  ],
  "count": 1
}

Errors

HTTP Error Description
403 PERMISSION_DENIED Invalid customer session
403 PERMISSION_DENIED login does not belong to the authenticated customer
400 INVALID_DATA Invalid filter parameters