Refunds

Refund all or part of an approved charge.

POST /refund refunds an approved charge, identified by its charge ID. Refunds can be partial or for the full amount, and are in the original charge’s currency.

curl https://api-sandbox.paychoice.com.au/api/v5/refund \
  -u "$PAYCHOICE_USERNAME:$PAYCHOICE_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{
    "charge_id": "f33a990c-237c-4e88-9bd1-eb2d655bb88c",
    "amount": "10.00",
    "reference": "REFUND-INV-4325454"
  }'

charge_id · uuid · required

The id returned when the charge was created.

amount · decimal · required

Amount to refund, up to the original charge amount.

reference · string

Your unique reference for the refund.

merchant_guid · uuid

Required for agency credentials.

{
  "refund": {
    "id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "reference": "REFUND-INV-4325454",
    "amount": 10.0,
    "status": "Approved",
    "status_code": 0,
    "error": "Transaction Approved",
    "error_code": "00",
    "created": "2026-11-04T03:02:11.402Z",
    "merchantguid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
    "aggregator_reference": "123456789013",
    "meta_data_reference": null,
    "link": { "href": "/api/v5/refund/a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "rel": "self" }
  },
  "object_type": "refund",
  "from_item": 0,
  "to_item": 0,
  "total_count": 0
}

id · uuid

The refund ID.

amount · number

The amount refunded. A number on this endpoint.

status_code · integer

0 Approved, 4 Blocked, 5 Dishonoured, 6 Errored, 9 Processing.

A refund also triggers a webhook notification with a refund object and object_type: "refund".