Skip to main content

Refund Payment

POST 
/api/v2/payments/:payment_id/refund

Process a partial or full refund for a payment.

Omit amount (or set it to the remaining refundable balance) for a full remaining refund. Amount must be > 0 and not exceed payment.amount - sum(existing refunds).

Status becomes PARTIALLY_REFUNDED while cumulative refunds are below the payment amount, and REFUNDED when fully refunded. Org webhooks: PAYMENT_PARTIALLY_REFUNDED on every partial; PAYMENT_REFUNDED only when fully refunded.

When multiple Stream payments share one Moyasar charge, refunds are scoped to the requested payment only (partial Moyasar refund of that amount).

Request​

Responses​

Successful Response