Skip to main content
GET
Fetch refund payment

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string
required
Pattern: ^[0-9a-f-]+$
payment_id
string<uuid>
required

A UUID string identifying this refund payment.

refund_id
string
required
Pattern: ^[0-9a-f-]+$

Response

Serializer for refund payments. All amounts in cents.

id
string<uuid>
required
read-only

Unique refund payment identifier

refund_id
string<uuid>
required
read-only

ID of the refund this payment belongs to

refunded_amount
integer
required
read-only

Refunded amount in cents

refund_processing_fee
integer
required
read-only

Processing fee in cents

reconciled_bank_transactions
object[]
required
read-only

Bank transactions this refund payment is reconciled to

created_at
string<date-time>
required
read-only

Timestamp when refund payment record was created

updated_at
string<date-time>
required
read-only

Timestamp when refund payment record was last updated

external_id
string

Your unique identifier for idempotency (unique within refund)

Maximum string length: 255
completed_at
string<date-time> | null

Date and time when refund payment was completed

method
enum<string>

Payment method used for refund (CASH, CHECK, CREDIT_CARD, BANK_TRANSFER, etc.)

  • BANK_TRANSFER - Bank Transfer
  • CREDIT_CARD - Credit Card
  • DEBIT_CARD - Debit Card
  • ACH - ACH/Direct Debit
  • CHECK - Check/Cheque
  • CASH - Cash
  • PAYPAL - PayPal
  • STRIPE - Stripe
  • OTHER - Other
Available options:
BANK_TRANSFER,
CREDIT_CARD,
DEBIT_CARD,
ACH,
CHECK,
CASH,
PAYPAL,
STRIPE,
OTHER
processor
string

Payment processor used (e.g., Stripe, PayPal, manual)

Maximum string length: 100
transaction_tags
any

List of tags for categorization and reconciliation tracking

memo
string

Optional description or notes for this refund payment

metadata
any

Custom key-value pairs for payment context