Home
API Reference

Create Refund

post
https://zip.co/nz/api/order//refund

This resource performs a full or partial refund

The resource is idempotent if a unique Idempotency-Key header is provided

Path Params
string
required

The orderId to apply the refund to

Body Params
double
required

The refund amount. The refund amount can not exceed the associated order

string
required

The merchant's refund reference

Headers
string

The Idempotency-Key is a unique random string for each request. If a request times out or provides invalid response you can attempt to repeat exact same request with same idempotency key to avoid any duplication.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 12 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 12 months ago