Substy Developers
Billing

Get agency wallet usage

Read agency wallet usage over the requested dates and reporting granularity, using the current employee's reporting timezone.

GET/v1/agencies/{agencyId}/wallet/usage

Read agency wallet usage over the requested dates and reporting granularity, using the current employee's reporting timezone.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length

Query Parameters

startDate*string

ISO 8601 timestamp including a timezone offset.

Formatdate-time
endDate*string

ISO 8601 timestamp including a timezone offset.

Formatdate-time
granularity*string

Value in

  • "daily"
  • "weekly"
  • "monthly"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/wallet/usage?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&granularity=daily" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "usage": [      {        "date": "string",        "usage": 0,        "earned": 0      }    ]  },  "meta": {    "requestId": "string"  }}

Create wallet top up POST

Create a wallet top-up for the supplied amount, payment method and currency. Open the returned checkout when required; a checkout being created does not confirm payment.

List wallet payment currencies GET

List the cryptocurrencies supported for agency wallet top-ups.