Skip to main content
PUT
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.

methodId
string
required

The method, by its ID (custom_ and 16 hex characters).

Body

application/json
kind
enum<string>

instructions: the buyer is shown how to pay. redirect: the buyer is sent to a page of yours.

Available options:
instructions,
redirect
name
string

What the checkout calls it, up to 60 characters.

Example:

"Bank Transfer (EU)"

description
string

A line under its name at checkout, up to 160 characters.

Example:

"Two working days"

instructions
string

For instructions: how to pay, in Markdown, up to 300 characters. {order}, {amount}, {currency}, {email} and {store} are filled in.

redirectUrl
string

For redirect: the https address the buyer is sent to, up to 1000 characters, with the same variables filled in.

asksProof
boolean

Whether the buyer is asked for a reference or a proof of payment, at least one.

requiresPicture
boolean

Whether a proof of payment is required, whatever else is sent. Needs asksProof.

enabled
boolean

Whether the checkout offers it.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object[]
meta
object