try out ↗

← API Index


/api/driver/refund1

Hand over one or more refund bookings collected by the driver. The refunded lines are passed positionally: for each value of the repeatable position parameter n, the item is given as pid-n and the amount as amount-n. Returns result refundok on success.

Parameters

Name Description Type
cid customer id the refunds belong to int
position position number n of a refunded line; repeatable, one per line int
pid-n refund item id or name for position n string
amount-n refunded amount for position n int
dupcheck uuid guarding against duplicate submissions; a repeated uuid returns result refundduplicate string
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Error Responses

HTTP Status Error Code Description
403 access_error Not authenticated as driver
400 parameter_error Missing cid, or a position without pid-n/amount-n values

Response Types

Type Version Description
DriverActionResult 1 Acknowledgement of a driver action

OpenAPI

See refund1.yaml

Referenced in skills