create refund

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 64
^[A-Za-z0-9_~.-]{1,64}$

Supplied unique identifier for refund, maximum 64 characters containing only unreserved characters as defined in RFC3986. This identifier ensures refund uniqueness between integrator systems and Zepto.

string
required
length between 1 and 64
^[A-Za-z0-9\-._~]+$

The supplied UID related to the PayTo Payment to be refunded

refund_payment
required

Describes the payment that will be used to facilitate this refund

metadata
object | null

Use for your custom data. A place to store any miscellaneous information your system may need in regards to the record you are creating. This will be included in associated webhook payloads under the resource_metadata key. Nested values (i.e., objects and arrays) are not allowed. The maximum size of this parameter is 2kb.

sandbox
object

SANDBOX ONLY: Parameter that allows you to simulate the created refund going through certain scenarios to aid integrators while testing their control flows. Defaults to success if not given.

Headers
string
^\d{8}$
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

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