Get wallet transactions

Use when showing transaction history for a wallet (e.g. credit/debit log or audit). Returns a paginated list; supports limit, offset, and filters.

GET /wallets/{id}/transactions

Get wallet transactions

cURL

curl --request GET \
  --url https://us.api.flexprice.io/v1/wallets/{id}/transactions \
  --header 'x-api-key: <api-key>'

import requests

url = "https://us.api.flexprice.io/v1/wallets/{id}/transactions"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://us.api.flexprice.io/v1/wallets/{id}/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.api.flexprice.io/v1/wallets/{id}/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/wallets/{id}/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://us.api.flexprice.io/v1/wallets/{id}/transactions")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/wallets/{id}/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "amount": "<string>",
      "conversion_rate": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "created_by_user": {
        "email": "<string>",
        "id": "<string>",
        "metadata": {},
        "name": "<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>",
        "contact": "<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>",
            "metadata": {},
            "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>",
        "timezone": "<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": {},
      "parent_transaction_id": "<string>",
      "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": "<string>"
          },
          "info": {
            "threshold": "<string>"
          },
          "warning": {
            "threshold": "<string>"
          }
        },
        "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>",
        "real_time_balance": "<string>",
        "real_time_credit_balance": "<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
  }
}

{
  "http_status_code": 123,
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

Authorizations

x-api-key · string · header · required

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

Path Parameters

id · string · required

Wallet ID

Query Parameters

created_by · string

credits_available_gt · number

end_time · string

expand · string

expiry_date_after · string

expiry_date_before · string

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

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

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