Skip to main content

RefundPaymentPayload

The result of refunding a payment on an invoice.

type RefundPaymentPayload {
data: Invoice
refundId: ID
refundExternalId: String
error: String
}

Fields​

RefundPaymentPayload.data ● Invoice object​

The updated invoice, including the new refund.

RefundPaymentPayload.refundId ● ID scalar​

The id of the refund recorded on the invoice (Invoice.refunds[].id).

RefundPaymentPayload.refundExternalId ● String scalar​

The Stripe refund id, for reconciliation. Present only when a Stripe card payment was refunded.

RefundPaymentPayload.error ● String scalar​

Returned By​

refundPayment mutation