Merchant Management API Specification

Get All Webhook Subscriptions

get /merchant-management/webhooks/subscriptions

Retrieve all webhook subscriptions affiliated to the authenticated client.

Example Response

200 A list of webhook subscriptions was successfully returned.

401 Unauthorized - Error response.

403 Forbidden error response.

500 Internal Server Error - Error response.

Create a Webhook Subscription

post /merchant-management/webhooks/subscriptions

Create a new webhook subscription.

Request Schema

description required

Type

string

Minimum Length

1

Example

Merchant Status Change Webhook

Loading...

targetUrl required

Type

string

Minimum Length

1

Example

https://api.example.com/webhook

Loading...

authorization required

Type

object

Loading...

events required

Type

array

Loading...

secret required

Type

string

Minimum Length

1

Example

test-secret-12345

Loading...

Example Request

{
  "description": "Merchant Status Change Webhook",
  "targetUrl": "https://api.example.com/webhook",
  "authorization": {
    "authorizationType": "none",
    "authorizationData": null
  },
  "events": [
    "merchant.status.changed"
  ],
  "secret": "test-secret-12345"
}

Example Response

200 Webhook subscription was successfully created.

400 Bad Request - The supplied webhook event names are not valid, or the supplied target URL was rejected by the target URL safety validations (HTTP / HTTPS protocol only, no localhost / loopback addresses and no private or internal IP addresses). The rejection reason is returned on the `data.errors` object, keyed by the request body field it relates to.

401 Unauthorized - Error response.

403 Forbidden error response.

408 Request Timeout - The Webhook Management API did not respond in time.

422 Unprocessable Entity - Request body failed structural validation.

500 Internal Server Error - Error response.

Get Webhook Subscription by ID

get /merchant-management/webhooks/subscriptions/id/{subscriptionId}

Retrieve webhook subscription details by subscription ID.

Parameters

subscriptionId required

Type

string

Loading...

Example Response

200 Webhook subscription details were successfully returned.

401 Unauthorized - Error response.

403 Forbidden error response.

404 Not Found - Error response.

422 Unprocessable Entity - Subscription ID failed validation.

500 Internal Server Error - Error response.

Update Webhook Subscription by ID

patch /merchant-management/webhooks/subscriptions/id/{subscriptionId}

Update a webhook subscription by subscription ID.

Parameters

subscriptionId required

Type

string

Loading...

Request Schema

description

Type

string

Minimum Length

1

Example

Merchant Status Change Webhook

Loading...

targetUrl

Type

string

Minimum Length

1

Example

https://api.example.com/webhook

Loading...

authorization

Type

object

Loading...

events

Type

array

Loading...

secret

Type

string

Minimum Length

1

Example

test-secret-12345

Loading...

Example Request

{
  "description": "Updated Webhook Description",
  "targetUrl": "https://api.example.com/updated-webhook"
}

Example Response

200 Webhook subscription was successfully updated.

400 Bad Request - The supplied webhook event names are not valid, or the supplied target URL was rejected by the target URL safety validations (HTTP / HTTPS protocol only, no localhost / loopback addresses and no private or internal IP addresses). The rejection reason is returned on the `data.errors` object, keyed by the request body field it relates to.

401 Unauthorized - Error response.

403 Forbidden error response.

404 Not Found - Error response.

408 Request Timeout - The Webhook Management API did not respond in time.

422 Unprocessable Entity - Subscription ID or request body failed structural validation.

500 Internal Server Error - Error response.

Delete Webhook Subscription by ID

delete /merchant-management/webhooks/subscriptions/id/{subscriptionId}

Delete a webhook subscription by subscription ID.

Parameters

subscriptionId required

Type

string

Loading...

Example Response

200 Webhook subscription was successfully deleted.

401 Unauthorized - Error response.

403 Forbidden error response.

404 Not Found - Error response.

422 Unprocessable Entity - Subscription ID failed validation.

500 Internal Server Error - Error response.

Merchant Management API Specification

Webhooks

Get All Webhook Subscriptions

Create a Webhook Subscription

Get Webhook Subscription by ID

Update Webhook Subscription by ID

Delete Webhook Subscription by ID