GET /charges/:id/refunds — samcart-public-api

Charges

Retrieve all refunds on a charge

get/charges/{id}/refunds

Path parameters

idinteger required

The SamCart ID for the charge

Response

Successful operation. Response will return an array of 0 or more refunds

idinteger

The SamCart ID for the refund

charge_idinteger

The SamCart ID for the charge

cart_item_idinteger

The ID for the refunded cart item

created_atstring date-time

The UTC date and time the refund was issued

test_modeboolean

Indicates whether the transaction was done while the transaction was in test mode.

charge_refund_status'refunded' | 'partially_refunded' nullable

Indicates whether a refund and the type of refund. If no refund was created the value will be null.

currencystring

This will match the currency that the original charge was created in and will be the currency of the created refund

refund_amountinteger

The total refund amount (in cents)

remaining_refundable_amountinteger

The remaining refundable amount on the charge after this refund (in cents)

Example response

[
  {
    "id": 1337,
    "charge_id": 1337,
    "cart_item_id": 1234,
    "created_at": "2020-03-04 00:18:35",
    "test_mode": true,
    "charge_refund_status": "refunded",
    "currency": "USD",
    "refund_amount": 1525,
    "remaining_refundable_amount": 7500,
    "charge": {
      "charge_date": "2021-03-08 00:18:35",
      "test_mode": true,
      "processor_transaction_id": "H241L4ZX",
      "currency": "USD",
      "card_used": "4242",
      "paypal_email": "my_paypal@email.com"
    },
    "order": {
      "test_mode": true
    }
  }
]

Changes

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