REresolvepay
Charges

Cancel a charge

Cancel an existing charge.

post/charges/{charge_id}/cancel

Request

Path parameters

charge_idstring required

ID of the charge to cancel

Response

An object representing a charge.

idstring

Unique identifier for the charge.

amountnumber double

Authorized amount of the charge in USD.

customer_idstring

Unique identifier of the customer.

amount_refundednumber double

Total refunded amount for the charge in USD.

canceledboolean

Indicates whether the charge is canceled.

canceled_atstring date-time

Date the charge was canceled.

capturedboolean

Indicates whether the charge has been captured.

captured_atstring date-time

Date the charge was captured.

created_atstring date-time

Date the charge was created.

invoice_urlstring uri

URL of the invoice document associated with this charge.

metadataobject

Custom metadata attached to the charge.

numberstring

Charge number identifier.

terms'due_upon_receipt' | 'net7' | 'net10' | 'net10th' | 'net15' | 'net20' | 'net30' | 'net45' | 'net60' | 'net75' | 'net90' | 'net120' | 'net180'

Payment terms associated with the charge.

updated_atstring date-time

Date the charge was last updated.

merchant_invoice_idstring

ID of the merchant invoice associated with the charge.

order_numberstring

Order number associated with the charge.

po_numberstring

PO number associated with the charge.

feenumber double

Fee amount associated with the charge in USD.

fee_refundednumber double

Refunded fee amount for the charge in USD.

Example response

{
  "id": "PMMlaE5wbg0",
  "amount": 1000,
  "customer_id": "X50sgfRd",
  "captured": true,
  "captured_at": "2020-01-02T00:00:00.730Z",
  "created_at": "2020-01-01T00:00:00.730Z",
  "invoice_url": "https://example.com/invoice.pdf",
  "metadata": {
    "source": "checkout"
  },
  "number": "ch_100001",
  "terms": "net30",
  "updated_at": "2020-01-02T00:00:00.730Z",
  "merchant_invoice_id": "INabc123",
  "order_number": "5055",
  "po_number": "PO-555",
  "fee": 25.5
}

Changes

No recorded changes to this operation across all 1 revision of this API.