Skip to content
Sulpayments

Inbound provider webhook

POST
/webhooks/{provider}
curl --request POST \
  --url https://api.sulpayments.ch/webhooks/example \
  --header 'Content-Type: text/plain' \
  --data example

The endpoint providers post settlement events to. It is provider-facing, not merchant-facing; merchants receive outbound settlement notifications instead (see the settlement notifications guide).

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
provider
required
string

The provider's registered name, assigned during provider onboarding

Request Bodyrequired

Section titled “Request Bodyrequired”

Provider payload, verified against the provider's signature scheme

Media typetext/plain
string

Responses

Section titled “Responses”

200

Section titled “200”

Accepted or duplicate delivery

Media typeapplication/json

Outcome of an inbound provider webhook. Providers should treat any 2xx as final; other statuses may be retried by the provider's own policy.

object
log_id

Raw-log id assigned to this delivery when one was recorded.

string | null format: uuid
status
required
string
Allowed values: accepted duplicate invalid_signature malformed provider_disabled unknown_provider error
Example
{
  "status": "accepted"
}

400

Section titled “400”

Authentic but malformed payload

Media typeapplication/json

Outcome of an inbound provider webhook. Providers should treat any 2xx as final; other statuses may be retried by the provider's own policy.

object
log_id

Raw-log id assigned to this delivery when one was recorded.

string | null format: uuid
status
required
string
Allowed values: accepted duplicate invalid_signature malformed provider_disabled unknown_provider error
Example
{
  "status": "accepted"
}

401

Section titled “401”

Signature verification failed

Media typeapplication/json

Outcome of an inbound provider webhook. Providers should treat any 2xx as final; other statuses may be retried by the provider's own policy.

object
log_id

Raw-log id assigned to this delivery when one was recorded.

string | null format: uuid
status
required
string
Allowed values: accepted duplicate invalid_signature malformed provider_disabled unknown_provider error
Example
{
  "status": "accepted"
}

404

Section titled “404”

Unknown provider

Media typeapplication/json

Outcome of an inbound provider webhook. Providers should treat any 2xx as final; other statuses may be retried by the provider's own policy.

object
log_id

Raw-log id assigned to this delivery when one was recorded.

string | null format: uuid
status
required
string
Allowed values: accepted duplicate invalid_signature malformed provider_disabled unknown_provider error
Example
{
  "status": "accepted"
}

500

Section titled “500”

Internal failure, safe to retry

Media typeapplication/json

Outcome of an inbound provider webhook. Providers should treat any 2xx as final; other statuses may be retried by the provider's own policy.

object
log_id

Raw-log id assigned to this delivery when one was recorded.

string | null format: uuid
status
required
string
Allowed values: accepted duplicate invalid_signature malformed provider_disabled unknown_provider error
Example
{
  "status": "accepted"
}