Tip Adjustment Request

Tip Adjustment enables users to modify the tip amount on a transaction before the batch is settled and sent to the processor. This feature is available only if tip is enabled for the TPN on the portal. Additionally, the host system must use data from the original transaction to allow the terminal to locate and update the tip amount.

Request Body

application/xml

RegisterId*string

Alphanumeric reference field.

Lengthlength <= 50

TPN?string

Alphanumeric TPN field.

Lengthlength <= 12

AuthKey?string

Required if the terminal is configured to use AuthKey.

Lengthlength <= 25

TransType*string

Identifies the type of transaction to run – TipAdjust.

Lengthlength <= 20

Value in"TipAdjust"

Amount*number

Base dollar amount of the original transaction.

Tip*number

Dollar amount of tip to adjust to. Tip must be enabled on the terminal.

AcntLast4?string

Last 4 digits of the account number from the original transaction, used to verify the card being tip-adjusted.

RefId*string

Must match the RefId from the original transaction.

Lengthlength <= 50

MerchantId?string

Optional for regular transactions when Multi MID (MMID) is not enabled; mandatory when MMID is enabled in which case the MerchantId must be the TPN (Terminal Provider Number) mapped to the target MID to ensure the transaction is routed correctly.

Lengthlength <= 12

ReconId?string

Fiserv North / Elavon reconciliation reference ID.

Lengthlength <= 10

IsTxnStatusScreenRequired?boolean

Indicates whether the terminal should display the transaction status screen after processing.

Response Body

`application/xml`

curl -X GET "https://example.com" \  -H "Content-Type: application/xml" \  -d '<request>    <AuthKey/>    <RegisterId>3</RegisterId>    <TPN/>    <TransType>TipAdjust</TransType>    <Amount>100.00</Amount>    <Tip>10.00</Tip>    <AcntLast4/>    <RefId>2</RefId>    <MerchantId/>    <ReconId/>    <IsTxnStatusScreenRequired>true</IsTxnStatusScreenRequired>  </request>'

<response>
  <RefId>2</RefId>
  <RegisterId>3</RegisterId>
  <TPN>yourTPN</TPN>
  <ResultCode>0</ResultCode>
  <Message>Success</Message>
  <PaymentType>Credit</PaymentType>
</response>

Tip Adjustment Request

Request Body

Response Body

200application/xml

`application/xml`