Skip to main content
POST
cURL

Headers

X-CSRF-Token
string
required

Echoes the token from the current session. Required on every unsafe method.

Path Parameters

provider
string
required

Body

application/json
passed
boolean
required
enable
boolean
required

Only honoured alongside a passing test and an adapter that declares the capability.

merchantId
string

Response

Saved

provider
string
required
merchantId
string
required
enabled
boolean
required
displayOrder
integer
required
credentialsSet
boolean
required

Whether a credential is stored. The credential itself is never returned.

webhookSecretSet
boolean
required
adapterRecurring
boolean
required

What the compiled-in adapter declares. The operator switch can only narrow this.

recurringEnabled
boolean
required
recurringTestStatus
enum<string>
required
Available options:
untested,
passed,
failed
connectionStatus
enum<string>
required
Available options:
unknown,
healthy,
failing
webhookStatus
enum<string>
required
Available options:
unknown,
healthy,
failing
updatedAt
string<date-time>
required
recurringTestedAt
string<date-time>
connectionCheckedAt
string<date-time>
connectionErrorCode
string
webhookLastEventAt
string<date-time>
webhookLastErrorCode
string