API Reference

Refund a captured payment

post
http://localhost/v1/checkout//refund

Omit amount to refund in full. Send idempotencyKey so a timed-out call is safe to retry.

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

Why the refund was issued. Shown to the shopper.

SubunitMoney | null

Omit to refund the full remaining amount.

string | null

Your own key for this refund. Re-sending it returns the refund already made instead of making a second one, so a timed-out call is safe to retry. Without it, a retry refunds twice.

Responses

Updated about 3 hours ago

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

Updated about 3 hours ago