> 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-dump-format.md).

# /api/payment/dump‑format

## GET /api/payment/dump-format

> Get dump format

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/dump-format"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_payment_dump-format":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["dumpid"]}}},"paths":{"/api/payment/dump-format":{"get":{"description":"Get dump format","tags":["/api/payment/dump-format"],"parameters":[{"name":"dumpid","in":"query","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_payment_dump-format"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_payment_dump-format"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_payment_dump-format"}}}}}}}}}
```

## POST /api/payment/dump-format

> Add new payvia dump format

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/dump-format"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_payment_dump-format":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["name"]}}},"paths":{"/api/payment/dump-format":{"post":{"description":"Add new payvia dump format","tags":["/api/payment/dump-format"],"parameters":[{"name":"name","in":"query","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_payment_dump-format"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_payment_dump-format"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_payment_dump-format"}}}}}}}}}
```

## PATCH /api/payment/dump-format

> Edit payvia dump format

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/payment/dump-format"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_payment_dump-format":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"paths":{"/api/payment/dump-format":{"patch":{"description":"Edit payvia dump format","tags":["/api/payment/dump-format"],"parameters":[{"name":"dump","in":"query","schema":{"type":"string"},"required":false},{"name":"dumpid","in":"query","schema":{"type":"integer"},"required":false},{"name":"name","in":"query","schema":{"type":"string"},"required":false},{"name":"header","in":"query","schema":{"type":"string"},"required":false},{"name":"entryheader","in":"query","schema":{"type":"string"},"required":false},{"name":"entry","in":"query","schema":{"type":"string"},"required":false},{"name":"entryfooter","in":"query","schema":{"type":"string"},"required":false},{"name":"footer","in":"query","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_payment_dump-format"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_payment_dump-format"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_payment_dump-format"}}}}}}}}}
```