Adyen · Schema

TestOutput

PaymentsFinancial ServicesFintech

Properties

Name Type Description
merchantId string Unique identifier of the merchant account that the notification is about.
output string The response your server returned for the test webhook. Your server must respond with **[accepted]** for the test webhook to be successful (`data.status`: **success**). Find out more about [accepting
requestSent string The [body of the notification webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#notification-structure) that was sent to your server.
responseCode string The HTTP response code for your server's response to the test webhook. You can use the value of this field together with the the [`output`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/p
responseTime string The time between sending the test webhook and receiving the response from your server. You can use it as an indication of how long your server takes to process a webhook notification. Measured in mill
status string The status of the test request. Possible values are: * **success**, if `data.output`: **[accepted]** and `data.responseCode`: **200**. * **failed**, in all other cases. You can use the value of the [`
View JSON Schema on GitHub

JSON Schema

adyen-testoutput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TestOutput",
  "title": "TestOutput",
  "properties": {
    "merchantId": {
      "description": "Unique identifier of the merchant account that the notification is about.",
      "type": "string"
    },
    "output": {
      "description": "The response your server returned for the test webhook.\n\nYour server must respond with **[accepted]** for the test webhook to be successful (`data.status`: **success**). Find out more about [accepting notifications](https://docs.adyen.com/development-resources/webhooks#accept-notifications)\n\nYou can use the value of this field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot unsuccessful test webhooks.",
      "type": "string"
    },
    "requestSent": {
      "description": "The [body of the notification webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#notification-structure) that was sent to your server.",
      "type": "string"
    },
    "responseCode": {
      "description": "The HTTP response code for your server's response to the test webhook.\n\nYou can use the value of this field together with the the [`output`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-output) field value to troubleshoot failed test webhooks.",
      "example": "200",
      "type": "string"
    },
    "responseTime": {
      "description": "The time between sending the test webhook and receiving the response from your server. You can use it as an indication of how long your server takes to process a webhook notification. Measured in milliseconds, for example **304 ms**.",
      "type": "string"
    },
    "status": {
      "description": "The status of the test request. Possible values are:\n* **success**, if `data.output`: **[accepted]** and `data.responseCode`: **200**.\n* **failed**, in all other cases.\n\nYou can use the value of the [`output`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-output) field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot failed test webhooks.",
      "type": "string"
    }
  },
  "required": [
    "status"
  ],
  "type": "object"
}