GuidesAPI Reference
API Reference

/order/{orderId}/refund

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

Creates a refund in Zip

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The OrderId is the Zip identifier for an order. This is issued when creating an order and is also passed on the redirect confirmation URL as the 'token' parameter.

Body Params
float
required

The refund amount. Cannot exceed the captured Order Amount minus any existing Refunds.

string
required

Merchant generated unique ID for this refund request used as an idempotency key. We suggest using a GUID here.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 4 years ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json
text/plain

Updated over 4 years ago