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": "[email protected]",
"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": "[email protected]",
"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": "[email protected]",
"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": "[email protected]",
"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
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. |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| 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. |
| } | |