Skip to main content
InputObject Top-level input fields for creating a refund transaction for a previous payment.

​
Input Fields

​
paymentId
required
The unique ‘paymentId’ of the payment that is to be refunded.
​
transactionAmountDetails
The partial or full amount of the transaction to be refunded. If you do not specify an amount, Tesouro will refund the full amount.
​
lineItems
Line item details for this order. If line items are provided on the refund any line items from the original authorization will be overridden. If line items are provided, transactionAmountDetails must be provided.
​
orderDetails
Details pertaining to the customer’s order. If null, order details from the original authorization will be used. If provided, all details from the original authorization will be overridden.
​
acceptorId
required
A unique, 36 character identifier created by Tesouro and assigned to the entity providing the goods or services to the cardholder, such as a Merchant, a Submerchant of a Payment Facilitator, a Seller within a Marketplace, or a Biller of a Consumer Bill Payment Service Provider (CBPS). Historically, processors have called this identifier the Merchant ID (or MID), Outlet ID, or Customer number.
​
transactionReference
required
A unique identifier created by the entity holding the direct relationship with the Acceptor, and used by that entity for reconciliation and transaction search. Tesouro uses this identifier to manage idempotency.
{
  "paymentId": "72ef289d-77d4-4696-8a08-da83ed15b751",
  "transactionAmountDetails": AmountDetailsInput,
  "lineItems": [
    LineItemInput
  ],
  "orderDetails": OrderDetailsInput,
  "acceptorId": "72ef289d-77d4-4696-8a08-da83ed15b751",
  "transactionReference": Max36Text
}