> 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-payviarule.md).

# /api/payment/payviarule

## GET /api/payment/payviarule

> Get rules for a specific payvia type (legacy)

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/payviarule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_payment_payviarule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["payvia_type_id"]}}},"paths":{"/api/payment/payviarule":{"get":{"description":"Get rules for a specific payvia type (legacy)","tags":["/api/payment/payviarule"],"parameters":[{"name":"payvia_type_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"rule_type","in":"query","schema":{},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_payment_payviarule"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_payment_payviarule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_payment_payviarule"}}}}}}}}}
```

## PATCH /api/payment/payviarule

> Create/Modify rules for payvia types

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/payviarule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_payment_payviarule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["loginid","action","type"]}}},"paths":{"/api/payment/payviarule":{"patch":{"description":"Create/Modify rules for payvia types","tags":["/api/payment/payviarule"],"parameters":[{"name":"loginid","in":"query","schema":{},"required":true},{"name":"action","in":"query","schema":{},"required":true},{"name":"type","in":"query","schema":{},"required":true},{"name":"payvia_rule_id","in":"query","schema":{"default":0},"required":false},{"name":"payvia_type_id","in":"query","schema":{"default":0},"required":false},{"name":"country","in":"query","schema":{},"required":false},{"name":"start_time","in":"query","schema":{"default":0},"required":false},{"name":"end_time","in":"query","schema":{"default":0},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_payment_payviarule"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_payment_payviarule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_payment_payviarule"}}}}}}}}}
```