Skip to main content
Object implements PaymentTransaction, Refund

Fields

approvedAmount
required
The amount approved for authorization on this transaction
customerStatementMemo
Information that appears on the bank account owner’s bank statement and describes the transaction.
traceNumber
A unique 15-digit number that identifies an Automated Clearing House (ACH) transaction. It’s used by the bank to track the transaction and resolve issues.
transferEffectiveDate
The date the bank transfer will be debited from or credited to customers account.
networkApprovalCode
A six-digit code returned from the card network on an approved authorization, and displayed on the customer’s receipt.
acquirerReferenceNumber
The Acquirer Reference Number (ARN) is a unique 23 digit number created by Tesouro and assigned to a transaction to allow the acquiring and issuing banks to trace the transaction until it is funded to the bank.
currency
The currency specified on the transaction request, in ISO 4217 alpha currency code format.
requestedAmount
required
The transaction amount submitted with the authorization request.
order
required
Information concerning the order placed by the customer.
paymentChannel
required
The card-present or card-not-present channel from which the customer makes a payment, e.g., In-store using a physical card terminal, online, or over the phone or through mail order.
paymentEntryMode
required
The means by which the payment details are captured, e.g., Card swipe, contactless “tap”, chip entry “dip”, keyed, etc.
isFunded
required
Indicates if the funding amount has been released. Defined as having a funds transfer ID and funds transfer release date.
feeTotalAmount
The total amount of fees applicable to this transaction.
interchangeFeesAmount
The amount of interchange fees applicable to the transaction. Interchange fees are set by the card networks, and paid to the bank that issued the card used for the transaction.
networkFeesAmount
The amount of network fees applicable to this transaction. Network fees are set by card networks and are paid to the card network.
processorFeesAmount
The amount of processor fees applicable to this transaction. Processor fees are set by and paid to Tesouro.
partnerFeesAmount
The amount of partner fees applicable to this transaction. Partner fees are set by and paid to the partner.
convenienceFeesAmount
The amount of convenience fees associated with this transaction
serviceFeesAmount
The amount of service fees associated with this transaction
surchargeAmount
The amount of surcharge associated with this transaction
fundingCurrency
The currency of the funded transaction, formatted in ISO 4217 alphabetic code.
fundingGrossAmount
The total amount of the transaction converted to its funding currency, before any fees are deducted.
fundingNetAmount
The amount to be funded after deducting the applicable fees. Presented in the funding currency.
fundsTransfer
Details on the funds transfer containing this transaction’s funding amount.
networkTransactionId
A unique value created by the card network and assigned to the transaction and returned to Tesouro in the authorization response. The card network uses this value to maintain an audit trail throughout the life cycle of the transaction and all related transactions, such as reversals, adjustments, confirmations and charge-backs.
networkResponseCode
A response code provided by the card network identifying the specific approval or decline reason.
paymentTransactionReason
required
The consumer or transactor’s reason for submitting the payment transaction, e.g., a consumer wanting to purchase goods or services, or pay down a debt, or a transactor initiating a charge as part of a recurring service plan. Used in reporting.
id
required
A unique identifier assigned by Tesouro for every transaction request received.
reference
A unique transaction identifier created by the entity holding the direct relationship with the Acceptor. Tesouro uses this identifier to manage idempotency.
billingDescriptor
The billing descriptor name that appears on the customer’s statement.
paymentId
required
A unique 36 character identifier created by Tesouro and assigned to a group of transactions in the same payment request cohort. e.g., An authorization request, incremental authorization request, and the final capture would have the same paymentID.
activityDate
The date Tesouro recognized the payment request based upon the acceptor cutoff.
transactionDateTime
required
The date and time that Tesouro received the transaction, in UTC. Formatted as 2024-03-27T02:40:00Z
processingNetwork
required
The payment network that the transaction was sent across, which may be unaffiliated with the card brand.
organization
required
acceptor
required
transactionType
required
The type of payment transaction, e.g., Authorization, Capture, Sale, Refund, Reversal, etc.
businessApplicationId
The business application identifier (BAI) is a value provided by Visa to identify the type of transfer that is being performed.
fees
Aggregate information for assessed fees
taxes
The various tax amounts collected on the payment transaction.
amountDetails
Components of the requested amount that may or may not have been provided by the presenter on the payment transaction request.
lineItems
Line items associated with the payment transaction.
taxIdentificationNumber
The last 4 digits of the tax identification number (TIN), which is a unique identifier created by the national government and associated with the acceptor at the time the transaction was submitted.
processorResponseCode
required
A response code provided by Tesouro identifying the specific approval or decline reason.
processorResponseMessage
required
A human readable description of the authorization response code. e.g., Insufficient funds.
merchantCategory
Unique ISO four digit values used to classify merchants and their transactions into specific categories based on the type of business, trade or services supplied.
responseType
The result of the authorization request, e.g., Approved or Declined.
paymentMethod
required
Refers to the various options available for customers to make payments when purchasing a product or service.
resultLabel
required
Short description of the payment transaction result. Examples include Approved, Insufficient funds. Intended for display purposes only.
{
  "approvedAmount": Decimal,
  "customerStatementMemo": "xyz789",
  "traceNumber": "xyz789",
  "transferEffectiveDate": "2007-12-03",
  "networkApprovalCode": "xyz789",
  "acquirerReferenceNumber": "xyz789",
  "currency": "abc123",
  "requestedAmount": Decimal,
  "order": Order,
  "paymentChannel": "ECOMMERCE",
  "paymentEntryMode": "UNUSED",
  "isFunded": false,
  "feeTotalAmount": Decimal,
  "interchangeFeesAmount": Decimal,
  "networkFeesAmount": Decimal,
  "processorFeesAmount": Decimal,
  "partnerFeesAmount": Decimal,
  "convenienceFeesAmount": Decimal,
  "serviceFeesAmount": Decimal,
  "surchargeAmount": Decimal,
  "fundingCurrency": "xyz789",
  "fundingGrossAmount": Decimal,
  "fundingNetAmount": Decimal,
  "fundsTransfer": FundsTransfer,
  "networkTransactionId": "xyz789",
  "networkResponseCode": "xyz789",
  "paymentTransactionReason": "GENERAL_PURCHASE",
  "id": "72ef289d-77d4-4696-8a08-da83ed15b751",
  "reference": "abc123",
  "billingDescriptor": "abc123",
  "paymentId": "72ef289d-77d4-4696-8a08-da83ed15b751",
  "activityDate": "2007-12-03",
  "transactionDateTime": "2007-12-03T10:15:30Z",
  "processingNetwork": "VISA",
  "organization": Organization,
  "acceptor": Acceptor,
  "transactionType": "AUTHORIZATION",
  "businessApplicationId": "CB",
  "fees": FeeDetails,
  "taxes": Taxes,
  "amountDetails": AmountDetails,
  "lineItems": [
    LineItem
  ],
  "taxIdentificationNumber": "xyz789",
  "processorResponseCode": "A0000",
  "processorResponseMessage": "abc123",
  "merchantCategory": "xyz789",
  "responseType": "APPROVAL",
  "paymentMethod": PaymentMethod,
  "resultLabel": "xyz789"
}