Adjust and capture

Last Updated: June 11, 2024

What's in this article?

Adjust the amount or details of a previous unsettled transaction, and captures it into the batch.

This endpoint requires that the source key have a pin.

This endpoint only applies to credit card transactions, and will return an error for ACH transactions.

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 Capture permission on the source key. If the amount is adjusted, the request will require Adjust permission as well.

TSYS only supports adjusts on transactions using US or Canadian cards. International cards must use refunds.

Adjusting a transaction should only be done in a compliant manner and is the responsibility of the merchant.

A transaction can only be adjusted once.

AUTHORIZATIONS:
BasicAuthentication
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.

Help us improve. Was this article helpful?