API Reference
Log In
API Reference

Creating a Refund

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

Required Headers:

  • X-Api-Key
  • X-Auth-Token

Valid values for type parameter:

  • RFD: Duplicate/delayed payment.
  • TNR: Product/service no longer available.
  • QFL: Customer not satisfied.
  • QNR: Product lost/damaged.
  • EWN: Digital download issue.
  • TAN: Event was canceled/changed.
  • PTH: Problem not described above.
Form Data
string
Defaults to required

Mandatory parameter in the body from the second case creation onwards for the payment to prevent duplicate case creations due to replay of APIs

int32
required

Payment ID of the payment against which you're initiating the refund.

string
required

A three letter short-code identifying the reason for this case.

string
Defaults to Paid amount

This field can be used to specify the refund amount. Default is paid amount.

string

Additonal text explaining the refund.

Responses

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