Skip to main content

Refunds

Learn more about the Refund resource

A Refund resource represents a refunded amount of a paid payment.

Endpoints​

POST /refunds

The Refund Resource​

{
  "id": "re_ACubtXXN3XNRWpW3W1zQKzLWfs7Zn2sa",
  "resource": "refund",
  "amount": 10000,
  "status": "succeeded",
  "currency": "PHP",
  "description" :"",
  "reason": "others",
  "remarks": "The customer is disappointed about item XYZ.",
  "livemode": false,
  "metadata": null,
  "payment_id": "pay_BsubzXXN3XNRWpW3W1zPKzLWfszn3ssY",
  "created_at": 1700407880,
  "updated_at": 1700407880
}

Attributes​

id string

Unique identifier for the resource. The prefix is re_.

resource string

Represents the resource's type. The value is refund.

amount string

Amount in cents.

status string

The latest status of the Refund. Possible values are succeeded, failed, or pending.

currency string

A three-letter ISO currency code in uppercase. As of the moment, we only support PHP.

description string

An arbitrary string attached to the Refund.

livemode boolean

The value is true if the resource's mode is live or the value is false if the resource is in test mode.

metadata hash

A set of key-value pairs attached to the Refund. This is useful for storing additional information about the Refund.

payment_id string

The ID of the payment to be refunded.

remarks string

Remarks about the Refund resource. This is useful when viewing a refund via PayRex Dashboard.

reason string

The reason of the Refund. Possible values are fraudulent, requested_by_customer, product_out_of_stock, service_not_provided, product_was_damaged, service_misaligned, wrong_product_received, or others.

You can use the remarks attribute to add remarks if the value of the reason is others.

created_at timestamp

The time the resource was created and measured in seconds since the Unix epoch.

updated_at timestamp

The time the resource was updated and measured in seconds since the Unix epoch.