Skip to main content
POST
/
wallets
/
transactions
/
search
List wallet transactions by filter
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/wallets/transactions/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "created_by": "<string>",
  "credits_available_gt": 123,
  "end_time": "<string>",
  "expand": "<string>",
  "expiry_date_after": "<string>",
  "expiry_date_before": "<string>",
  "filters": [
    {
      "data_type": "string",
      "field": "<string>",
      "operator": "eq",
      "value": {
        "array": [
          "<string>"
        ],
        "boolean": true,
        "date": "<string>",
        "number": 123,
        "string": "<string>"
      }
    }
  ],
  "id": "<string>",
  "limit": 500,
  "offset": 1,
  "order": "asc",
  "priority": 123,
  "reference_id": "<string>",
  "reference_type": "<string>",
  "sort": [
    {
      "direction": "asc",
      "field": "<string>"
    }
  ],
  "start_time": "<string>",
  "status": "published",
  "transaction_reason": "INVOICE_PAYMENT",
  "transaction_status": "pending",
  "type": "credit"
}
'
{
  "items": [
    {
      "amount": "<string>",
      "conversion_rate": "<string>",
      "created_at": "<string>",
      "created_by": "<string>",
      "created_by_user": {
        "email": "<string>",
        "id": "<string>",
        "roles": [
          "<string>"
        ],
        "tenant": {
          "billing_details": {
            "address": {
              "address_city": "<string>",
              "address_country": "<string>",
              "address_line1": "<string>",
              "address_line2": "<string>",
              "address_postal_code": "<string>",
              "address_state": "<string>"
            },
            "email": "<string>",
            "help_email": "<string>",
            "phone": "<string>"
          },
          "created_at": "<string>",
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "status": "<string>",
          "updated_at": "<string>"
        },
        "type": "user"
      },
      "credit_amount": "<string>",
      "credit_balance_after": "<string>",
      "credit_balance_before": "<string>",
      "credits_available": "<string>",
      "currency": "<string>",
      "customer": {
        "address_city": "<string>",
        "address_country": "<string>",
        "address_line1": "<string>",
        "address_line2": "<string>",
        "address_postal_code": "<string>",
        "address_state": "<string>",
        "created_at": "<string>",
        "created_by": "<string>",
        "email": "<string>",
        "environment_id": "<string>",
        "external_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "name": "<string>",
        "parent_customer": "<unknown>",
        "parent_customer_id": "<string>",
        "status": "published",
        "tenant_id": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "customer_id": "<string>",
      "description": "<string>",
      "environment_id": "<string>",
      "expiry_date": "<string>",
      "id": "<string>",
      "idempotency_key": "<string>",
      "metadata": {},
      "priority": 123,
      "reference_id": "<string>",
      "reference_type": "PAYMENT",
      "status": "published",
      "tenant_id": "<string>",
      "topup_conversion_rate": "<string>",
      "transaction_reason": "INVOICE_PAYMENT",
      "transaction_status": "pending",
      "type": "credit",
      "updated_at": "<string>",
      "updated_by": "<string>",
      "wallet": {
        "alert_config": {
          "threshold": {
            "type": "amount",
            "value": 123
          }
        },
        "alert_enabled": true,
        "alert_state": "<string>",
        "auto_topup": {
          "amount": 123,
          "enabled": true,
          "invoicing": true,
          "threshold": 123
        },
        "balance": "<string>",
        "config": {
          "allowed_price_types": [
            "ALL"
          ]
        },
        "conversion_rate": "<string>",
        "created_at": "<string>",
        "created_by": "<string>",
        "credit_balance": "<string>",
        "credits_available_breakdown": {
          "free": "<string>",
          "purchased": "<string>"
        },
        "currency": "<string>",
        "customer_id": "<string>",
        "description": "<string>",
        "environment_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "name": "<string>",
        "status": "published",
        "tenant_id": "<string>",
        "topup_conversion_rate": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>",
        "wallet_status": "active",
        "wallet_type": "PROMOTIONAL"
      },
      "wallet_id": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Query Parameters

expand
string

Expand fields (e.g., customer,created_by_user,wallet)

Body

application/json

Filter

created_by
string
credits_available_gt
number
end_time
string
expand
string
expiry_date_after
string
expiry_date_before
string
filters
object[]

filters allows complex filtering based on multiple fields

id
string
limit
integer
Required range: 1 <= x <= 1000
offset
integer
Required range: x >= 0
order
enum<string>
Available options:
asc,
desc
priority
integer
reference_id
string
reference_type
string
sort
object[]
start_time
string
status
enum<string>
Available options:
published,
deleted,
archived
transaction_reason
enum<string>
Available options:
INVOICE_PAYMENT,
FREE_CREDIT_GRANT,
SUBSCRIPTION_CREDIT_GRANT,
PURCHASED_CREDIT_INVOICED,
PURCHASED_CREDIT_DIRECT,
CREDIT_NOTE,
CREDIT_EXPIRED,
WALLET_TERMINATION,
MANUAL_BALANCE_DEBIT
transaction_status
enum<string>
Available options:
pending,
completed,
failed
type
enum<string>
Available options:
credit,
debit

Response

OK

items
object[]
pagination
object