Query wallet transactions

Use when searching or reporting on wallet transactions (e.g. cross-wallet history or reconciliation). Returns a paginated list; supports filtering by wallet, customer, type, date range.

POST /wallets/transactions/search

Query wallet transactions

cURL

curl --request POST \
  --url https://us.api.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": "2023-11-07T05:31:56Z",
  "expand": "<string>",
  "expiry_date_after": "<string>",
  "expiry_date_before": "<string>",
  "filters": [
    {
      "field": "<string>",
      "value": {
        "array": [
          "<string>"
        ],
        "boolean": true,
        "date": "<string>",
        "number": 123,
        "string": "<string>"
      }
    }
  ],
  "id": "<string>",
  "limit": 500,
  "offset": 1,
  "priority": 123,
  "reference_id": "<string>",
  "reference_type": "<string>",
  "sort": [
    {
      "field": "<string>"
    }
  ],
  "start_time": "2023-11-07T05:31:56Z"
}
'

200

{
  "items": [
    {
      "amount": "<string>",
      "conversion_rate": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "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": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "status": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      },
      "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": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "email": "<string>",
        "environment_id": "<string>",
        "external_id": "<string>",
        "id": "<string>",
        "integrations": [
          {
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "entity_id": "<string>",
            "environment_id": "<string>",
            "id": "<string>",
            "provider_entity_id": "<string>",
            "provider_type": "<string>",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          }
        ],
        "metadata": {},
        "name": "<string>",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      },
      "customer_id": "<string>",
      "description": "<string>",
      "environment_id": "<string>",
      "expiry_date": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "idempotency_key": "<string>",
      "metadata": {},
      "priority": 123,
      "reference_id": "<string>",
      "tenant_id": "<string>",
      "topup_conversion_rate": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>",
      "wallet": {
        "alert_settings": {
          "alert_enabled": true,
          "critical": {
            "threshold": 123
          },
          "info": {
            "threshold": 123
          },
          "warning": {
            "threshold": 123
          }
        },
        "auto_topup": {
          "amount": 123,
          "enabled": true,
          "invoicing": true,
          "threshold": 123
        },
        "balance": "<string>",
        "config": {
          "allowed_price_types": []
        },
        "conversion_rate": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "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>",
        "tenant_id": "<string>",
        "topup_conversion_rate": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      },
      "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>*

Body

application/json

Filter

created_by · string

credits_available_gt · number

end_time · string<date-time>

expand · string

expiry_date_after · string

expiry_date_before · string

filters · object[]

filters allows complex filtering based on multiple fields

Show child attributes

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[]

Show child attributes

start_time · string<date-time>

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, CREDIT_ADJUSTMENT, INVOICE_VOID_REFUND

transaction_status · enum<string>

Available options: pending, completed, failed

type · enum<string>

Available options: credit, debit

Response

200

application/json

OK

items · object[]

Show child attributes

pagination · object

Show child attributes