Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
invoices

Record refund for invoice

Records a refund for the invoice. If all payments are refunded, the invoice is marked as REFUNDED. Otherwise, the invoice is marked as PARTIALLY REFUNDED.

post/v2/invoicing/invoices/{invoice_id}/refunds

Path parameters

invoice_idstring required

The ID of the draft invoice to delete.

Request body

type'PAYPAL' | 'EXTERNAL'

The payment type. Can be PayPal or an external payment. Includes cash or a check.

refund_idstring

The ID for a PayPal payment transaction. Required for the PAYPAL payment type.

refund_datestring ppaas_date_notime_v2

The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

method'BANK_TRANSFER' | 'CASH' | 'CHECK' | 'CREDIT_CARD' | 'DEBIT_CARD' | 'PAYPAL' | 'WIRE_TRANSFER' | 'OTHER' required

The payment mode or method through which the invoicer can accept the payments.

Response

A successful request returns the HTTP 200 Created status code and a reference to the recorded refund.

refund_idstring

The ID of the refund of an invoice payment.