GET transaction
GET
Transaction is used to return a transaction and its status from axept® Connect Cloud. It can be used both for a single transaction, typically used in non-webhook flows, or for wider transaction searches and status updates and for limited reporting
GET
/transaction Request
URLs
An HTTP GET
should be sent to the above URLs with the below details:
POST /transaction - Header | |||
---|---|---|---|
Field Name | State | Data Type | Description |
Authorization | Mandatory | String | This field should be populated with the bearer token returned in the Authentication step. The format is ["Bearer "][Bearer Token] e.g. Bearer eyJhbGciOiJIUzI1NiIsIn... (truncated) Note the space between "Bearer" and the token. |
POST /transaction - Parameters | |||
uti | Mandatory | String | The Unique transaction Id, provided by your EPOS solution when the transaction was started, and returned in the Payment Response. |
GET
/transaction Request
Example GET https://optomany-axeptconnectcloudmerchant-ppe.azurewebsites.net/Transaction/604f2540-5af9-4f60-a889-449bd5dd17d5
Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn.. [truncated]
User-Agent: PostmanRuntime/7.31.3
Accept: */*
Postman-Token: 0815a846-8c8a-44f4-87f8-e0795e57e435
Host: optomany-axeptconnectcloudmerchant-ppe.azurewebsites.net
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
GET
/transaction Response
A successful response will return 200
OK and the following data fields. Transactions that are not at Complete
status will not show all these fields.
caution
A transaction approval status must only be confirmed once status
is at Complete
.
GET /transaction Response | ||||||||
---|---|---|---|---|---|---|---|---|
Field Name | Data Type | Description | ||||||
uti | GUID | Unique client initiate GUID to represent the transaction. | ||||||
transType | String | Indicates how the transaction should be processed. | ||||||
transApproved | Boolean | Indicates whether the transaction was approved. | ||||||
transApproved is the primary indicator of whether the transaction was successful. It should be used by EPOS logic in conjunction with status = complete to determine the overall status of the transaction to the Consumer. | ||||||||
transPartiallyApproved | Boolean | Indicates whether the transaction was partially approved. | ||||||
transCancelled | Boolean | Indicates whether the transaction was cancelled. | ||||||
amountTrans | Integer | Amount of the transaction in minor units not including cashback/tips etc. | ||||||
amountGratuity | Integer | Amount of the gratuity in minor units. | ||||||
amountCashback | Integer | Amount of the Cashback in minor units. | ||||||
cvmSignatureRequired | Boolean | Signifies whether the transaction required the cardholder to perform signature verification. | ||||||
cvmPinVerified | Boolean | Signifies whether the transaction required the cardholder to complete PIN verification. | ||||||
transCurrencyCode | String | Provides a 3-character currency code for the transaction. The values provided comply with ISO4217 alphabetic code. | ||||||
terminalId | String | Reflects the terminal identifier (TID) used when processing the transaction | ||||||
merchantId | String | Reflects the merchant identifier (MID) used when processing the transaction. | ||||||
softwareVersion | String | Provides the software version of axept PRO. | ||||||
receiptNumber | String | The receipt number for this transaction. | ||||||
retrievalReferenceNumber | String | The retrieval reference number for this transaction. | ||||||
paymentId | String | This is an identifier for the transaction from DNA Payments’ central host. | ||||||
responseCode | String | The 2-character response code from the acquirer. | ||||||
stan | String | The system trace audit number (EFT Sequence Number). | ||||||
authorisationCode | String | The authorisation code returned from the acquirer. | ||||||
merchantTokenId | String | The DNA Payments token for the card used to complete the transaction. | ||||||
cardPan | String | The masked PAN (Primary Account Number) of the card. This will be in ‘all starred bar the last four digits’ format. | ||||||
cardExpiryDate | String | The expiry date of the card used for the transaction in ‘YYMM’ format. | ||||||
cardStartDate | String | The start date of the card used for the transaction in ‘YYMM’ format (if available). | ||||||
cardScheme | String | The name of the card scheme used. | ||||||
cardPanSequenceNumber | String | The PAN sequence number (if available). | ||||||
cardType | String | The method used to obtain the card details. | ||||||
emvAid | String | If the card was captured via EMV or Contactless, this field will provide the application identifier of the presented card. | ||||||
emvTsi | String | If the card was captured via EMV or Contactless, this field will provide the EMV standards Transaction Status Information. | ||||||
emvTvr | String | If the card was captured via EMV or Contactless, this field will provide the EMV standards Transaction Verification Results. | ||||||
emvCardholderName | String | If the card was captured via EMV or Contactless, this field will provide the cardholder name if it has been obtained during EMV processing. | ||||||
emvCryptogram | String | The cryptogram generated as part of the EMV process. | ||||||
emvCryptogramType | String | This provides the cryptogram type used during EMV processing for the transaction. | ||||||
errorCode | String | The error code associated with the error details. | ||||||
errorText | String | The error message associated with the error details. | ||||||
reference | String | Client reference assigned to the transaction and echoed back in subsequent operations. | ||||||
merchantLocation | String | This is the address (address line 1 and 2) of the merchant store as set up in the DNA Payments system. | ||||||
merchantName | String | This is the name of the merchant store as set up in the DNA Payments system. | ||||||
transDateTime | DateTime | axept PRO’s UTC date/time stamp for the transaction in ISO 8601-1:2019 format | ||||||
createdDateTime | DateTime | UTC Date/Time the transaction was initiated by the merchant in ISO 8601-1:2019 format | ||||||
merchantStoreId | Integer | DNA Payments issued identifier for the merchant’s store. | ||||||
status | String | The status of the transaction. This will be either:
|
Example GET /transaction Responses
- Open
- InProgress
- Complete - Accepted
- Complete - Cancelled
- Complete - Declined
{
"uti": "4865d11a-2cc8-432a-83f8-de199559eab6",
"transType": "SALE",
"transApproved": false,
"transPartiallyApproved": false,
"transCancelled": false,
"amountTrans": 150,
"amountGratuity": 0,
"amountCashback": 0,
"cvmSignatureRequired": false,
"cvmPinVerified": false,
"cardType": "Test",
"createdDateTime": "2022-12-09T10:03:38.0461774Z",
"merchantStoreId": 10223,
"status": "Open"
}