Skip to main content
POST
Add funds

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required
supplierStoreId
string<uuid>
required

Body

application/json

Adds funds to the balance a store holds with one of its suppliers.

amount
number<double>
required

How much credit to add, before the gateway's fee.

Required range: 1 <= x <= 1000000
gateway
string
required

Which of the supplier's payment methods to pay with.

Minimum string length: 1

Response

The object was successfully created.

Represents a default generic response for API endpoints.

success
boolean
required

Indicates whether the operation or response was successful.

message
string | null

A descriptive message providing additional context or information about the response.

code
string | null

The error code (if there was an error) to use when referencing the error

data
object

A started top-up: the order raised on the supplier's store, and where to go and pay it.

Last modified on August 22, 2026