To refund a previous captured transaction, you can submit a POST request to the refund endpoint. Similar to capture requests, you have the flexibility to fully or partially refund a transaction by specifying an amount equal to or less than the captured_amount of the Transaction.
When the refund request is successfully processed, an updated Transaction object is returned in the response, with the captured_amount and refunded_amount updated to reflect the latest refund event. The successfully refunded amount is scheduled to be returned from your designated bank account, by way of netting against your upcoming payout, at the end of the transaction period during the disbursement process.
Idempotency key to prevent duplicate requests.
Amount voided, captured, or refunded. Optional. If left blank, uses the full remaining amount.
ISO 4217 currency code for this transaction. Required if amount is provided.
Optional field for merchants to enter their own reference ID to aid in reconciliation.
Successful response
The unique transaction_id generated when an authorization is submitted for an order.
The original amount the transaction was authorized for.
The remaining amount that can be captured.
The cumulative amount that has been successfully captured.
The cumulative amount that has been successfully refunded.
Once a transaction is authorized, the merchant has a limited number of days to capture on the remaining amount. RFC3339 format.
The Flex Pay order that the transaction is authorized for.
Timestamp of when this transaction was first authorized. RFC3339 format.
ISO 4217 currency code for the amount fields.
Optional field for merchants to enter their own reference ID to aid in reconciliation.
The current status of the transaction.
A list of transaction events. See TransactionEventAto object.
The unique event_id generated for the transaction event.
The amount corresponding to the transaction event.
ISO 4217 currency code for the amount field.
Timestamp of when this transaction event took place. RFC3339 format.
Optional field for merchants to enter their own reference ID to aid in reconciliation.
The type of action that this event represents.
response for errors
The name of the error codes.
Unauthorized (you don't have access)
Forbidden(you don't have the permission to perform this operation)
response for errors
The name of the error codes.
response for errors
The name of the error codes.