POST payments/credit/adjust

Adjusts a previously approved credit sale transaction. NOTE: Subtotal, tax, tip, and surcharge amounts can be adjusted up or down (greater or less than the original amount). Credit sale transactions cannot be adjusted below zero, but there is no maximum for adjusted amounts. A transaction cannot be adjusted once it has been voided (adjusted to zero). If the description is adjusted, the original description text will be overwritten and will not appear on the final transaction, just the final, adjusted description. Only transactions still in "open batch" can be adjusted. Batched or settled transactions are modified via Refund (instead of Adjustment).

Request Information

URI Parameters

None.

Body Parameters

The payload.

CreditAdjustRequest
NameDescriptionTypeAdditional information
TransactionData

Specific information for the transaction.

CreditAdjustTransactionData

Required

AmountsRequest

Amount requested for this transaction.

CreditAdjustAmountsRequest

None.

CommercialCard

Commercial card data, including tax exempt reasoning.

PaymentCommercialCardData

None.

OriginalTransactionData

Specific information for the original transaction (to be adjusted).

CreditAdjustOriginalTranData

Required

SendReceiptRequest

Request for sending a transaction receipt.

PaymentReceiptRequest

None.

Request Formats

application/json, text/json

Sample:
{
  "TransactionData": {
    "UniqueIdentifier": "sample string 1",
    "TimeStamp": "2024-03-28T14:05:16.114Z",
    "TotalAmount": 3.0,
    "Description": "sample string 4",
    "GeotagInfo": {
      "Longitude": 1.1,
      "Latitude": 2.1
    },
    "DeviceRegistrationIdentifier": "d63b8224-44db-4b5c-9865-ec95a6319b21"
  },
  "AmountsRequest": {
    "SubTotalAmount": 1.0,
    "TaxAmount": 2.0,
    "TipAmount": 3.0,
    "SurchargeAmount": 4.0
  },
  "CommercialCard": {
    "CustomerCode": "sample string 1",
    "TaxExemptDetails": {
      "TaxExempt": true
    }
  },
  "OriginalTransactionData": {
    "HostTransactionID": 1
  },
  "SendReceiptRequest": {
    "Emails": [
      {
        "Email": "sample string 1"
      },
      {
        "Email": "sample string 1"
      }
    ]
  }
}

Response Information

Resource Description

Adjusts a previously approved credit sale transaction. NOTE: Subtotal, tax, tip, and surcharge amounts can be adjusted up or down (greater or less than the original amount). Credit sale transactions cannot be adjusted below zero, but there is no maximum for adjusted amounts. A transaction cannot be adjusted once it has been voided (adjusted to zero). If the description is adjusted, the original description text will be overwritten and will not appear on the final transaction, just the final, adjusted description. Only transactions still in "open batch" can be adjusted. Batched or settled transactions are modified via Refund (instead of Adjustment).

CreditAdjustResponse
NameDescriptionTypeAdditional information
TransactionRequestData

Transaction request data, such as echo back properties.

PaymentTransactionRequestData

Required

TransactionResultData

Transaction result data.

PaymentTransactionResultData

Required

Result

Transaction result, such as success or failure.

PaymentTransactionResult

Required

Response Formats

application/json, text/json

Sample:
{
  "TransactionRequestData": {
    "UniqueIdentifier": "sample string 1"
  },
  "TransactionResultData": {
    "AuthCode": "sample string 1",
    "HostTransactionID": 1,
    "ParentHostTransactionID": 1,
    "RRN": "sample string 2",
    "ReceiptID": 1
  },
  "Result": {
    "ProcessorResponseCode": "sample string 1",
    "ProcessorResponseText": "sample string 2",
    "ResponseCode": 3,
    "ResponseText": "sample string 4"
  }
}