Skip to main content
POST
Node.js

Authorizations

Authorization
string
header
required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Headers

Idempotency-Key
string

A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with Idempotent-Replay: true.

Path Parameters

storeId
string
required

The store's ID. A key reaches the store it was made in: GET /key answers which.

customerId
string
required

The customer.

Body

application/json
mode
enum<string>
required

Add to it, take from it, or set it to exactly this.

Available options:
add,
subtract,
set
amount
number
required

How much, in the store's currency, with at most 2 decimals.

Example:

5

note
string

Why, up to 500 characters. Kept in the balance's history.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object