Adjust Wallet Balance

Endpoint to change the balance for a wallet.

It will add the amount to the wallet if the amount is positive and burn the amount if it is negative. The amount is ISO 4217 currency code compliant meaning that 100 as an input for USD marketplace will be 1 USD.

POST /public/v1/billing-service/vendors/{external-vendor-id}/wallets/{wallet-id}/adjust

Adjust Wallet Balance

cURL

curl --request POST \
  --url https://api.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/wallets/{wallet-id}/adjust \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "description": "<string>"
}
'

200

{
  "balance": 123
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Path Parameters

external-vendor-id · string · required

The External ID of the Vendor to retrieve.

Minimum string length: 1

wallet-id · string<uuid> · required

The ID of the wallet to retrieve.

Body

application/json

amount · integer · required

Amount to add to the balance. This value must be non-zero. ISO 4217 standard.

Example:

100

description · string · required

Reason given to adjust the amount

Minimum string length: 1

Example:

"Vendor used the money for other ads"

Response

200

application/json

Successful Response

balance · integer · required

Resulting balance of an adjustment. ISO 4217 standard