amount.
Safe retries for this POST endpoint use the
Idempotency-Key header. Reuse the same key only when retrying the exact same request body. See Idempotency.Path parameters
string
required
Your terminal identifier. Exactly 6 characters.
Request body
string
required
The
transaction_id of the sale or capture you want to refund. Exactly 8 characters.string
required
The
order_id associated with the transaction you want to refund. Exactly 8 characters.string
Your unique identifier for this refund transaction. Must be different from the
merchant_transaction_id of the original transaction.number
Amount to refund in major currency units (e.g.,
25.00 for $25.00). If omitted, the full transaction amount is refunded. Partial refunds are supported - you can issue multiple partial refunds as long as the total does not exceed the original transaction amount.string
Three-letter ISO 4217 currency code. If omitted, the currency of the original transaction is used.
Response
string
required
SmartRetry’s unique identifier for this refund transaction. Exactly 8 characters.
string
The order identifier, matching the
order_id from the original transaction.string
The
merchant_transaction_id you provided in the request, echoed back for confirmation.string
The
merchant_order_id associated with the order, when present.boolean
required
true if the refund was accepted for processing. Poll the status endpoint using the returned transaction_id to confirm the refund outcome.