GET
See a customer's store credit
Company space For: Cashier and seller, Manager, Accountant · Permission: customers.viewwallet Conditions
  • a removed customer can still be looked up here while they hold credit
Part of Pay back customers’ store credit.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customer
string
required

Identifier of the customer (27-character KSUID string).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, customer_id, currency_code, currency_exponent, balance, advance_balance, refundable_balance, status.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

200 - application/json

Resource.

id

Identifier of the wallet.

customer_id

Customer who holds the wallet.

currency_code

Currency of the wallet. A customer has one wallet per currency.

currency_exponent
integer

Number of decimal places of currency_code when the wallet was opened; it is the one used for all the amounts of the wallet.

balance
number

Everything the customer holds in this currency: advance_balance plus refundable_balance, in main units of currency_code.

advance_balance
number

Money the customer paid in advance and has not yet used, in main units of currency_code. Nothing in the API adds to it today.

refundable_balance
number

Credit the company owes the customer and can pay back in cash, for example from a cancelled paid sale, in main units of currency_code.

status

active, or frozen: a frozen wallet cannot be paid out. Nothing in the API freezes a wallet today.