Adjust
Last Updated:What's in this article?
Adjust the amount or details of a previous unsettled transaction.
This endpoint requires that the source key have a pin.
The amount of ACH and Terminal transactions cannot be adjusted, and will return an error if a different amount is sent.
If the original transaction had amount details and this request changes the amount, the amount_details must be resent. If only details are being adjusted and not the amount, the amount field can be omitted.
This request requires the Adjust permission on the source key.
TSYS only supports adjusts on transactions using US or Canadian cards. International cards must use refunds after the transaction has settled.
Adjusting a transaction to a higher amount is only permitted by the card brands in specific scenarios. It is the the responsibility of the merchant to enforce this.
A transaction can only be adjusted once.
AUTHORIZATIONS:
REQUEST BODY SCHEMA: application/json
| reference_number required | integer Reference number of the transaction to adjust. |
| amount | number Amount to adjust the original transaction to. |
| customer | object (BaseTransactionCustomer) |
| transaction_details | object Additional optional transaction details. |
| amount_details | object (AmountDetails) Breakdown of the amount. These fields do not affect the actual transaction amount and are for reporting and Level 3 only. |
| billing_info | object (Address) |
| shipping_info | object (Address) |
| custom_fields | object (CustomFields) |
| line_items | Array of objects (Item) non-empty Line item details for Level 3 data. The data will not be checked for accuracy, e.g. if the totals add up correctly. The new data will replace the old data. |