WEweb2wave

Refund a payment

Changed on

Perform a full refund for a specific invoice.

put/subscription/refund

Request

  • Base URL
    https://api.web2wave.com/api
  • URL
    https://api.web2wave.com/api/subscription/refund
  • Auth
    API key in header api_key

Request body

pay_system_idstring

The payment system ID of the subscription.

invoice_idstring

The ID of the invoice to refund.

reason'requested_by_customer' | 'duplicate' | 'fraudulent' | 'other'

Optional reason code shown to the payment provider. Defaults to requested_by_customer when omitted. If set to other, comment should also be provided.

commentstring

Optional free-text comment, required when reason is other.

Response

Refund processed successfully.

successboolean

Example response

{
  "success": true
}

Changes