# Models

## The CheckDuplicateTransactionSettingsPayload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"CheckDuplicateTransactionSettingsPayload":{"type":"object","properties":{"check-duplicate-transaction-settings":{"$ref":"#/components/schemas/check-duplicate-transaction-settings"},"payloadType":{"type":"string","description":"Type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"Check duplicate transaction settings","xml":{"name":"payload"}},"check-duplicate-transaction-settings":{"required":["check-merchant-level","enabled","if-duplicate-found-respond-with-error","include-invoice","time-range-in-minutes","use-invoice-instead-of-card"],"type":"object","properties":{"time-range-in-minutes":{"type":"integer","description":"Time window (in minutes) within which transactions are checked for duplication.","format":"int32"},"if-duplicate-found-respond-with-error":{"type":"boolean","description":"System responds with an error when a duplicate transaction is found."},"include-invoice":{"type":"boolean","description":"Invoice number is included in the duplicate check criteria."},"enabled":{"type":"boolean","description":"Duplicate transaction check is enabled for future."},"check-merchant-level":{"type":"boolean","description":"Duplicate transaction checks are performed across all terminals under the merchant."},"use-invoice-instead-of-card":{"type":"boolean","description":"Invoice numbers are used instead of card details for duplicate detection."}},"description":"Check duplicate transaction settings","xml":{"name":"check-duplicate-transaction-settings"}}}}}
```

## The check-duplicate-transaction-settings object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"check-duplicate-transaction-settings":{"required":["check-merchant-level","enabled","if-duplicate-found-respond-with-error","include-invoice","time-range-in-minutes","use-invoice-instead-of-card"],"type":"object","properties":{"time-range-in-minutes":{"type":"integer","description":"Time window (in minutes) within which transactions are checked for duplication.","format":"int32"},"if-duplicate-found-respond-with-error":{"type":"boolean","description":"System responds with an error when a duplicate transaction is found."},"include-invoice":{"type":"boolean","description":"Invoice number is included in the duplicate check criteria."},"enabled":{"type":"boolean","description":"Duplicate transaction check is enabled for future."},"check-merchant-level":{"type":"boolean","description":"Duplicate transaction checks are performed across all terminals under the merchant."},"use-invoice-instead-of-card":{"type":"boolean","description":"Invoice numbers are used instead of card details for duplicate detection."}},"description":"Check duplicate transaction settings","xml":{"name":"check-duplicate-transaction-settings"}}}}}
```

## The ErrorPayload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"ErrorPayload":{"type":"object","properties":{"error-message":{"type":"string","description":"Describes the reason for the error."},"result-code":{"type":"string","description":"Numeric code that identifies the type of error returned by the request."},"time-stamp":{"type":"string","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"xml":{"name":"error"}}}}}
```

## The ErrorPayloadResponsePayload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"ErrorPayloadResponsePayload":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorPayload"},"payloadType":{"type":"string","description":"Type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"Payload","xml":{"name":"payload"}},"ErrorPayload":{"type":"object","properties":{"error-message":{"type":"string","description":"Describes the reason for the error."},"result-code":{"type":"string","description":"Numeric code that identifies the type of error returned by the request."},"time-stamp":{"type":"string","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"xml":{"name":"error"}}}}}
```

## The TerminalSettingsPayload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"TerminalSettingsPayload":{"type":"object","properties":{"terminal-settings":{"$ref":"#/components/schemas/terminal-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"terminal-settings":{"type":"object","properties":{"merchant-name":{"type":"string","description":"Name of the merchant associated with the terminal."},"merchant-id":{"type":"string","description":"Unique identifier assigned to the merchant."},"terminal-name":{"type":"string","description":"Name for the terminal location."},"terminal-id":{"type":"string","description":"Unique identifier for the payment terminal."},"commerce-type":{"type":"string","description":"Type of commerce the terminal is used for. For example, ECOMMERCE, RETAIL."},"enable-tip":{"type":"boolean","description":"Indicates whether tipping is enabled on the terminal."},"time-zone":{"type":"string","description":"Time zone setting for the terminal. For example, Central/US."},"batch-time-utc":{"type":"string","description":"Time (in UTC) when the terminal batch is automatically closed. Format: HH:mm."},"enable-auto-close-batch":{"type":"boolean","description":"Indicates whether the terminal automatically closes batches at the set time."},"service-fee":{"type":"string","description":"Service fee applied to transactions (value format may vary)."},"service-fee-type":{"type":"string","description":"Specifies the type of service fee. For example, fixed, percentage."},"service-fee-state":{"type":"string","description":"State where the service fee program is applicable."},"service-fee-program-type":{"type":"string","description":"Type of service fee program the merchant is enrolled in."},"business-phone":{"type":"string","description":"Phone number associated with the merchant's business."},"mcc":{"type":"string","description":"Merchant Category Code (MCC) assigned to the terminal."}},"description":"terminal-settings","xml":{"name":"terminal-settings"}}}}}
```

## The terminal-settings object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"terminal-settings":{"type":"object","properties":{"merchant-name":{"type":"string","description":"Name of the merchant associated with the terminal."},"merchant-id":{"type":"string","description":"Unique identifier assigned to the merchant."},"terminal-name":{"type":"string","description":"Name for the terminal location."},"terminal-id":{"type":"string","description":"Unique identifier for the payment terminal."},"commerce-type":{"type":"string","description":"Type of commerce the terminal is used for. For example, ECOMMERCE, RETAIL."},"enable-tip":{"type":"boolean","description":"Indicates whether tipping is enabled on the terminal."},"time-zone":{"type":"string","description":"Time zone setting for the terminal. For example, Central/US."},"batch-time-utc":{"type":"string","description":"Time (in UTC) when the terminal batch is automatically closed. Format: HH:mm."},"enable-auto-close-batch":{"type":"boolean","description":"Indicates whether the terminal automatically closes batches at the set time."},"service-fee":{"type":"string","description":"Service fee applied to transactions (value format may vary)."},"service-fee-type":{"type":"string","description":"Specifies the type of service fee. For example, fixed, percentage."},"service-fee-state":{"type":"string","description":"State where the service fee program is applicable."},"service-fee-program-type":{"type":"string","description":"Type of service fee program the merchant is enrolled in."},"business-phone":{"type":"string","description":"Phone number associated with the merchant's business."},"mcc":{"type":"string","description":"Merchant Category Code (MCC) assigned to the terminal."}},"description":"terminal-settings","xml":{"name":"terminal-settings"}}}}}
```

## The RpsSettingsPayload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"RpsSettingsPayload":{"type":"object","properties":{"rps-settings":{"$ref":"#/components/schemas/rps-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"Contains the response data for the terminal's RPS configuration.","xml":{"name":"payload"}},"rps-settings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether the Recurring Payment Service (RPS) is enabled for the terminal.","enum":[true,false]}},"description":"Contains Recurring Payment Service configuration for the terminal.","xml":{"name":"rps-settings"}}}}}
```

## The rps-settings object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"rps-settings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether the Recurring Payment Service (RPS) is enabled for the terminal.","enum":[true,false]}},"description":"Contains Recurring Payment Service configuration for the terminal.","xml":{"name":"rps-settings"}}}}}
```

## The ReportSettingsPayload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"ReportSettingsPayload":{"type":"object","properties":{"report-settings":{"$ref":"#/components/schemas/report-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"report-settings":{"required":["enabled","report-time","type"],"type":"object","properties":{"report-time":{"type":"string","description":"Time of day when the report should be generated and sent in the HH:mm:ss format"},"enabled":{"type":"boolean","description":"Indicates whether the report setting is active.","enum":[true,false]},"type":{"type":"string","description":"Type of report to be generated.","enum":["LAST_CLOSED_BATCH","LAST_CLOSED_BATCH"]},"emails":{"$ref":"#/components/schemas/emails"}},"description":"report settings","xml":{"name":"report-settings"}},"emails":{"type":"object","properties":{"email":{"type":"array","description":"Array of email objects.","items":{"$ref":"#/components/schemas/address"}}},"description":"Contains a list of email addresses to receive the report.","xml":{"name":"emails"}},"address":{"required":["address"],"type":"object","properties":{"address":{"type":"string","description":"Email address to which the report will be sent."}},"description":"Array of email objects.","xml":{"name":"address"}}}}}
```

## The address object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"address":{"required":["address"],"type":"object","properties":{"address":{"type":"string","description":"Email address to which the report will be sent."}},"description":"Array of email objects.","xml":{"name":"address"}}}}}
```

## The emails object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"emails":{"type":"object","properties":{"email":{"type":"array","description":"Array of email objects.","items":{"$ref":"#/components/schemas/address"}}},"description":"Contains a list of email addresses to receive the report.","xml":{"name":"emails"}},"address":{"required":["address"],"type":"object","properties":{"address":{"type":"string","description":"Email address to which the report will be sent."}},"description":"Array of email objects.","xml":{"name":"address"}}}}}
```

## The report-settings object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"report-settings":{"required":["enabled","report-time","type"],"type":"object","properties":{"report-time":{"type":"string","description":"Time of day when the report should be generated and sent in the HH:mm:ss format"},"enabled":{"type":"boolean","description":"Indicates whether the report setting is active.","enum":[true,false]},"type":{"type":"string","description":"Type of report to be generated.","enum":["LAST_CLOSED_BATCH","LAST_CLOSED_BATCH"]},"emails":{"$ref":"#/components/schemas/emails"}},"description":"report settings","xml":{"name":"report-settings"}},"emails":{"type":"object","properties":{"email":{"type":"array","description":"Array of email objects.","items":{"$ref":"#/components/schemas/address"}}},"description":"Contains a list of email addresses to receive the report.","xml":{"name":"emails"}},"address":{"required":["address"],"type":"object","properties":{"address":{"type":"string","description":"Email address to which the report will be sent."}},"description":"Array of email objects.","xml":{"name":"address"}}}}}
```

## The PayLinkPayload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"PayLinkPayload":{"type":"object","properties":{"paylink":{"$ref":"#/components/schemas/paylink"},"payloadType":{"type":"string","description":"Type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"paylink":{"required":["cancel-url","enabled","metadata","success-url","terminalId"],"type":"object","properties":{"terminalId":{"type":"integer","description":"Identifier for the terminal associated with the Paylink settings.","format":"int64"},"enabled":{"type":"boolean","description":"Indicates whether Paylink settings are enabled (true) or disabled (false).","enum":[true,false]},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Optional key-value pairs for storing additional custom metadata."},"description":"Optional key-value pairs for storing additional custom metadata."},"success-url":{"type":"string","description":"URL to redirect the user after a successful payment."},"cancel-url":{"type":"string","description":"URL to redirect the user if the payment is canceled."}},"description":"Contains the paylink configuration settings for the terminal.","xml":{"name":"paylink"}}}}}
```

## The paylink object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"paylink":{"required":["cancel-url","enabled","metadata","success-url","terminalId"],"type":"object","properties":{"terminalId":{"type":"integer","description":"Identifier for the terminal associated with the Paylink settings.","format":"int64"},"enabled":{"type":"boolean","description":"Indicates whether Paylink settings are enabled (true) or disabled (false).","enum":[true,false]},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Optional key-value pairs for storing additional custom metadata."},"description":"Optional key-value pairs for storing additional custom metadata."},"success-url":{"type":"string","description":"URL to redirect the user after a successful payment."},"cancel-url":{"type":"string","description":"URL to redirect the user if the payment is canceled."}},"description":"Contains the paylink configuration settings for the terminal.","xml":{"name":"paylink"}}}}}
```

## The hpp-settings object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"hpp-settings":{"required":["enabled","hpp-domain","hpp-public-key"],"type":"object","properties":{"hpp-public-key":{"type":"string","description":"Public key used to encrypt payment data on the Hosted Payment Page."},"enabled":{"type":"boolean","description":"Indicates whether the Hosted Payment Page (HPP) settings are enabled for the terminal. Set true (enable) or false (disable).","enum":[true,false]},"hpp-domain":{"type":"string","description":"HTTPS domain URL where the Hosted Payment Page is hosted."}},"description":"Contains the Hosted Payment Page configuration details for the terminal.","xml":{"name":"hpp-settings"}}}}}
```

## The hpp-settings-payload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"hpp-settings-payload":{"type":"object","properties":{"hpp-settings":{"$ref":"#/components/schemas/hpp-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"hpp-settings":{"required":["enabled","hpp-domain","hpp-public-key"],"type":"object","properties":{"hpp-public-key":{"type":"string","description":"Public key used to encrypt payment data on the Hosted Payment Page."},"enabled":{"type":"boolean","description":"Indicates whether the Hosted Payment Page (HPP) settings are enabled for the terminal. Set true (enable) or false (disable).","enum":[true,false]},"hpp-domain":{"type":"string","description":"HTTPS domain URL where the Hosted Payment Page is hosted."}},"description":"Contains the Hosted Payment Page configuration details for the terminal.","xml":{"name":"hpp-settings"}}}}}
```

## The device object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"device":{"type":"object","properties":{"manufacturer":{"type":"string","description":"Name of the device manufacturer associated with the terminal.","enum":["PAX,DEJAVOO"]},"enabled":{"type":"boolean","description":"Indicates whether the device configuration are enabled for terminals (true) or disabled (false).","enum":[false]},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Contains key-value metadata of device configuration."},"description":"Contains key-value metadata of device configuration."},"device-api-key":{"type":"string","description":"API key used to authenticate and associate the device with the system."}},"description":"Contains the terminal device configuration settings.","xml":{"name":"device"}}}}}
```

## The payload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"payload":{"type":"object","properties":{"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}},"device":{"$ref":"#/components/schemas/device"}},"xml":{"name":"payload"}},"device":{"type":"object","properties":{"manufacturer":{"type":"string","description":"Name of the device manufacturer associated with the terminal.","enum":["PAX,DEJAVOO"]},"enabled":{"type":"boolean","description":"Indicates whether the device configuration are enabled for terminals (true) or disabled (false).","enum":[false]},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Contains key-value metadata of device configuration."},"description":"Contains key-value metadata of device configuration."},"device-api-key":{"type":"string","description":"API key used to authenticate and associate the device with the system."}},"description":"Contains the terminal device configuration settings.","xml":{"name":"device"}}}}}
```

## The CscSettingsPayload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"CscSettingsPayload":{"type":"object","properties":{"csc-settings":{"$ref":"#/components/schemas/csc-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"csc-settings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether CSC validation is enabled (true) or disabled (false).","enum":[true,false]},"response-filters":{"$ref":"#/components/schemas/response-filters"}},"description":"Contains configuration details for CSC (Card Security Code) settings.","xml":{"name":"csc-settings"}},"response-filters":{"type":"object","properties":{"response-filter":{"type":"array","description":"List of response filter rules. Each Object defines behavior for a specific response code.","items":{"$ref":"#/components/schemas/ResponseFilterDto"}}},"description":"Container for AVS response filter configurations.","xml":{"name":"response-filters"}},"ResponseFilterDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the filter type.","enum":["AVS","CSC"]},"allowed":{"type":"boolean","description":"Specifies whether transactions with this response code are allowed."},"description":{"type":"string","description":"Description of the response code."},"response-code":{"type":"string","description":"Response code to match. For example, \"N\" for no match."}},"description":"List of response filter rules. Each Object defines behavior for a specific response code."}}}}
```

## The ResponseFilterDto object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"ResponseFilterDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the filter type.","enum":["AVS","CSC"]},"allowed":{"type":"boolean","description":"Specifies whether transactions with this response code are allowed."},"description":{"type":"string","description":"Description of the response code."},"response-code":{"type":"string","description":"Response code to match. For example, \"N\" for no match."}},"description":"List of response filter rules. Each Object defines behavior for a specific response code."}}}}
```

## The csc-settings object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"csc-settings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether CSC validation is enabled (true) or disabled (false).","enum":[true,false]},"response-filters":{"$ref":"#/components/schemas/response-filters"}},"description":"Contains configuration details for CSC (Card Security Code) settings.","xml":{"name":"csc-settings"}},"response-filters":{"type":"object","properties":{"response-filter":{"type":"array","description":"List of response filter rules. Each Object defines behavior for a specific response code.","items":{"$ref":"#/components/schemas/ResponseFilterDto"}}},"description":"Container for AVS response filter configurations.","xml":{"name":"response-filters"}},"ResponseFilterDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the filter type.","enum":["AVS","CSC"]},"allowed":{"type":"boolean","description":"Specifies whether transactions with this response code are allowed."},"description":{"type":"string","description":"Description of the response code."},"response-code":{"type":"string","description":"Response code to match. For example, \"N\" for no match."}},"description":"List of response filter rules. Each Object defines behavior for a specific response code."}}}}
```

## The response-filters object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"response-filters":{"type":"object","properties":{"response-filter":{"type":"array","description":"List of response filter rules. Each Object defines behavior for a specific response code.","items":{"$ref":"#/components/schemas/ResponseFilterDto"}}},"description":"Container for AVS response filter configurations.","xml":{"name":"response-filters"}},"ResponseFilterDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the filter type.","enum":["AVS","CSC"]},"allowed":{"type":"boolean","description":"Specifies whether transactions with this response code are allowed."},"description":{"type":"string","description":"Description of the response code."},"response-code":{"type":"string","description":"Response code to match. For example, \"N\" for no match."}},"description":"List of response filter rules. Each Object defines behavior for a specific response code."}}}}
```

## The AvsSettingsPayload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"AvsSettingsPayload":{"type":"object","properties":{"avs-settings":{"$ref":"#/components/schemas/avs-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"avs-settings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether AVS (Address Verification Service) settings are enabled (true) or disabled (false).","enum":[true,false]},"response-filters":{"$ref":"#/components/schemas/response-filters"}},"description":"AVS Settings details.","xml":{"name":"avs-settings"}},"response-filters":{"type":"object","properties":{"response-filter":{"type":"array","description":"List of response filter rules. Each Object defines behavior for a specific response code.","items":{"$ref":"#/components/schemas/ResponseFilterDto"}}},"description":"Container for AVS response filter configurations.","xml":{"name":"response-filters"}},"ResponseFilterDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the filter type.","enum":["AVS","CSC"]},"allowed":{"type":"boolean","description":"Specifies whether transactions with this response code are allowed."},"description":{"type":"string","description":"Description of the response code."},"response-code":{"type":"string","description":"Response code to match. For example, \"N\" for no match."}},"description":"List of response filter rules. Each Object defines behavior for a specific response code."}}}}
```

## The avs-settings object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"avs-settings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether AVS (Address Verification Service) settings are enabled (true) or disabled (false).","enum":[true,false]},"response-filters":{"$ref":"#/components/schemas/response-filters"}},"description":"AVS Settings details.","xml":{"name":"avs-settings"}},"response-filters":{"type":"object","properties":{"response-filter":{"type":"array","description":"List of response filter rules. Each Object defines behavior for a specific response code.","items":{"$ref":"#/components/schemas/ResponseFilterDto"}}},"description":"Container for AVS response filter configurations.","xml":{"name":"response-filters"}},"ResponseFilterDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the filter type.","enum":["AVS","CSC"]},"allowed":{"type":"boolean","description":"Specifies whether transactions with this response code are allowed."},"description":{"type":"string","description":"Description of the response code."},"response-code":{"type":"string","description":"Response code to match. For example, \"N\" for no match."}},"description":"List of response filter rules. Each Object defines behavior for a specific response code."}}}}
```

## The alert-settings object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"alert-settings":{"type":"object","properties":{"merchantId":{"type":"string","description":"Merchant identifier associated with the alert settings."},"terminalId":{"type":"string","description":"Terminal identifier associated with the alert settings."},"emails":{"type":"string","description":"Email address to receive transaction alerts."},"callbackUrl":{"type":"string","description":"URL to which transaction result notifications are sent."}},"xml":{"name":"alert-settings"}}}}}
```

## The transactionAlertSettingsPayload object

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"components":{"schemas":{"transactionAlertSettingsPayload":{"type":"object","properties":{"alert-settings":{"$ref":"#/components/schemas/alert-settings"},"payloadType":{"type":"string","description":"Type of payload returned.","xml":{"name":"type","attribute":true}}},"description":"Transaction alert configuration details.","xml":{"name":"payload"}},"alert-settings":{"type":"object","properties":{"merchantId":{"type":"string","description":"Merchant identifier associated with the alert settings."},"terminalId":{"type":"string","description":"Terminal identifier associated with the alert settings."},"emails":{"type":"string","description":"Email address to receive transaction alerts."},"callbackUrl":{"type":"string","description":"URL to which transaction result notifications are sent."}},"xml":{"name":"alert-settings"}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.