Substy Developers
Billing

Update agency wallet settings

Update the agency wallet's minimum balance and low-balance notification preference.

PATCH/v1/agencies/{agencyId}/wallet/settings

Update the agency wallet's minimum balance and low-balance notification preference.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/agencies/string/wallet/settings" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "minimumBalance": 0,    "lowBalanceNotificationsEnabled": true  }'
{  "data": {    "agencyId": "string",    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "minimumBalance": "string",    "lowBalanceNotificationsEnabled": true,    "balance": "string",    "lastLowBalanceNotificationSent": null  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

Export wallet transactions GET

Export matching agency wallet transactions as CSV. Supply the desired date range and transaction filters.

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.