Refund a committed payment intent, in whole or in part.
POST/payments/card/{id}/refund
Refunds are aggregate-only: there is no per-refund object and no
refund-enumeration endpoint. Only amount_refunded on the intent reflects
the running total refunded; issue multiple calls for multiple partial
refunds up to the captured amount.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Example
pi_card_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAVPayment intent ID
Request Bodyrequired
Section titled “Request Bodyrequired”object
Amount to refund, in the currency’s minor units. Must not exceed the
remaining refundable amount (amount_captured − amount_refunded).
Example
1000Responses
Section titled “Responses”Refunded. The returned intent’s amount_refunded reflects the new aggregate total
object
A monetary amount in the currency’s minor units (e.g. cents for USD).
Example
1000A monetary amount in the currency’s minor units (e.g. cents for USD).
Example
1000A monetary amount in the currency’s minor units (e.g. cents for USD).
Example
1000Currently supported currencies by Paygasus Pay
Example
USDExample
pi_card_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAVobject
If is in state ‘Created’, will be empty. status_at indicates state change occurences. Created is the initial state
No such payment intent
object
object
Intent is not in a refundable state, is already being processed, or the amount exceeds the refundable remaining
object
object
Processor transport failure; the operation is retryable