Update webhook event endpoints for the authenticated company

PUT

/order/v1/webhook

• Sandbox

Replaces the full list of event endpoints. Does not change the HMAC secret.

Authorizations

• Bearer

Request Body ^required

object

companyId

Set by the controller from the authenticated company

string

events

required

Full list of webhook events to store (replaces previous events)

Array<object>

object

type

required

Webhook event type

string

Allowed values: PAYIN PAYOUT LOAD KYC ACCOUNT MED KEY_CLAIM

Example

PAYIN

endpoint

required

HTTPS endpoint that will receive the webhook payload

string

Example

https://merchant.example.com/webhooks/payin

Responses

200

The resource was returned successfully

object

id

required

string

companyId

string

organizationId

string

status

string

createdAt

string

updatedAt

string

events

required

Array<object>

object

type

required

The type of webhook event

string

Allowed values: PAYIN PAYOUT LOAD KYC ACCOUNT MED KEY_CLAIM

Example

PAYIN

endpoint

required

The endpoint URL for the webhook event

string

Example

https://example.com/webhook

status

required

The status of the webhook event

string

Allowed values: ACTIVE INACTIVE

Example

ACTIVE

createdAt

required

The date and time when the webhook event was created

string

Example

2022-01-01T00:00:00Z

updatedAt

required

The date and time when the webhook event was last updated

string

Example

2022-01-01T00:00:00Z

400

object

error

string

Example

INVALID_REQUEST

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[
  {
    "field": "field_name",
    "issue": "INVALID",
    "description": "Field is invalid"
  }
]

401

Unauthorized Request

object

error

string

Example

UNAUTHORIZED

message

string

Example

Unauthorized Request

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

403

object

error

string

Example

FORBIDDEN_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

404

Resource not found

object

error

string

Example

NOT_FOUND

message

string

Example

Resource not found

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

500

object

error

string

Example

INTERNAL_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]