Get the wallet histories

Gets the wallet histories.

get

Path parameters

idstringRequired

The id of the wallet.

Query parameters

CodestringOptional

The transaction code to filter the transactions.

RefObjectstringOptional

The reference object to filter the transactions.

RefIdinteger · int64Optional

The reference id to filter the transactions.

TagsstringOptional

The tags to filter the transactions.

Typestring · enumOptional

This enum defines the transaction types.

Possible values:

Statusstring · enumOptional

This enum defines the payment status.

Possible values:

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/wallets/{id}/histories HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "user": {
          "id": "Plamxinzg18snza",
          "code": "EXAMPLE",
          "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
          "packageId": "1Plamxinzg18snza",
          "packageCode": "PACKAGE",
          "emailAddress": "[email protected]",
          "phoneNumber": "[phone]",
          "nickName": "example",
          "roles": [
            "admin",
            "support"
          ]
        },
        "code": "Code",
        "type": "Capture",
        "amount": 100,
        "currencyCode": "USD",
        "notes": "Notes",
        "tags": "Tags",
        "description": "Description",
        "status": "Completed",
        "paymentDate": "2025-09-19T11:20:20.7345543+07:00"
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}