API Reference
Smartpay Home page日本語

The refund object

Refund objects allow you to refund a payment that has previously been created, but has not yet been fully refunded. Funds will be refunded to the Customer who was originally charged.

Attributes
idstring
Unique identifier for the object
objectstring, value is "refund"
A string representing the object’s type. Objects of the same type share the same value.
amountinteger
The amount of this Refund.
createdAttimestamp
Time at which the object was created. Measured in milliseconds since the Unix epoch.
currencystring
Three-letter ISO currency code, in lowercase. Must be a supported currency.
descriptionstring
An arbitrary - ideally descriptive - long form explanation of the Refund, meant to be displayed to the customer.
lineItemslist of strings
A list of the IDs of the Line Items of the original Payment this Refund is on.
metadatahash
Set of key-value pairs that you can attach to the Refund object.
paymentstring
The ID of the Payment this Refund is on.
reasonenum
The reason of the Refund.
Possible enum values
  • requested_by_customer

    The refund was created due to request from the customer.

  • fraudulent

    The refund was created because the original order was fraudulent

referencestring
A - ideally unique - string to reference the Refund (e.g. a customer ID, a cart ID, etc.) which can be used to reconcile the Refund with your internal systems.
statusenum
The status of the Refund.
Possible enum values
  • succeeded

    The refund was processed successfully.

  • failed

    There was an error processing this refund.

testboolean
A flag with a value false if the object exists in live mode or true if the object exists in test mode.
updatedAttimestamp
Time at which the object was last updated. Measured in milliseconds since the Unix epoch.