Refunds

A refund sends the original payment amount back to the customer’s Stellar wallet. Refunds are processed on-chain and reflect a succeeded or failed status once the transaction settles.

The refund object

string

Unique identifier. Prefixed with rf_.

string

Always "refund".

string

The payment being refunded.

string

The customer receiving the refund.

string

Amount refunded, e.g. "50 XLM".

string

pending, succeeded, or failed.

string

Optional reason for the refund.

string

Stellar public key the refund was sent to.

object

Arbitrary key-value data.

string

ISO 8601 timestamp.

Create a refund

POST /refunds Refunds the full amount of a payment to the customer’s wallet on file. Pass wallet_address to override the destination.

curl https://api.stellartools.dev/refunds \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_id": "pay_01jx...",
    "reason": "Customer request"
  }'

Body

string

required

ID of the payment to refund.

string

Reason for the refund.

string

Override the refund destination. Defaults to the wallet that made the original payment.

object

Arbitrary key-value data.

Overview

Resources

Reference Data

The refund object

Create a refund

Body

​The refund object

​Create a refund

​Body

The refund object

Create a refund

Body