Retrieve a transaction

If you want to receive on-demand transaction information you can request details using the Get Transaction request. Not only does the request return processed transactions but it will also return transactions that are in-flight. For example, that are currently being processed for 3D Secure or that you have suspended due to a call-back.

We’ll send you everything we know about the transaction including custom fields captured, 3D Secure information, data we’ve found out through our third party data sources (for example, supplementary card information) as well as information from the authoriser i.e. Authorisation responses, messages and codes, AVS and CV2 responses.

You can request a transaction using our reference or your own.

API Examples

Get transactions by merchant reference


GET /acceptor/rest/transactions/{instId}/byRef?merchantRef={merchantRef}
{}

HTTP/1.1 200
[
  {
    "processing": {
      "authResponse": {
        "statusCode": "00",
        "acquirerName": "HSBC Merchant Services Domestic",
        "message": "ACQUIRER OK",
        "authCode": "authCode",
        "gatewayReference": "4300200042810617-PASS",
        "gatewaySettlement": "2014-10-29",
        "gatewayCode": "1",
        "gatewayMessage": "ACCEPTED",
        "avsAddressCheck": "NOT_MATCHED",
        "avsPostcodeCheck": "NOT_MATCHED",
        "cv2Check": "NOT_MATCHED",
        "status": "AUTHORISED"
      },
      "route": "MCPE"
    },
    "paymentMethod": {
      "card": {
        "cardToken": "outY+Gn8TGWwNPBuazginA",
        "cardFingerprint": "sj4/LqPLxB3yx6W6cwdh+Flj++k=",
        "new": false,
        "cardType": "VISA_DEBIT",
        "cardUsageType": "DEBIT",
        "cardScheme": "VISA",
        "maskedPan": "100035******0007",
        "expiryDate": "0115",
        "issuer": "Lloyds",
        "issuerCountry": "GBR",
        "cardNickname": "John",
        "validDate": "1111"
      },
      "billingAddress": {
        "line1": "Flat 1 ",
        "line2": "Cauldron house",
        "line3": "A Street",
        "line4": "Twertonia",
        "city": "Bath",
        "region": "Somerset",
        "postcode": "BA1 234",
        "country": "United Kingdom",
        "countryCode": "GBR"
      },
      "paymentClass": "CARD"
    },
    "customFields": {
      "fieldState": [
        {
          "name": "measure_CV2_FAILURES",
          "value": "3",
          "transient": false
        },
        {
          "name": "measure_NO_DATA_MATCH",
          "value": "3",
          "transient": false
        },
        {
          "name": "measure_ADDRESS_MATCH_ONLY",
          "value": "0",
          "transient": false
        },
        {
          "name": "measure_TOTAL_CARD_SPEND",
          "value": "3000.00",
          "transient": false
        }
      ]
    },
    "threeDSecure": {
      "scheme": "VERIFIED_BY_VISA",
      "status": "AUTHENTICATED",
      "enrolmentIndicator": "Y",
      "enrolmentStatus": "ENROLLED",
      "enrolmentDateTime": "2012-02-23T11:16:02.000Z",
      "authenticationIndicator": "Y",
      "authenticationStatus": "AUTHENTICATED",
      "xid": "00000000003030821144",
      "eci": "05"
    },
    "customer": {
      "merchantRef": "mer_cust_131241412",
      "id": "10500",
      "displayName": "Mr O Whatasillyname",
      "billingAddress": {
        "line1": "Flat 1 ",
        "line2": "Cauldron house",
        "city": "Bath",
        "region": "Somerset",
        "postcode": "BA1 234"
      },
      "email": "test@test.com",
      "telephone": "0123 456 789",
      "defaultCurrency": "GBP",
      "ip": "212.58.253.67"
    },
    "financialServices": {
      "dateOfBirth": "19870818",
      "surname": "Smith",
      "accountNumber": "123ABC",
      "postCode": "BS20"
    },
    "transaction": {
      "transactionId": "10349373216",
      "merchantRef": "mer_txn_1234551",
      "merchantDescription": "Sample Transaction",
      "status": "SUCCESS",
      "type": "PAYMENT",
      "amount": 1000,
      "consumerSpend": 1000,
      "currency": "GBP",
      "transactionTime": "2014-01-06T22:14:54.895Z",
      "receivedTime": "2014-01-06T22:14:54.895Z",
      "channel": "WEB"
    },
    "history": [
      {
        "transactionStatus": "PENDING",
        "reasonCode": "U100",
        "reasonMessage": "Suspended pending Three D Secure process",
        "timeStamp": "2014-01-06T22:14:58.544Z"
      },
      {
        "transactionStatus": "SUCCESS",
        "reasonCode": "S100",
        "reasonMessage": "Authorised",
        "timeStamp": "2014-01-06T22:15:47.772Z"
      }
    ],
    "followUpStatus": {},
    "link": [
      {
        "rel": "self",
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/transactions/10349373216"
      },
      {
        "rel": "customer",
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/10500"
      },
      {
        "rel": "payment-method",
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/10500/paymentMethods/outY+Gn8TGWwNPBuazginA"
      }
    ]
  },
  {
    "customFields": {
      "fieldState": [
        {
          "name": "measure_CV2_FAILURES",
          "value": "3",
          "transient": false
        },
        {
          "name": "measure_NO_DATA_MATCH",
          "value": "3",
          "transient": false
        },
        {
          "name": "measure_ADDRESS_MATCH_ONLY",
          "value": "0",
          "transient": false
        },
        {
          "name": "measure_TOTAL_CARD_SPEND",
          "value": "3000.00",
          "transient": false
        }
      ]
    },
    "threeDSecure": {
      "enrolmentIndicator": "Y",
      "enrolmentStatus": "ENROLLED",
      "enrolmentDateTime": "2012-02-23T11:16:02.000Z"
    },
    "customer": {
      "merchantRef": "mer_cust_131241412",
      "id": "10500",
      "displayName": "Mr O Whatasillyname",
      "billingAddress": {
        "line1": "Flat 1 ",
        "line2": "Cauldron house",
        "city": "Bath",
        "region": "Somerset",
        "postcode": "BA1 234"
      },
      "email": "test@test.com",
      "telephone": "0123 456 789",
      "defaultCurrency": "GBP",
      "ip": "212.58.253.67"
    },
    "financialServices": {
      "dateOfBirth": "19870818",
      "surname": "Smith",
      "accountNumber": "123ABC",
      "postCode": "BS20"
    },
    "transaction": {
      "transactionId": "10349111080",
      "merchantRef": "mer_txn_1234551",
      "merchantDescription": "Sample Transaction",
      "status": "EXPIRED",
      "type": "PAYMENT",
      "amount": 1000,
      "consumerSpend": 0,
      "currency": "GBP",
      "transactionTime": "2014-01-06T21:45:58.653Z",
      "receivedTime": "2014-01-06T21:45:58.653Z"
    },
    "history": [
      {
        "transactionStatus": "PENDING",
        "reasonCode": "U100",
        "reasonMessage": "Suspended pending Three D Secure process",
        "timeStamp": "2014-01-06T21:45:59.542Z"
      },
      {
        "transactionStatus": "EXPIRED",
        "reasonCode": "T100",
        "reasonMessage": "Transaction expired by timeout",
        "timeStamp": "2014-01-06T22:12:41.737Z"
      }
    ],
    "followUpStatus": {},
    "link": [
      {
        "rel": "self",
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/transactions/10349111080"
      },
      {
        "rel": "customer",
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/10500"
      }
    ]
  },
  {
    "paymentMethod": {
      "card": {
        "cardFingerprint": "sj4/LqPLxB3yx6W6cwdh+Flj++k=",
        "new": false,
        "cardType": "VISA_DEBIT",
        "cardUsageType": "DEBIT",
        "cardScheme": "VISA",
        "maskedPan": "100035******0007",
        "expiryDate": "0115",
        "issuer": "Lloyds",
        "issuerCountry": "GBR",
        "cardNickname": "John",
        "validDate": "1111"
      },
      "billingAddress": {
        "line1": "Flat 1 ",
        "line2": "Cauldron house",
        "line3": "A Street",
        "line4": "Twertonia",
        "city": "Bath",
        "region": "Somerset",
        "postcode": "BA1 234",
        "country": "United Kingdom",
        "countryCode": "GBR"
      },
      "paymentClass": "CARD"
    },
    "customFields": {
      "fieldState": [
        {
          "name": "measure_CV2_FAILURES",
          "value": "3",
          "transient": false
        },
        {
          "name": "measure_NO_DATA_MATCH",
          "value": "3",
          "transient": false
        },
        {
          "name": "measure_ADDRESS_MATCH_ONLY",
          "value": "0",
          "transient": false
        },
        {
          "name": "measure_TOTAL_CARD_SPEND",
          "value": "3000.00",
          "transient": false
        }
      ]
    },
    "customer": {
      "merchantRef": "mer_cust_131241412",
      "id": "10500",
      "displayName": "Mr O Whatasillyname",
      "billingAddress": {
        "line1": "Flat 1 ",
        "line2": "Cauldron house",
        "city": "Bath",
        "region": "Somerset",
        "postcode": "BA1 234"
      },
      "email": "test@test.com",
      "telephone": "0123 456 789",
      "defaultCurrency": "GBP"
    },
    "financialServices": {
      "dateOfBirth": "19870818",
      "surname": "Smith",
      "accountNumber": "123ABC",
      "postCode": "BS20"
    },
    "transaction": {
      "transactionId": "10349111079",
      "merchantRef": "mer_txn_1234551",
      "merchantDescription": "Sample Transaction",
      "status": "FAILED",
      "type": "PAYMENT",
      "amount": 1000,
      "consumerSpend": 0,
      "currency": "GBP",
      "transactionTime": "2014-01-06T21:45:08.843Z",
      "receivedTime": "2014-01-06T21:45:08.843Z"
    },
    "history": [
      {
        "transactionStatus": "FAILED",
        "reasonCode": "A120",
        "reasonMessage": "Invalid gaming territories country conditions. customerIp not available but cardIssuingCountry ok.",
        "timeStamp": "2014-01-06T21:45:09.060Z"
      }
    ],
    "followUpStatus": {},
    "link": [
      {
        "rel": "self",
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/transactions/10349111079"
      },
      {
        "rel": "customer",
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/10500"
      }
    ]
  }
]

Get single transaction by ID


GET /acceptor/rest/transactions/{instId}/{transactionId}
{}

HTTP/1.1 200
{
  "processing": {
    "authResponse": {
      "statusCode": "00",
      "acquirerName": "HSBC Merchant Services Domestic",
      "message": "ACQUIRER OK",
      "authCode": "authCode",
      "gatewayReference": "4300200042810617-PASS",
      "gatewaySettlement": "2014-10-29",
      "gatewayCode": "1",
      "gatewayMessage": "ACCEPTED",
      "avsAddressCheck": "NOT_MATCHED",
      "avsPostcodeCheck": "NOT_MATCHED",
      "cv2Check": "NOT_MATCHED",
      "status": "AUTHORISED"
    },
    "route": "MCPE"
  },
  "paymentMethod": {
    "card": {
      "cardToken": "outY+Gn8TGWwNPBuazginA",
      "cardFingerprint": "sj4/LqPLxB3yx6W6cwdh+Flj++k=",
      "new": false,
      "cardType": "VISA_DEBIT",
      "cardUsageType": "DEBIT",
      "cardScheme": "VISA",
      "maskedPan": "100035******0007",
      "expiryDate": "0115",
      "issuer": "Lloyds",
      "issuerCountry": "GBR",
      "cardNickname": "John",
      "validDate": "1111"
    },
    "billingAddress": {
      "line1": "Flat 1 ",
      "line2": "Cauldron house",
      "line3": "A Street",
      "line4": "Twertonia",
      "city": "Bath",
      "region": "Somerset",
      "postcode": "BA1 234",
      "country": "United Kingdom",
      "countryCode": "GBR"
    },
    "paymentClass": "CARD"
  },
  "customFields": {
    "fieldState": [
      {
        "name": "measure_CV2_FAILURES",
        "value": "3",
        "transient": false
      },
      {
        "name": "measure_NO_DATA_MATCH",
        "value": "3",
        "transient": false
      },
      {
        "name": "measure_ADDRESS_MATCH_ONLY",
        "value": "0",
        "transient": false
      },
      {
        "name": "measure_TOTAL_CARD_SPEND",
        "value": "3000.00",
        "transient": false
      }
    ]
  },
  "threeDSecure": {
    "scheme": "VERIFIED_BY_VISA",
    "status": "AUTHENTICATED",
    "enrolmentIndicator": "Y",
    "enrolmentStatus": "ENROLLED",
    "enrolmentDateTime": "2012-02-23T11:16:02.000Z",
    "authenticationIndicator": "Y",
    "authenticationStatus": "AUTHENTICATED",
    "xid": "00000000003030821144",
    "eci": "05"
  },
  "customer": {
    "merchantRef": "mer_cust_131241412",
    "id": "10500",
    "displayName": "Mr O Whatasillyname",
    "billingAddress": {
      "line1": "Flat 1 ",
      "line2": "Cauldron house",
      "city": "Bath",
      "region": "Somerset",
      "postcode": "BA1 234"
    },
    "email": "test@test.com",
    "telephone": "0123 456 789",
    "defaultCurrency": "GBP",
    "ip": "212.58.253.67"
  },
  "financialServices": {
    "dateOfBirth": "19870818",
    "surname": "Smith",
    "accountNumber": "123ABC",
    "postCode": "BS20"
  },
  "transaction": {
    "transactionId": "10349373216",
    "merchantRef": "mer_txn_1234551",
    "merchantDescription": "Sample Transaction",
    "status": "SUCCESS",
    "type": "PAYMENT",
    "amount": 1000,
    "consumerSpend": 0,
    "currency": "GBP",
    "transactionTime": "2014-01-06T22:14:54.895Z",
    "receivedTime": "2014-01-06T22:14:54.895Z",
    "channel": "WEB"
  },
  "history": [
    {
      "transactionStatus": "PENDING",
      "reasonCode": "U100",
      "reasonMessage": "Suspended pending Three D Secure process",
      "timeStamp": "2014-01-06T22:14:58.544Z"
    },
    {
      "transactionStatus": "SUCCESS",
      "reasonCode": "S100",
      "reasonMessage": "Authorised",
      "timeStamp": "2014-01-06T22:15:47.772Z"
    }
  ],
  "followUpStatus": {},
  "link": [
    {
      "rel": "self",
      "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/transactions/10349373216"
    },
    {
      "rel": "customer",
      "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/10500"
    },
    {
      "rel": "payment-method",
      "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/10500/paymentMethods/outY+Gn8TGWwNPBuazginA"
    }
  ]
}

API Endpoint

endpoint: /acceptor/rest/transactions/{instId}/{transactionId}

method: GET

summary: show Transaction

parameters:

instId

long

The installation id

transactionId

string

transaction Id

response:

{
history [	array
{
transactionStatus	string Possible Values: SUCCESS, FAILED, PENDING, EXPIRED, CANCELLED, VOIDED
reasonCode	string
reasonMessage	string
timeStamp	string Date and time in ISO-8601 format.
}
]
followUpStatus {
status [	array
{
name	string Possible Values: REFUNDED, PARTIALLY_REFUNDED, REPEATED, CANCELLED, CAPTURED, REVERSED
followUpTransaction [	array
{
transactionId	string
timeStamp	string Date and time in ISO-8601 format.
}
]
}
]
}
fraudGuard {
score	float The score assigned by FraudGuard. Refer to FraudGuard documentation for further details.
geoLocation {
ipCountry {
country	string The three-character ISO code representing the country of origin, determined by the IP address.
ipValues	string Possible Values: PROXY, SATELLITE, EUROPE, APAC Categorisation of the IP address used.
}
ipCity	string The origin city of the transaction request, determined by the IP address.
ipRegion	string The origin state or province of the transaction request, determined by the IP address.
distanceFromIpToBilling	int The physical distance from the billing address to the location determined from the IP address.
}
channelRisk {
freeEmailProvider	boolean Whether or not the email address provided in the transaction request is hosted by a free provider.
openProxyRisk	float A rating of how likely it is that the transaction request originated from behind an open proxy.
}
recentActivity {
last24Hours {
attemptsViaIp	int How many transaction requests have originated from this IP address in the last 24 hours.
attemptsOnCard	int How many transaction requests have used this card in the last 24 hours.
}
}
identityMorphing {
againstAddress	int Measure of identity morphing against the address.
againstEmail	int Measure of identity morphing against the email address.
againstCard	int Measure of identity morphing against the card details.
againstIp	int Measure of identity morphing against the IP address.
}
}
sessionId	string
transaction {
transactionId	string Our ID for the transaction.
deferred	boolean Indicates if the Payment capture is deferred.
merchantRef	string Your reference for the transaction.
merchantDescription	string The description of the transaction provided in the request.
status	string Possible Values: SUCCESS, FAILED, PENDING, EXPIRED, CANCELLED, VOIDED The current state of the transaction.
type	string Possible Values: PAYMENT, PREAUTH, PAYOUT, REFUND, CAPTURE, CANCEL, REPEAT, CASH_ISSUE, CASH_PAYMENT Indicates the type of the transaction.
amount	float Indicates the requested amount of the transaction.
consumerSpend	float Indicates the actual amount of the transaction. This will be zero for any type of INITIALIZE transaction, deferred transactions, and rejected transactions.
currency	string Indicates the currency of the transaction. Use the 3 character ISO-4217 code.
transactionTime	string The date and time we processed the transaction in ISO-8601 format.
receivedTime	string The date and time we received the transaction in ISO-8601 format.
commerceType	string Possible Values: ECOM, MOTO, CNP The Commerce Type of the transaction.
channel	string Possible Values: WEB, MOBILE, SMS, RETAIL, MOTO, IVR, OTHER The Sales Channel of the transaction.
relatedTransaction {	This field is not applicable for Payments. In case of Refunds it indicates the transaction that was refunded.
transactionId	string Our ID for the transaction that was original.
merchantRef	string Your reference for the transaction that was original.
}
}
locale	string
processing {
route	string The name of the processing engine your transaction was submitted to.
voidSuccessful	boolean Indicates if the transaction was voided by a Post Authorisation callback.
authResponse {
statusCode	string The code for the status received from the authoriser, if applicable.
acquirerReference	string The reference received from the authoriser for your transaction, if applicable.
acquirerName	string Name of the authoriser, if applicable.
message	string The message received from the authoriser, if applicable.
authCode	string The code received from the authoriser, if applicable.
gatewayReference	string The reference received from the processing engine.
gatewaySettlement	string The date the processing engine will settle the transaction. in YYYY-MM-DD format.
gatewayCode	string The code for the status received from the processing engine.
gatewayMessage	string The message received from the processing engine.
avsAddressCheck	string Possible Values: NOT_CHECKED, FULL_MATCH, NOT_MATCHED, NOT_PROVIDED Results for the Address Verification checks, if applicable, if applicable.
avsPostcodeCheck	string Possible Values: NOT_CHECKED, FULL_MATCH, NOT_MATCHED, NOT_PROVIDED Results for the PostCode Verification checks, if applicable.
cv2Check	string Possible Values: NOT_CHECKED, MATCHED, NOT_MATCHED Results for the CV2 Verification checks, if applicable.
gatewayStatus	string The status received from the processing engine.
status	string Possible Values: AUTHORISED, DECLINED, REVERSED, REVERSE_FAILED, ERROR The status received from the authoriser, if applicable.
}
}
threeDSecure {
authenticationStatus	string Possible Values: AUTHENTICATED, ATTEMPTED, FAILED, ERROR The status of 3DS authentication check.
authenticationIndicator	string Possible Values: Y, A, N, U The indicator of the 3DS authentication status.
enrolmentDateTime	string The date and time the 3DS enrolment check was performed in ISO-8601 format.
scheme	string The scheme that processed the transaction for 3DS.
eci	string The eCommerce indicator for the transaction.
status	string Possible Values: AUTHENTICATED, BYPASSED, FAILED, NOT_ENROLLED, ENROLMENT_CHECK_FAILURE, INCOMPLETE, NOT_AVAILABLE, NOT_IMPLEMENTED The overall 3DS result for the transaction.
xid	string The ID used during 3DS processing.
enrolmentIndicator	string Possible Values: Y, N, U The indicator of the 3DS enrolment status.
enrolmentStatus	string Possible Values: ENROLLED, NOT_ENROLLED, UNABLE_TO_AUTHENTICATE The status of the 3DS enrolment check.
}
customer {
id	string The ID given to the Customer by the processing engine.
email	string Email address for the Customer.
merchantRef	string Your reference for the Customer.
defaultCurrency	string
dob	string Date of birth for the Customer.
billingAddress {	The billing address of the Customer. Will be used for AVS checks.
line1	string Line 1 of the Customer’s billing address.
line2	string Line 2 of the Customer’s billing address.
line3	string Line 3 of the Customer’s billing address.
line4	string Line 4 of the Customer’s billing address.
city	string City of the Customer’s billing address.
region	string Region of the Customer’s billing address.
postcode	string Post Code of the Customer’s billing address.
country	string Country name of the Customer’s billing address.
countryCode	string The 3 character ISO-3166-1 code for the Customer’s billing address country.
}
displayName	string The Customer’s name.
telephone	string Telephone number for the Customer.
ip	string The Customer’s IP address.
}
financialServices {
dateOfBirth	string The Customer’s date of birth.
surname	string The Customer’s surname.
accountNumber	string The loan account number provided by the merchant, to the Customer.
postCode	string The postal code of the Customer’s billing address.
}
paymentMethod {
paymentClass	string The classification of payment method used. Eg. Card, Cash, PayPal
registered	boolean Indicates that the customer choose to register this card payment method. This field will not be present for non-card payment methods.
isPrimary	boolean Indicates if this was Customer’s primary registered payment method.
card {
issueNumber	string The issue number of the card used in the request.
cardToken	string The token for the card.
cardHolderName	string The Cardholder’s name.
issuer	string The Issuer of the card.
maskedPan	string The masked card number. eg. 123456******1234
cardFingerprint	string An identifier for the card number. If multiple customers register cards with the same PAN they will get different card tokens, but the card fingerprint will be the same for them all.
issuerCountry	string The masked card number. eg. 123456******1234
expiryDate	string The expiry date of the card. Formatted as MMYY.
validDate	string The valid from date of the card. Formatted as MMYY.
cardType	string The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX.
cardUsageType	string The usage type of card. Eg. DEBIT, CREDIT.
cardScheme	string The scheme of card. Eg. VISA, MASTERCARD, AMEX.
cardCategory	string The category of card. Eg. CREDIT, DEBIT, CORPORATE, BUSINESS.
cardNickname	string The name the Customer provided for their Card to allow easy selection where they registered multiple cards.
}
billingAddress {	The billing address of the Customer. Will be used for AVS checks.
line1	string Line 1 of the Customer’s billing address.
line2	string Line 2 of the Customer’s billing address.
line3	string Line 3 of the Customer’s billing address.
line4	string Line 4 of the Customer’s billing address.
city	string City of the Customer’s billing address.
region	string Region of the Customer’s billing address.
postcode	string Post Code of the Customer’s billing address.
country	string Country name of the Customer’s billing address.
countryCode	string The 3 character ISO-3166-1 code for the Customer’s billing address country.
}
}
}

Developer Documents