Refund Object

Object

{
  "id": "rfd_afiuabfia23wifaiofnioa12nfianf",
  "object": "refund",
  "payin": "chk_cirsp2sl4ar024j0akj0",
  "amount": 90000,
  "currency": "USD",
  "customer_receives": {
      "currency": "SGD",
      "amount": 133200
    },
  "payment_attempt": "pat_ahbfiuahfiuaiofnioain",
  "reason": "Damaged Goods",
  "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
  "status": "succeeded",
  "status_description": "",
  "webhook_url": "https://mystore.webhook.tazapay.refund/",
  "created_at": "2023-07-23 23:59:56"
}

Parameters

Refund

FieldSubfieldTypeDescription
idstringThe unique Tazapay identifier for the refund.
objectstringThe type of object, which is "refund".
payinstringThe unique Tazapay ID of the related payin transaction.
amountnumberThe total amount being refunded.
currencystringThe currency in which the refund was made (e.g., USD).
customer_receivesobjectThe amount and currency received by the customer after the refund.
currencystringThe currency in which the customer receives the refund.
amountnumberThe amount the customer receives after the refund.
payment_attemptstringThe unique Tazapay ID of the payment attempt associated with the refund.
reasonstringThe reason for the refund (e.g., "Damaged Goods").
metadatajsonSet of key-value pairs attached to the refund object.
statusenumThe current status of the refund [Values - Requested, Pending, Initiated, Succeeded, Failed, Rejected]
status_descriptionstringA description of the current refund status.
webhook_urlstringThe URL for webhook notifications related to the refund.
created_atstring (ISO timestamp)The timestamp when the refund was created.