In the event you need to void an already authorized transaction, such as when the customer is cancelling an item before it is fulfilled, or you are certain that an item is out of stock and cannot be fulfilled, you can submit a POST request to the void endpoint. You may fully or partially void a transaction by specifying an amount in the request, but it must be less than or equal to the remaining_amount available in the Transaction object.
When the void request is successfully processed, an updated Transaction object is returned in the response, with the remaining_amount updated to reflect the latest void event. Note that once an amount is voided, it is permanently deducted from the remaining_amount and you can no longer capture against the amount voided.
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.