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.

Body

application/json
enabled
boolean

Whether checkouts are routed.

mode
enum<string>

How a checkout is given a processor.

Available options:
share,
order,
cheapest
retry
boolean

Whether a declined card is moved to the next processor. A card declined as stolen, lost or fake never is.

sticky
boolean

Whether a returning buyer goes to the processor they last paid with.

guard
boolean

Whether a processor whose keys fail, or with too many declines, is paused. The last one in rotation never is.

guardDeclines
integer

How many of the window's payments declined pause a processor, from 1 to guardWindow.

Example:

8

guardWindow
integer

How many of its last routed payments are judged, from 5 to 200.

Example:

20

disputeAlert
number

The percent of a processor's paid orders disputed that the store is told of, once a week at most, above 0 and up to 100. Empty or null for none. Nothing is moved for it.

Example:

0.75

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object