- 23 Nov 2023
- 4 Minutes to read
- Print
- DarkLight
Transaction Data Dictionary
- Updated on 23 Nov 2023
- 4 Minutes to read
- Print
- DarkLight
Attribute | Constraint | Description |
id | String | The primary key in service store; to be generated as concatenation of transactionId + . + eventId |
suspendRefundCount | integer | If a dispute arises in Evolve, this field will be updated to prevent the transaction from being refunded, thus avoiding any duplicate reversals. |
eventId | String | The identifier of the event |
eventType |
| REQUEST, SUBMIT, RESPONSE, REJECT, RELEASE, CAPTURE, CANCEL, REFUND, |
DISPUTE RECEIVED, DISPUTE APPLIED, DISPUTE REVERSED, BILLING, | ||
REMITTANCE | ||
summary.visible | Boolean | Indicates if the record should be visible in the merchant portal view. |
summary.type | One of | The type to be displayed for the transaction event |
| ||
PAYMENT, AUTHORISATION, CAPTURE, REFUND, VERIFY | ||
summary.status | One of | The status to be displayed for the transaction event |
| ||
DECLINED, SUCCESSFUL, REJECTED, CANCELLED, FAILED, SUBMITTED, PENDING, REFERRED | ||
Maximum length: 150. | The name of the customer | |
customer.emailAddress | Maximum length: 320. | The email address for the customer |
| ||
customer.address.line1 | Maximum length: 150. |
|
| ||
customer.address.line2 | Maximum length: 150. |
|
| ||
Maximum length: 150. |
| |
| ||
customer.address.postcode | Maximum length: 10. |
|
| ||
paymentMethod.providerResponse.methodUsed | String | The ID of the payment method used to process the transaction. In some instances, this can differ from the method Id. For example, when no method Id is provided in the request as the method has/will be selected by a payer and is held in session data. |
|
| |
| Another example is where the "gateway" payment method is specified in which case the payer will select the payment method when interacting with the provider. | |
|
| |
| This field is not used by the system and is provided to allow for classification in reporting. | |
|
| |
| Possible values are any of the valid values for method Id | |
| CARD, PAYPAL_DIRECT, PAY_BY_BANK_ACCOUNT, VISA_CHECKOUT, APPLE_PAY, GOOGLE_PAY | |
| String | Indicates the outcome of the submission to the provider |
paymentMethod.providerResponse.result |
| |
| NONE | |
| No response - either response not received yet or not available | |
| UNKNOWN | |
| Result of provider interaction is unknown | |
| AUTHORISED | |
| Provider authorised the request | |
| DECLINED | |
| Provider declined the request | |
| FAILED | |
| There was an error interacting with the endpoint | |
| FRAUD | |
| The provider responded indicating the request is suspected as fraudulent. | |
| VERIFIED | |
| The provider verified the card to setup a continuous payment authority (CPA) recurring payment. | |
paymentMethod.maskedCredentials | String | Payment identifier (PAN or email address or anything else) masked for security purposes: |
| PAN with only first 6 and last 4 digits visible for card, Google/Apple Pay | |
| Email first 2 characters of the prefix - to be added for PayPal | |
paymentMethod.card.cardScheme | String | One of a pre-defined set of card scheme identifiers |
|
| |
| VISA, MASTERCARD, AMERICAN_EXPRESS, DISCOVER, JCB and UNIONPAY | |
paymentMethod.card.cardType | String | One of the pre-defined sets of card type identifiers |
|
| |
| CREDIT, DEBIT, CHARGE, STORE and PREPAY | |
paymentMethod.card.cardHolderName | Maximum length: 50. | The name of the card holder |
| ||
paymentMethod.card.expiryYear | Pattern: [0-9][0-9] | The expiry year of the card in YY format |
| ||
paymentMethod.card.expiryMonth | Pattern: [0-1][0-9] | The expiry month of the card in MM format |
| ||
paymentMethod.card.authCode | String | The Auth code for the authorisation |
| ||
paymentMethod.card.avsAddressCheckResult | String | Result of the AVS address check (if available) |
| ||
| String | Result of the AVS postcode check (if available) |
paymentMethod.card.avsPostcodeCheckResult | ||
| String | Result of the CV2 check (if available) |
paymentMethod.card.cv2CheckResult | ||
| String | The status of the 3DS authentication check
SUCCESSFUL, FAILED, ERROR, ATTEMPTED and UNAVAILABLE |
paymentMethod.card.threeDSResult.authenticationStatus | ||
| String | The indicator of the 3DS authentication status
“Y”, “A”, “U” and “N” |
paymentMethod.card.threeDSResult.authenticationIndicator | ||
| String | The status of the 3DS enrolment check
ENROLLED, NOT_ENROLLED and UNAVAILABLE |
paymentMethod.card.threeDSResult.enrolmentStatus | ||
| String | The indicator of the 3DS enrolment status
“Y”, “U” and “N” |
paymentMethod.card.threeDSResult.enrolmentIndicator | ||
| String | The date and time the 3DS enrolment check was performed |
paymentMethod.card.threeDSResult.checkedAt | ||
| String | The scheme that processed the transaction for 3DS authentication
VISA, MASTERCARD and AMEX |
paymentMethod.card.threeDSResult.scheme | ||
paymentMethod.card.threeDSResult.status | String |
|
| ||
paymentMethod.openBanking.remittanceReference | String | Unique reference provided by merchant that appears on payers bank statement. Note: Open Banking payments have “EV+transactionid’ |
| ||
paymentMethod.openBanking .debtorAccount.accountNumber | String | Account number of the financial account the payment relates to |
| ||
paymentMethod | String | Payers’s bank name |
.openBanking.debtorAccount.bankName | ||
transaction.transactionId | Number | System generated unique number for the transaction. |
|
| |
|
Instant |
Date and time the event was received by the payment service. |
transaction.receivedDateTime |
| |
| Is provided as GMT0 time zone in ISO8601 format | |
|
| |
| YYYYMMDDTHHMMSS[.000]Z | |
| Decimal(17.2) | The amount for the transaction. The amount value may represent different things for different event types. For example, for a capture it will represent the amount captured. |
transaction.amount | ||
| Maximum length: 5000. | An event specific description. |
transaction.description | ||
| Maximum length: 150. | Non unique merchant provided reference for the transaction |
transaction.merchantReference | ||
transaction.currency | Pattern: [A-Z][A-Z][A-Z] | 3-character ISO4217 currency code identifying the currency the amount field represents |
| Defaults to GBP if not provided | |
transaction.status |
| Provides the status of the transaction at the point of processing of this request was completed. The following are possible values that may be returned for the transaction status. Please refer to the transaction processing model for more details of how and when various statuses of a transaction may occur. |
| ||
REQUESTED | ||
The transaction has been recorded but not submitted to the provider. Request plugins have executed, and any results are included in the response. | ||
SUBMITTED | ||
The transaction has been submitted to the provider, but no response has yet been received. | ||
REFERRED | ||
The transaction has been referred and will be held until released. | ||
COMPLETE | ||
The transaction has completed processing & no more funds will be captured. | ||
REJECTED | ||
A referred transaction has been rejected and will not be processed. | ||
FAILED | ||
A failure has occurred either within the payment engine or reported by a provider. | ||
AUTHORISED | ||
The provider has responded and indicated that the funds have been authorised. | ||
CANCELLED | ||
The transaction has been cancelled. | ||
PART_CAPTURED | ||
The transaction has been partially captured & remains open for further captures up to the maximum amount authorised. | ||
ACTION_REQUESTED | ||
A merchant instruction most be completed before processing can be completed. Check the merchant instructions object for details and re-submit when action has been performed. | ||
Pattern: ^(WEB|MOBILE|IVR|POS|TELEPHONE|OTHER) | Indicates the channel through which the transaction has been processed. Currently allowed values are | |
| ||
WEB (default) | ||
The transaction relates to an online transaction. | ||
MOBILE | ||
The transaction was processed via a mobile device (tablet / phone) | ||
IVR | ||
The transaction was processed via an automated telephone system interaction | ||
POS | ||
The transaction is a point-of-sale transaction. | ||
TELEPHONE | ||
The transaction was processed via telephone (non-automated) | ||
OTHER | ||
The transaction was processed by a channel not falling into any of the above categories | ||
| ||
At present only WEB is likely to be used, other values can be provided and are only categorisation labels for reporting (they do not functionally impact the processing of the transaction) | ||
transaction.recurring |
| Indicates if this is an initial or subsequent recurring transaction. Options are |
| ||
NONE (Default) | ||
Not a recurring transaction. | ||
INITIAL | ||
This is an initial recurring transaction. Further transactions will be performed. | ||
SUBSEQUENT | ||
This is a subsequent transaction following on from an initial transaction. | ||
| Maximum length: 150. | Merchant defined. Intended to provide a human readable description of the item. Note: This value is likely to be used in display in merchant portals when viewing details about items. |
purchases.description | ||
purchases.totalAmount | Decimal (17.2) | Total amount for the full quantity (instead of the unit amount) |
| ||
| Number | Merchant defined. Intended to indicate the quantity of the items. |
purchases.quantity | ||
totalCount | Long | Total number of records matching the request criteria |