Refunds

Issue a full or partial refund against a succeeded charge. Refunds reach back to the original transaction at the payment provider and trigger a confirmation email to the customer.

POST/v1/refunds

Refund some or all of a charge. The charge's refunded_amount is incremented on success.

Body Parameters

Name	Type		Description
`charge`	string	required	The charge id being refunded.
`amount`	number	required	Amount to refund in the smallest currency unit. Must be positive and must not exceed the remaining chargeable balance.
`reason`	string		Reason tag. One of "requested_by_customer", "duplicate", "fraudulent".
`metadata`	object		Set of key-value pairs you can attach to the object for your own use. Returned as-is on retrieval.

Request

curl -X POST "https://api.ching.co.il/v1/refunds" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "charge": "example_charge",
  "amount": 0,
  "reason": "example_reason",
  "metadata": {}
}'

Response

{
  "success": true,
  "data": {
    "id": "re_qwZHVJfpnKZR",
    "object": "refund",
    "charge": "ch_9mTPfRSDmEOU",
    "amount": 9900,
    "currency": "ils",
    "reason": "requested_by_customer",
    "status": "succeeded",
    "metadata": {},
    "livemode": false,
    "created": "2026-04-19T10:02:11.000Z"
  }
}

GET/v1/refunds

List the 100 most recent refunds, newest first.

Request

curl -X GET "https://api.ching.co.il/v1/refunds" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": [
    {
      "id": "re_qwZHVJfpnKZR",
      "object": "refund",
      "charge": "ch_9mTPfRSDmEOU",
      "amount": 9900,
      "currency": "ils",
      "reason": "requested_by_customer",
      "status": "succeeded",
      "metadata": {},
      "livemode": false,
      "created": "2026-04-19T10:02:11.000Z",
      "customer_name": "Tal Levi"
    }
  ]
}

GET/v1/refunds/:id

Retrieve a refund by its id.

Path Parameters

Name	Type		Description
`id`	string	required	The refund id (e.g. re_qwZHVJfpnKZR).

Request

curl -X GET "https://api.ching.co.il/v1/refunds/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": {
    "id": "re_qwZHVJfpnKZR",
    "object": "refund",
    "charge": "ch_9mTPfRSDmEOU",
    "amount": 9900,
    "currency": "ils",
    "reason": "requested_by_customer",
    "status": "succeeded",
    "metadata": {},
    "livemode": false,
    "created": "2026-04-19T10:02:11.000Z"
  }
}