v1

latestOpenAPI 3.0.12026-07-2662118182.1 KB

Thredd portal transactions

Get Transaction Details of a single transaction

get/api/v1/portal/transactions/single/{transactionId}

Path parameters

transactionIdinteger required

ID of the transaction

Response

Success

productNamestring nullable

Gets or sets the name of the product.

customerReferencestring nullable

Gets or sets the customer reference.

recordIdinteger required

ID of the Transaction or Auth.

pubTokenstring required

Public token

traceIdLifeCyclestring nullable

string Id which links the satges of an online Transaction.

transactionIdinteger required

ID of the original Transaction.

transactionType'Load' | 'Unload' | 'TransferFunds' | 'BalanceAdjustment' | 'Fee' nullable

Type of the transaction.

transactionStatusstring nullable

Status of the Transaction.

transactionAmountnumber double

Amount relating to this Transaction.

transactionCurrencystring nullable

Transaction Currency.

transactionDatestring date-time

Date of this Transaction.

billingAmountnumber double

Amount billed to the customer.

billingAmountWithDirectionnumber double

Amount billed to the customer * flCredit.

billingCurrencystring nullable

Billing Currency.

processingCodestring required

Processing code.

responseStatusstring nullable

Status returned (Approved/Declined).

merchantCategoryCodestring nullable

Merchant Category Code of the purchase.

merchantCategoryDescriptionstring nullable

Merchant category description.

dateExpirystring nullable

Expiry Date.

posEntryModestring nullable

Entry mode at Point of Sale.

retrievalReferencestring nullable

Retrieval Reference.

cardAcceptorIdentificationCodestring nullable

ID code of the Merchant (Card Acceptor).

cardAcceptorNameLocationstring nullable

Location of Merchant (Card Acceptor).

aidstring required

Acquirer Id.

fidstring required

Financial Id.

cardAcceptorTerminalIdentificationstring nullable

Merchant code identifying the POS device.

additionalDatastring nullable

Additional data.

settlementAmountnumber double

Amount charged.

settlementCurrencystring nullable

Settlement Currency.

authorisationCodestring nullable

Authorisation code.

additionalAmountsstring nullable

Additional charges.

tillTimeinteger

Till time.

paymentTokenIdinteger required

ID of the card payment token.

notestring nullable

Transaction Note

availableBalancenumber double

Available balance.

blockedAmountnumber double

Blocked amount.

fixedFeenumber double

Fixed fee amount

rateFeenumber double

Rate fee amount

fxPaddingnumber double

Foreign exchange padding amount

mccPaddingnumber double

Mcc padding amount

stanstring nullable

System Trace Audit Number - a number generated by Acquirer system, not unique

messageTypestring nullable

Message type

iccDatastring nullable

Authorisation Chip Data received in the request

messageReasonDatastring nullable

Shows why Visa/Mastercard sent the advice message

additionalResponseDatastring nullable

AVS/CVV/ASI Check Result

avsStreetstring nullable

Numbers in the 1st line of address entered by cardholder

avsPostcodestring nullable

Numbers in Postcode of address entered by cardholder

networkDatastring nullable

Network Data(reference number for each originating message) BN Ref(DE063)

acquirerReferenceDatastring nullable

Acquirer Reference Data (DE031) - Presentment specific

transactionOriginatingInstitutionstring nullable

Transaction originating Institution ID

paymentMethodstring nullable

Card/Wallet/None

ehiModeinteger

EHI mode for the product type.

networkReferenceIDstring nullable

Network ReferenceID - DGN specific.

functionCodestring nullable

Function Code - DGN specific.

surchargeFeestring nullable

Surcharge Fee - DGN specific.

additionalAuthorisationDataDGNstring nullable

Additional Authorisation Data for DGN - DGN specific.

transactionDestinationIICstring nullable

Transaction Destination Institution ID - DGN specific

networkIDinteger nullable

ID of the card Network. Visa = 1 or Mastercard = 0 or DGN = 2

requestTimestring date-time

Date and time of Request

responseTimestring date-time

Date and time of Response

diffInReqRespinteger

Difference (in milliseconds) - Difference between MessageResponseTime and MessageReceivedDate

responseSourcestring nullable

Response Source. [ResponseSource]

responseReasonstring nullable

Response Reason. [ResponseReason]

gpsPosDatastring nullable

Option to view GPS POS Data [PosData]

posDatastring nullable

POS Data - Different to GPS POS Data

recapDatestring nullable

Presentment Date from Discover Recap record.

recapNumberstring nullable

Unique Presentment number

currencyCodestring nullable

Currency Code as per the ISO Alpha Code

interchangeAmountFeenumber double nullable

Interchange amount fee.

interchangeAmountFeeSettlementnumber double nullable

Interchange amount fee settlement.

currencyCodeFeestring nullable

Currency code (Fee).

currencyCodeFeeSettlementstring nullable

Currency code (Fee settlement).

settlementIndicatorstring nullable

Settlement indicator.

feeTypestring nullable

Fee Type

feeProcessingCodestring nullable

Fee processing code

pds146Valuestring nullable

Pds146 value

billingCurrencyNumericCodestring nullable

The billing currency numeric code.

panReportinteger nullable

16-digit private token

panPubtinteger nullable

16-digit public token

isMFXboolean nullable

MultiFx Card transaction Identifier

descriptionstring nullable

Transaction description.

transactionTypeDescriptionstring nullable

Description of the transaction type.

transactionStatusDescriptionstring nullable

Description of the Transaction status.

responseStatusDescriptionstring nullable

Description of Response status.

responseCodestring nullable

Transaction Response code [Response_Code_039]

posConditionCodestring nullable

POS condition code.

resendtoEHIboolean nullable

Ehi IsAcknowledged

Example response

{
  "ehiMode": 2,
  "avsCardResponse": {
    "avsResponse": " N-Postcode wrong, Address wrong "
  }
}