Sign in
Refunds

Retrieve Refund

Returns one refund.

get/refunds/{id}

Response

refund retrieved

account_idstring nullable required

The account that issued the refund, prefixed biz_.

created_atstring required

When the refund was requested, as an ISO 8601 timestamp.

failure_messagestring nullable required

The provider's own explanation of the failure, or null.

failure_reason'bank_declined' | 'expired_or_canceled_card' | 'lost_or_stolen_card' | 'insufficient_funds' | 'charge_disputed' | 'not_refundable' | 'merchant_request' | 'unknown' | 'null' nullable required

Why the refund failed, normalized across providers. Null unless the refund failed or was canceled.

idstring required

Refund ID, prefixed rf_.

payment_idstring required

The payment this refund reverses, prefixed pay_.

providerstring required

The payment provider that processed the refund, such as paypal or coinbase.

provider_created_atstring nullable required

When the provider created the refund, as an ISO 8601 timestamp.

reason'duplicate' | 'fraudulent' | 'requested_by_customer' | 'expired_uncaptured_charge' | 'null' nullable required

Why the refund was issued, when recorded.

reference_status'available' | 'pending' | 'unavailable' | 'null' nullable required

Whether a banking-network tracking reference is available for this refund.

reference_type'acquirer_reference_number' | 'retrieval_reference_number' | 'system_trace_audit_number' | 'null' nullable required

The kind of tracking reference, such as an acquirer reference number.

reference_valuestring nullable required

The tracking reference the buyer's bank can trace the refund by.

status'pending' | 'requires_action' | 'succeeded' | 'failed' | 'canceled' required

Where the refund stands with the processor: pending, requires_action, succeeded, failed, or canceled.

updated_atstring required

When the refund last changed, as an ISO 8601 timestamp.

visa_rdrboolean required

True when the card network initiated the refund through Rapid Dispute Resolution.

Example response

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount": {
    "amount": "-2.50",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "failure_message": "Insufficient funds on the merchant balance.",
  "failure_reason": "insufficient_funds",
  "id": "rf_xxxxxxxxxxxxxx",
  "original_amount": {
    "amount": "-2.50",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "payment_id": "pay_xxxxxxxxxxxxxx",
  "provider": "stripe",
  "provider_created_at": "2026-01-01T12:00:00.000Z",
  "reason": "duplicate",
  "reference_status": "available",
  "reference_type": "acquirer_reference_number",
  "status": "failed",
  "updated_at": "2026-01-01T12:00:00.000Z"
}

Changes