Create a Refund

post

https://api.tap.company/v2/refunds/

Creating a refund request

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Payment reference will be controlled with "charge_id: "chg_xxxxxxxxxxxxx".

API allows to control the amount. Either a full or Partial.

A justified reason should be added in the API call to avoid any future confusion about the refund.

Body Params

charge_id

string

required

Defaults to chg_TS02A1720241236y4M42101629

Original Charge ID, provided in the Charge API request

amount

int32

required

Defaults to 10

Refund amount (For currencies BHD, KWD, and OMR, amount should be specified with up to 3 decimal places. For others, amount should be specified with up to 2 decimal places)

currency

string

required

Defaults to KWD

Currency code, Three digit ISO code (KWD, USD,..)

reason

string

required

Defaults to The product is out of stock

Reason for refund (possible values are duplicate, fraudulent, and requested_by_customer)

destinations

object

If you are marketplace and you want to send refund request by adding the destinations object

post

object

The Webhook URL. After refund is completed, Tap will POST the response payload as a raw data to this URL.

metadata

object

The set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

reference

object

The reference numbers related to the charge.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400