GET
/
account
/
json
/
balance
/

Authorizations

Authorization
string
headerrequired

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

Query Parameters

tokenized
boolean

Filter result set by whether the transaction was performed using a recurring execution token

from
integer

Retrieve a past balance value at a specific Unix timestamp

brand
string

Filter result set to only include the specified brand UUID(s)

terminal_uid
string

Filter result set to only include the specified terminal UUID(s)

currency
string

Filter result set to only include specified currency(ies)

payment_method
enum<string>

Filter result set to only include specified payment methods(s). See <a href="#model-PaymentMethod">PaymentMethod<a> fro more information.

Available options:
fpx,
fpx_b2b1,
maestro,
mastercard,
razer,
unknown,
visa
product
enum<string>

Filter result set to only include specified products(s). See <a href="#model-TransactionProduct">TransactionProduct<a> fro more information.

Available options:
bank_payment,
custom_payment,
invoice,
purchase,
refund,
subscription
flow
enum<string>

Filter result set to only include specified transaction creation or execution flow(s). See <a href="#model-TransactionFlow">TransactionFlow<a> fro more information.

Available options:
api,
direct_post,
fluentforms,
formidableforms,
givewp,
gravityforms,
hostbill,
import,
link,
magento,
opencart,
payform,
paymattic,
prestashop,
server_to_server,
shopify,
web_office,
whmcs,
woocommerce,
wpcharitable
country
string

Filter result set to only include specified client country(ies) in ISO 3166-1 alpha-2 format

Response

200 - application/json

Map of currency to company Balance for the specific currency