Home
API Reference
  1. Web Checkouts API
  2. API Reference

Create a refund

post
https://sand.merchant-api.com/merchant/refunds

Once a charge has been captured, if a customer wishes to return an item you will need to create a refund.

Useful notes

  • Partial refunds are accepted.
  • All refunds must have a value less that the original charge and outstanding balance to be refunded.
    • The Create Refund response

    • id STRING

      Unique refund ID

    • charge_id STRING

      This is the charge_id associated to the refund

    • reason STRING

      Refund reason

    • amount DOUBLE

      Refund amount

    • created_date STRING

      The date on which the refund was created

    Body Params
    string
    required

    Zip transaction charge ID to apply the refund.

    string
    required

    Unique transaction reference.

    string
    required

    Reason of the refund.

    double

    Refund amount.

    Responses

    Updated 6 days ago

    Language
    Credentials
    Header
    LoadingLoading…
    Response
    Click Try It! to start a request and see the response here! Or choose an example:
    application/json

    Updated 6 days ago