BYbyaccrue
Wallets

Get Wallet Balance

get/api/v1/wallets/:walletId/balance

Request

Path parameters

walletIdstring

ID of the wallet for which the balance is being fetched.

Example:123e4567-e89b-12d3-a456-426614174000

Query parameters

includestring

Comma-separated list of resources to include. Supported resources: user

userReferencestring

Attached User Profile Reference ID

Example:123e4567-e89b-12d3-a456-426614174000
purchaseAmountinteger

Purchase amount in cents. When provided, conditional reward calculations may use this value (e.g. minimum purchase thresholds).

Example:5000
includeWithdrawableAmountboolean

When true, the response includes the withdrawable amount in the balance.

Example:true

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

OK

Example response

{
  "data": {
    "attributes": {
      "balance": {
        "available": {
          "deposit": 1000,
          "reward": {
            "accrue": 20,
            "merchant": 180,
            "total": 200
          },
          "total": 1200
        },
        "pending": {
          "deposit": 0,
          "reward": {
            "accrue": 0,
            "merchant": 0,
            "total": 0
          },
          "total": 0
        },
        "reserved": {
          "total": 600
        },
        "total": {
          "deposit": 1500,
          "reward": {
            "accrue": 30,
            "merchant": 270,
            "total": 300
          },
          "total": 1800
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.