Adjust allows you to modify the previous transaction amount, either by increasing or decreasing it. Adjustments help reduce declines and improve customer experience by avoiding multiple holds on funds.

Note: You need to specify the entire new Sale amount and not the difference.

When to Use Sale Adjustment

• Pricing Corrections: A discount, coupon, or promotion is applied after checkout.
• Order Changes: An item is removed or replaced before the transaction settles.
• Manual Review Fixes: A pricing or tax error is identified shortly after the sale is created.

Industry Example: US Restaurants – Tips

A restaurant processes a sale for $45 when the customer pays their bill. The customer later adds a $10 tip on the receipt. Before the transaction settles, the restaurant adjusts the sale amount to $55 to include the tip.

📘

Sale can not be adjusted once it has moved to SETTLED status. The Sale must be in APPROVED status and its associated Batch is in OPEN status. So, before attempting an adjustment -

• Use GET /checkout/v3/payment/{id} endpoint to verify that the payment is in APPROVED status; OR
• Use GET /checkout/v3/batch/{id}?echo=true endpoint to verify the batch is in OPEN status.

How it Works

1. To adjust a Sale, make a PUT request to /checkout/v3/payment/{id} endpoint that includes:

   Parameter	Description
   ternderType	Set to CARD for card transactions.
   paymentToken	Secure payment token for the authorization to be adjusted.
   amount	New amount (in US currency units). Can be higher or lower than the previously mentioned amount.
   merchantId	Merchant's unique identifier.

2. Once the payment request is submitted, our system performs a series of system-level validations before sending the transaction to the card network. These validations check for:

   1. Missing or invalid required fields
   2. Incorrect parameter formats or values
   3. Merchant configuration or permission issues.
   
   

   If any validation fails, the request is rejected immediately, and an error response is returned. You must correct the issue and resubmit the request. For a complete list of validation errors and how to resolve them, refer to the System Error Codes guide.

3. If all system-level validations pass, our system authorizes the payment with the issuer, captures the funds instantly. The GET /checkout/v3/payment/{id} endpoint gives a response with new amount.

   1. amount: New amount as specified in the Adjust API.
   2. status: Status of the payment. You will also receive the result in a webhook.

4. Wait for the Adjust webhook to learn the outcome of the request. You can store the id and paymentToken for:

   1. Retrieving payment details later.
   2. Voiding the payment (if needed).
   3. Issuing partial or full refunds.

If the card has insufficient funds, the network returns a Declined status with the response:

"responseStatus": "Decline - Insufficient funds"