Adjust amount and tip
post
https://<your_gateway_host>
/api/payment/adjust
Adjustment

Example Request

1
{
2
"id": "{{transactionId}}",
3
"data": {
4
"transactionAmount": "130.00",
5
"tip": "30.00"
6
}
7
}
Copied!

Request Field Definition Table

Field ID
Description
transactionAmount
Format: Numeric|Max Length=12|Allowed characters: 0-12 .(dot) Note: If a decimal point is included, the amount reflects a dollar value. If a decimal point is not included, the amount reflects a cent value.
​
Description: The amount to be processed and includes the subtotal and any additional charges. If a request transaction amount includes a decimal point, the response will also include a decimal point. For void and return transactions, this is a conditional field. If this is not included in the request, then the full amount of the original transaction is voided.
For Debit Mastercard card a maximum of 7 digits are allowed in this field.
tip
Format: Numeric |Max Length=12|Allowed characters: 0-9 .(dot) Note: If a decimal point is included, the amount reflects a dollar value. If a decimal point is not included, the amount reflects a cent value.
​
Description: The tip amount of the transaction.
notifyEmailID
Format: Alphanumeric and Special Character |Min Length=6 Max Length=512
​
Description: The email address for the user receiving transaction receipt notifications. Merchants can send transaction receipts to multiple email addresses. They must be separated by a comma. For example: [email protected], [email protected]
Note: notifyEmailID is mandatory if the Notification group is included.
softDescriptor
Format: Alphanumeric |Min Length=1 Max Length=25|Allowed special characters: @ ( ) / . ' : $ , / * -
​
Description: The text on the cardholder's statement that describes the purchase. If the softDescriptor is sent, it will be forwarded in the authorization and capture for all card types. If the soft descriptor is sent in the request along with payment facilitator details, then the soft descriptor will take priority over Payfac name on card holder’s statemen. Soft Descriptor: AMEX OptBlue does not support soft descriptors. PayFac Update: AMEX OptBlue with payfac is not supported as of now. Soft Descriptor will appear on receipts inplace of Merchant Name.
​
​
Webhook event: PAYMENT_ADJUSTED
Last modified 7mo ago