Creates a refund against a payment. For partial or full refunds of invoices, prefer issuing a credit note first via create-credit-note and applying it, which handles accounting and gives the customer a paper trail. Direct refunds are best for cases where no credit note is needed.
Documentation Index
Fetch the complete documentation index at: https://alguna.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
API key authentication. Pass your API key as a Bearer token.
2026-04-01 A unique string used to ensure the request is processed exactly once. If you retry a request with the same idempotency key within 24 hours, the original response is returned without re-executing the operation.
255"ik_a1b2c3d4e5f6"
Refund amount
"99.00"
The payment to refund
"pay_01H1VECT"
Reason for the refund
"Customer requested refund"
Text that appears on the customer's bank statement
"Invoice INV-001 refund"
Success
Refund amount as a decimal string
"99.00"
Timestamp when the refund was created
"2026-04-01T10:00:00Z"
Currency code
"USD"
The customer that received the refund
"cust_01H1VECT"
Unique identifier for the refund
"re_01H1VECT"
The original payment that was refunded
"pay_01H1VECT"
Refund status
pending, succeeded, failed, canceled "succeeded"
Timestamp when the refund was last updated
"2026-04-01T12:30:00Z"
External reference ID from the payment processor
Link to view the refund in the payment processor's dashboard
Reason for failure if status is failed
Payment processor's internal refund ID
Reason for the refund
"Customer requested refund"