Substy Developers
Billing

Create wallet top up

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.

POST/v1/agencies/{agencyId}/wallet/top-ups

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.

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 POST "https://example.com/v1/agencies/string/wallet/top-ups" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "amount": 5  }'
{  "data": {    "message": "string",    "provider": "card",    "step": "payment",    "transactionId": "string",    "sessionId": "string",    "returnUrl": "string",    "paymentId": null,    "paymentUrl": "string"  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

Update agency wallet settings PATCH

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

Get agency wallet usage GET

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