Creates a new webhook for the given account. Webhook will trigger for the declared events and send notifications to the provided URL.
object Metadata about the integrator and originators of the request, serialized as a valid JSON, to improve troubleshooting. Read more here Example: integration_metadata=[object Object] | |
Partner-Correlation-Id | string <= 255 characters ^[A-Za-z0-9]+$ An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response. |
Webhook created successfully.
Bad Request, there was an error in the input of the request.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
The webhook configuration already exists
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "event_types": [
- "payment.request.state-change.completed",
- "payment.transaction.state-change.expired",
- "partner.account.change.created"
], - "event_version": "v2",
- "signing_key_id": "krn:partner:global:notification:signing-key:49bcd37b-79a7-4e6e-b067-2903b45fef42",
- "status": "ENABLED"
}
{- "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "event_types": [
- "payment.request.state-change.completed",
- "payment.transaction.state-change.expired",
- "partner.account.change.created"
], - "event_version": "v2",
- "signing_key_id": "krn:partner:global:notification:signing-key:49bcd37b-79a7-4e6e-b067-2903b45fef42",
- "created_at": "2024-01-01T12:00:00Z",
- "status": "ENABLED"
}
Retrieves all webhooks for the given account.
object Metadata about the integrator and originators of the request, serialized as a valid JSON, to improve troubleshooting. Read more here Example: integration_metadata=[object Object] | |
Partner-Correlation-Id | string <= 255 characters ^[A-Za-z0-9]+$ An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response. |
Webhooks returned successfully.
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "webhooks": [
- {
- "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "event_types": [
- "payment.request.state-change.submitted",
- "payment.request.state-change.completed",
- "payment.request.state-change.expired"
], - "event_version": "v2",
- "signing_key_id": "krn:partner:global:notification:signing-key:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "status": "ENABLED",
- "created_at": "2021-01-01T00:00:00Z"
}
]
}
Retrieves details of a specific webhook for the given account.
object Metadata about the integrator and originators of the request, serialized as a valid JSON, to improve troubleshooting. Read more here Example: integration_metadata=[object Object] | |
Partner-Correlation-Id | string <= 255 characters ^[A-Za-z0-9]+$ An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response. |
Webhook returned successfully.
Bad Request, there was an error in the input of the request.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "event_types": [
- "payment.request.state-change.completed",
- "payment.transaction.state-change.expired",
- "partner.account.change.created"
], - "event_version": "v2",
- "signing_key_id": "krn:partner:global:notification:signing-key:49bcd37b-79a7-4e6e-b067-2903b45fef42",
- "created_at": "2024-01-01T12:00:00Z",
- "status": "ENABLED"
}
Updates a specific webhook for the given account. Webhook will remain intact for the fields not mentioned in the request.
object Metadata about the integrator and originators of the request, serialized as a valid JSON, to improve troubleshooting. Read more here Example: integration_metadata=[object Object] | |
Partner-Correlation-Id | string <= 255 characters ^[A-Za-z0-9]+$ An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response. |
Webhook updated successfully.
Bad Request, there was an error in the input of the request.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "event_types": [
- "payment.request.state-change.submitted",
- "payment.request.state-change.completed",
- "payment.request.state-change.expired"
], - "signing_key_id": "krn:partner:global:notification:signing-key:49bcd37b-79a7-4e6e-b067-2903b45fef42",
- "status": "ENABLED"
}
{- "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "event_types": [
- "payment.request.state-change.completed",
- "payment.transaction.state-change.expired",
- "partner.account.change.created"
], - "event_version": "v2",
- "signing_key_id": "krn:partner:global:notification:signing-key:49bcd37b-79a7-4e6e-b067-2903b45fef42",
- "created_at": "2024-01-01T12:00:00Z",
- "status": "ENABLED"
}
Deletes a specific webhook for the given account.
object Metadata about the integrator and originators of the request, serialized as a valid JSON, to improve troubleshooting. Read more here Example: integration_metadata=[object Object] | |
Partner-Correlation-Id | string <= 255 characters ^[A-Za-z0-9]+$ An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response. |
Webhook deleted successfully.
Bad Request, there was an error in the input of the request.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "error_id": "5a3f6b9c-9b3b-4b7e-8f9d-9b9a4b9a4b9a",
- "error_type": "INPUT_ERROR",
- "error_code": "INVALID_CONTENT_TYPE",
- "error_message": "The received input is not valid JSON.\nUnterminated string at 19 [character 20 line 1].\n"
}
Simulates a webhook notification by using webhook id for given event type and event version.
object Metadata about the integrator and originators of the request, serialized as a valid JSON, to improve troubleshooting. Read more here Example: integration_metadata=[object Object] | |
Partner-Correlation-Id | string <= 255 characters ^[A-Za-z0-9]+$ An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response. |
Webhook notification simulated successfully.
Bad Request, there was an error in the input of the request.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "event_type": "payment.request.state-change.completed",
- "event_version": "v2"
}
{- "metadata": {
- "event_id": "28ac927f-5ba7-4589-8bf7-1c8ada082343",
- "event_type": "payment.transaction.state-change.expired",
- "event_version": "v2",
- "occurred_at": "2024-01-01T12:00:00Z",
- "subject_account_id": "krn:partner:global:account:live:LWT2XJSE",
- "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE",
- "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918",
- "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5",
- "live": true
}, - "payload": {
- "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4",
- "payment_request_reference": "partner-payref-1234",
- "state": "AUTHORIZED",
- "previous_state": "PENDING_CONFIRMATION",
- "payment_transaction_id": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0"
}
}
Creates a new signing key for the given account. Webhook notifications can be verified with the signing key generated.
object Metadata about the integrator and originators of the request, serialized as a valid JSON, to improve troubleshooting. Read more here Example: integration_metadata=[object Object] | |
Partner-Correlation-Id | string <= 255 characters ^[A-Za-z0-9]+$ An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response. |
Signing key created successfully.
Bad Request, there was an error in the input of the request.
Unauthorized, the request was not authorized.
Operation forbidden
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "signing_key_id": "krn:partner:global:notification:signing-key:49bcd37b-79a7-4e6e-b067-2903b45fef42",
- "signing_key": "b040893b9e02f6445b205ae2102e3e9e1d0aa9035e61cdebde39b5c230a7bc5a",
- "created_at": "2024-01-01T12:00:00Z"
}
Retrieves all signing keys for the given account.
object Metadata about the integrator and originators of the request, serialized as a valid JSON, to improve troubleshooting. Read more here Example: integration_metadata=[object Object] | |
Partner-Correlation-Id | string <= 255 characters ^[A-Za-z0-9]+$ An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response. |
Signing keys returned successfully.
Bad Request, there was an error in the input of the request.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "signing_keys": [
- {
- "signing_key_id": "krn:partner:global:notification:signing-key:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "in_use": true,
- "created_at": "2021-01-01T00:00:00Z"
}
]
}
Retrieves details of a specific signing key for the given account.
object Metadata about the integrator and originators of the request, serialized as a valid JSON, to improve troubleshooting. Read more here Example: integration_metadata=[object Object] | |
Partner-Correlation-Id | string <= 255 characters ^[A-Za-z0-9]+$ An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response. |
Signing key returned successfully.
Bad Request, there was an error in the input of the request.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "signing_key_id": "krn:partner:global:notification:signing-key:49bcd37b-79a7-4e6e-b067-2903b45fef42",
- "in_use": false,
- "created_at": "2024-01-01T12:00:00Z"
}
Deletes a specific signing key for the given account.
object Metadata about the integrator and originators of the request, serialized as a valid JSON, to improve troubleshooting. Read more here Example: integration_metadata=[object Object] | |
Partner-Correlation-Id | string <= 255 characters ^[A-Za-z0-9]+$ An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response. |
Signing key deleted successfully.
Bad Request, there was an error in the input of the request.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Conflict, there was a conflict in using the resource. Idempotency violation or concurrent updates to a resource occurred.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "error_id": "5a3f6b9c-9b3b-4b7e-8f9d-9b9a4b9a4b9a",
- "error_type": "INPUT_ERROR",
- "error_code": "INVALID_CONTENT_TYPE",
- "error_message": "The received input is not valid JSON.\nUnterminated string at 19 [character 20 line 1].\n"
}