RefundDto

amountintegerRequired

Amount of the refund in smallest currency unit (e.g., cents)

amount_strstringRequired

String representation of the refund amount, formatted for display

created_atstringRequired

Date and time when the refund was created

currencystringRequired

Three-letter currency code of the refund

customer_idFlakeIdRequired

gateway_fee_amountintegerRequired

Amount of payment processor fees in smallest currency unit

gateway_fee_amount_strstringRequired

String representation of gateway fee amount, formatted for display

idFlakeIdRequired

payment_idFlakeIdRequired

platform_fee_amountintegerRequired

Amount of platform fees in smallest currency unit

platform_fee_amount_strstringRequired

String representation of platform fee amount, formatted for display

refund_from_connected_user_balancebooleanRequired

Indicates whether the refund should be taken from the connected user's balance. Only relevant for platforms.

statusenumRequired

Represents the current status of a refund in the system

Possible enum values

created
Refund has been created but not yet processed
approved
Refund has been approved but not yet processed (reserved for customer requested refunds)
processing
Refund is currently being processed by the payment system
completed
Refund has been successfully completed
canceled
Refund has been canceled before completion
failed
Refund processing has failed

store_idFlakeIdRequired

store_net_amountintegerRequired

Net amount for the store after fees in smallest currency unit

store_net_amount_strstringRequired

String representation of store net amount, formatted for display

store_refund_amountintegerRequired

Amount of the refund to be paid by the store in smallest currency unit

store_refund_amount_strstringRequired

String representation of store refund amount, formatted for display

tax_amountintegerRequired

Amount of tax being refunded in smallest currency unit

tax_amount_strstringRequired

String representation of tax amount, formatted for display

approved_atstringOptional

Optional date and time when the refund was approved

canceled_atstringOptional

Optional date and time when the refund was canceled

completed_atstringOptional

Optional date and time when the refund was completed

failed_atstringOptional

Optional date and time when the refund failed

failure_reasonstringOptional

Reason for failure if the refund has failed

fx_ratestringOptional

Exchange rate used while refunding. Only present for payments made in non-settlement currency.

order_line_idFlakeIdOptional

pending_atstringOptional

Optional date and time when the refund entered pending status

presentment_amountintegerOptional

Optional amount in presentment currency in smallest currency unit

presentment_currencystringOptional

Optional currency code used for presentment to the customer if different from the base currency

Example

{
  "amount": 0,
  "amount_str": "string",
  "created_at": "2024-01-01T00:00:00Z",
  "currency": "string",
  "customer_id": "411486491630370816",
  "gateway_fee_amount": 0,
  "gateway_fee_amount_str": "string",
  "id": "411486491630370816",
  "payment_id": "411486491630370816",
  "platform_fee_amount": 0,
  "platform_fee_amount_str": "string",
  "refund_from_connected_user_balance": true,
  "status": "created",
  "store_id": "411486491630370816",
  "store_net_amount": 0,
  "store_net_amount_str": "string",
  "store_refund_amount": 0,
  "store_refund_amount_str": "string",
  "tax_amount": 0,
  "tax_amount_str": "string",
  "order_line_id": "411486491630370816",
  "failure_reason": "string",
  "presentment_currency": "string",
  "presentment_amount": 0,
  "fx_rate": "string",
  "approved_at": "2024-01-01T00:00:00Z",
  "pending_at": "2024-01-01T00:00:00Z",
  "completed_at": "2024-01-01T00:00:00Z",
  "canceled_at": "2024-01-01T00:00:00Z",
  "failed_at": "2024-01-01T00:00:00Z"
}