Cancels

The cancel resource represents and is used to create a cancellation on a charge with a status that is either awaiting or authorized. This can happen when a charge is made with the convienence store payment method or when an authorization on a credit card (including Apple Pay) is made.

For charges that are successful, please refer to refunds instead.

The cancel object

Fields
id	string (UUID) The cancel object
store_id	string (UUID) The id of the store the cancel is created for.
charge_id	string (UUID) The id of the charge the cancel is created for.
status	string The status of the cancellation. One of pending, successful, failed or error.
error.code	string The error code of why a charge failed or errored.
error.message	string A short description of why a a charge failed
error.detail	string Additional details of why a charge failed
metadata	json Any user defined metadata associated with the cancel.
mode	string live or test.
created_on	string (ISO-8601) The date the refund was created on.