Skip to content
Merchant API/
/
Update a charge

Update a charge

Request

Update a charge.

Security
bearerAuth or basicAuth
Path
charge_idstringrequired

ID of the charge to update

Bodyapplication/json

Fields to update on a charge.

amountnumber, (double), >= 0

Updated amount for the charge.

Example:1000
invoice_urlstring, (uri)

Updated invoice URL.

Example:"https://example.com/invoice.pdf"
order_numberstring

Updated order number.

Example:"5055"
po_numberstring

Updated PO number.

Example:"PO-555"
metadataobject

Metadata to store on the charge.

Example:
{
  "source": "checkout"
}
user_idstring

Associated customer user ID.

Example:"usr_123"
capturedboolean

Capture this charge.

Example:true
canceledboolean

Cancel this charge.

Example:false
curl -i -X PUT \
  'https://docs.resolvepay.com/_mock/merchant-api/openapi/charges/{charge_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 1000,
    "invoice_url": "https://example.com/invoice.pdf",
    "order_number": "5055",
    "po_number": "PO-555",
    "metadata": {
      "source": "checkout"
    },
    "user_id": "usr_123",
    "captured": true,
    "canceled": false
  }'

Responses

An object representing a charge.

Bodyapplication/json
idstring

Unique identifier for the charge.

Example:"PMMlaE5wbg0"
amountnumber, (double)

Authorized amount of the charge in USD.

Example:1000
customer_idstring

Unique identifier of the customer.

Example:"X50sgfRd"
amount_refundednumber, (double)

Total refunded amount for the charge in USD.

Example:0
canceledboolean

Indicates whether the charge is canceled.

Example:false
canceled_atstring, (date-time)

Date the charge was canceled.

Example:null
capturedboolean

Indicates whether the charge has been captured.

Example:true
captured_atstring, (date-time)

Date the charge was captured.

Example:"2020-01-02T00:00:00.730Z"
created_atstring, (date-time)

Date the charge was created.

Example:"2020-01-01T00:00:00.730Z"
invoice_urlstring, (uri)

URL of the invoice document associated with this charge.

Example:"https://example.com/invoice.pdf"
metadataobject

Custom metadata attached to the charge.

Example:
{
  "source": "checkout"
}
numberstring

Charge number identifier.

Example:"ch_100001"
termsstring

Payment terms associated with the charge.

Enum:"due_upon_receipt""net7""net10""net10th""net15""net20""net30""net45""net60""net75"
Example:"net30"
updated_atstring, (date-time)

Date the charge was last updated.

Example:"2020-01-02T00:00:00.730Z"
merchant_invoice_idstring

ID of the merchant invoice associated with the charge.

Example:"INabc123"
order_numberstring

Order number associated with the charge.

Example:"5055"
po_numberstring

PO number associated with the charge.

Example:"PO-555"
feenumber, (double)

Fee amount associated with the charge in USD.

Example:25.5
fee_refundednumber, (double)

Refunded fee amount for the charge in USD.

Example:0
Response
{
  "id": "PMMlaE5wbg0",
  "amount": 1000,
  "customer_id": "X50sgfRd",
  "amount_refunded": 0,
  "canceled": false,
  "canceled_at": null,
  "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,
  "fee_refunded": 0
}