Refund Instore Order

post

https://zip.co/nz/api/pos/order/{id}/refund

Path Params

string

required

orderId returned from Create Order endpoint. Located in the endpoint path.

Body Params

operator

string

required

Defaults to John Smith

Current Point of Sale terminal operator

amount

double

required

Defaults to 50

A decimal value to 2 decimal places that indicates the amount to refund

merchantReference

string

Defaults to reference

The merchant's reference for this refund

Headers

Idempotency-Key

string

Optional idempotency key to allow fail safe retries of the refund operation

partpay-terminalid

string

Uniquely identifies the Point of sale terminal being used as part of this request

store-id

string

When using a merchant level scope this is supplied to give traceability from what store the refund originated

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200200