> For the complete documentation index, see [llms.txt](https://docs.toomuchmedia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toomuchmedia.com/api/api-endpoints/payment/api-payment-payvia-rule.md).

# /api/payment/payvia‑rule

## GET /api/payment/payvia-rule

> \--notset--

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/payvia-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_payment_payvia-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["payviaid","ruleid"]}}},"paths":{"/api/payment/payvia-rule":{"get":{"description":"--notset--","tags":["/api/payment/payvia-rule"],"parameters":[{"name":"payviaid","in":"query","schema":{"type":"integer"},"required":true},{"name":"ruleid","in":"query","schema":{"type":"string","pattern":"/^[0-9]+:[0-9]+:[0-9]+$/"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_payment_payvia-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_payment_payvia-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_payment_payvia-rule"}}}}}}}}}
```

## POST /api/payment/payvia-rule

> Add new payvia rule

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/payvia-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_payment_payvia-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["payviaid","rule_type"]}}},"paths":{"/api/payment/payvia-rule":{"post":{"description":"Add new payvia rule","tags":["/api/payment/payvia-rule"],"parameters":[{"name":"payviaid","in":"query","schema":{"type":"integer"},"required":true},{"name":"rule_type","in":"query","schema":{"type":"string"},"required":true},{"name":"login","in":"query","schema":{"type":"string"},"required":false},{"name":"country","in":"query","schema":{"type":"string"},"required":false},{"name":"start_time","in":"query","schema":{"default":"NOW","type":"string"},"required":false},{"name":"end_time","in":"query","schema":{"default":"FOREVER","type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_payment_payvia-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_payment_payvia-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_payment_payvia-rule"}}}}}}}}}
```

## DELETE /api/payment/payvia-rule

> Disable payvia rule

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/payvia-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"delete_payment_payvia-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["payviaid","ruleid"]}}},"paths":{"/api/payment/payvia-rule":{"delete":{"description":"Disable payvia rule","tags":["/api/payment/payvia-rule"],"parameters":[{"name":"payviaid","in":"query","schema":{"type":"integer"},"required":true},{"name":"ruleid","in":"query","schema":{"type":"string","pattern":"/^[0-9]+:[0-9]+:[0-9]+$/"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/delete_payment_payvia-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/delete_payment_payvia-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/delete_payment_payvia-rule"}}}}}}}}}
```

## PATCH /api/payment/payvia-rule

> Edit payvia rule

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/payvia-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_payment_payvia-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["payviaid","ruleid","rule_type"]}}},"paths":{"/api/payment/payvia-rule":{"patch":{"description":"Edit payvia rule","tags":["/api/payment/payvia-rule"],"parameters":[{"name":"payviaid","in":"query","schema":{"type":"integer"},"required":true},{"name":"ruleid","in":"query","schema":{"type":"string","pattern":"/^[0-9]+:[0-9]+:[0-9]+$/"},"required":true},{"name":"rule_type","in":"query","schema":{"type":"string"},"required":true},{"name":"login","in":"query","schema":{"type":"string"},"required":false},{"name":"country","in":"query","schema":{"type":"string"},"required":false},{"name":"start_time","in":"query","schema":{"default":"NOW","type":"string"},"required":false},{"name":"end_time","in":"query","schema":{"default":"FOREVER","type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_payment_payvia-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_payment_payvia-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_payment_payvia-rule"}}}}}}}}}
```