Skip to main content

Receipt String Data

For integrators that want to generate their own card payment receipts via their EPOS setup, axept® PRO provides the same Merchant and Cardholder receipt fields that it uses to generate its own receipts in a data string. This string data can be obtained from within the body of a GET/transaction response under merchantReceiptData and cardholderReceiptData for each respective receipt type.

FURTHER READING

More information about GET/transaction requests can be found in the GET /transaction section of the Transaction Request section.

The string data under merchantReceiptData and cardholderReceiptData is made up of the elements in the below table

IMPORTANT NOTE

Some fields may not appear merchantReceiptData and cardholderReceiptData contain fields that are specific to their own receipt types, i.e. some fields will only appear on a merchant receipt or cardholder receipt. There are also only certain fields that will appear if configured to require them, for example Dynamic Currency Conversion or Pennies.

String Data Field Table

ValueDescription
addressLine0The Merchant Store Name field from the Merchant Store of the Optomany merchant account.
addressLine1The Address Line 1 field from the Merchant Store of the Optomany merchant account.
addressLine2The Address Line 2 field from the Merchant Store of the Optomany merchant account.
addressLine3The Address Line 3 field from the Merchant Store of the Optomany merchant account.
addressLine4The Town/City field from the Merchant Store of the Optomany merchant account.
addressLine5The County field from the Merchant Store of the Optomany merchant account.
addressLine6The Post Code field from the Merchant Store of the Optomany merchant account.
dateTimeThe date and time of the transaction. Formatted as YYYY-MM-DD HH:MM:SS.
pidThis is an identifier for the transaction from Optomany’s central host (the axept® Platform).
midReflects the merchant identifier used when processing the transaction.
tidReflects the terminal identifier used when processing the transaction.
aidIf the card was captured via EMV or Contactless, this field will provide the application identifier of the presented card.
receiptNoThe receipt number for this transaction.
appSeqNoReserved for future use.
captureMethodThis shows by what means the card information was captured by axept® PRO, e.g. ICC for Chip n PIN.
cardTypeThe capture methods of the card. Possible values are:
EMVThe card was inserted and a chip was read.
MSRThe card was swiped and details captured via a magnetic stripe read.
CTLSThe card details were presented using contactless technology.
ManualThe card number was manually keyed in. Please note that this disabled when operating in Unattended environments but has been documented for completeness.
maskedPanThe masked PAN (Primary Account Number) of the card. The string length reflects the length of the PAN but only the last 4 digits will be provided, the preceding digits are obfuscated with asterisks e.g. ************5454.
transactionTypeProvides the transaction type that was performed:
SALEThis value will result in funds being authorised & debited from the cardholder’s account.
REFUNDThis will result in funds being credited to the cardholders account from the merchant’s account.
AUTHORISATION_ONLYThis will instruct axept® PRO to seek an authorisation for the specified amount(s) on the presented card. If the authorisation is successful, axept® PRO will do nothing further with the funds. The funds will be ring fenced on the consumers account and impact their Available to Spend balance.
REVERSALOnly to be used against a previous AUTHORISATION_ONLY transaction or a PRE-AUTH with a valid 'preauthid'. Should the POS decide that there is no need to take the authorised funds from the consumers account, a reversal should be requested so that the consumer’s account does not have their Available to Spend impacted.
SETTLEMENT_ONLYOnly to be used against a previous AUTHORISATION_ONLY transaction. Should the POS decide that there is a need to take the authorised funds from the consumer’s account, the settlement only will initiate the transfer of the authorised funds.
PRE_AUTHUsed to place a hold on funds being authorised/debited from the cardholder's account.
TOP_UPWhen a further auth/top up is needed to increase the funds being authorised/debited from the cardholder's account the transType will be changed to “TOP_UP”.
COMPLETIONWhen sending the Settlement request – The transType will need to be changed to “COMPLETION” to complete the pre-auth and/or top-up.
amountAmount of the transaction in minor units not including cashback/tips etc. For example, £10.00 would be represented as 1000.
tipAmount of the gratuity in minor units. For example, £5.00 would be represented as 500.
charitableDonationAmount of charitable donation in minor units. For example, £0.50 would be represented as 50.
exchangeRateConversion rate used to obtain the Billing (DCC) Amount. Present only when DCC was accepted.
markupThe Markup % used for the currency exchange. Present only when DCC was accepted.
rateSourceThe FX Rate source. Present only when DCC was accepted.
rrnRetrieval Reference Number used by acquirers for reconciliation purposes. Present only when DCC was accepted.
dccBillingAmountBilling (DCC) Amount. Present only when DCC was accepted.
dccDisclaimerDisclaimer required for receipts. Present only when DCC was accepted.
authenticationResultThe result of the authentication request, e.g. "Authorised" or "Declined".
responseCodeThe 2-digit response code from the acquirer. Common response codes are:
00Approval
02Referral
(which axept® PRO Unattended will treat as a denial)
03Denial
05Denial
21Denial
30Denial
55Denial
63Denial
85Approval
96Denial
98Denial
99Denial
Y1Transaction does not need to go online – offline approved
Z1Transaction does not need to go online – offline denial
Y3Unable to go online – offline approved
Z3Unable to go online – offline denial
verificationDetailsCardholder verification method used for the transaction, e.g. "CARDHOLDER PIN VERIFIED".
debitTxtFirst part of text containing confirmation of account debit, required for Merchant Receipts.
Only present on Merchant receipts.
transactionAmountShownSecond part of text containing confirmation of account debit, required for Merchant Receipts.
Only present on Merchant receipts.
authCodeThe authorisation code returned from the acquirer (e.g. 123ABC).
referenceThis reference supplied by the integrated client when the transaction was initiated.
receiptTypeText that indicates the type of printed receipt, choice between "**MERCHANT COPY**" or "**CARDHOLDER COPY**"
retainReceiptText informing the customer to retain Cardholder Receipt for records.
Only present on Cardholder receipts.
penniesTxt1First part of text for charity disclaimer when taking donations. Present only when Pennies setup.
penniesTxt2Second part of text for charity disclaimer when taking donations. Present only when Pennies setup.
penniesThank you message containing the donation value of the transaction. Present only when Pennies setup.

Example

The below is an extract from a GET/transaction response body showing the merchantReceiptData and cardholderReceiptData strings as they would appear.

    "merchantReceiptData": {
"addressLine0": "axept PRO",
"addressLine1": "Address Line 1",
"addressLine2": "Address Line 2",
"addressLine4": "Town",
"addressLine5": "County",
"addressLine6": "AB12 3CD",
"dateTime": "14/11/2025 12:42:54",
"pid": "40836/21",
"mid": "82699900002",
"tid": "03400218",
"aid": "A0000000041010",
"receiptNo": "15",
"appSeqNo": "0",
"captureMethod": "ICC",
"cardType": "MasterCard",
"maskedPan": "************1707",
"transactionType": "SALE",
"amount": "£ 100.00",
"tip": "£ 3.05",
"charitableDonation": "£ 0.05",
"exchangeRate": " 1 GBP=5112.605 COP",
"markup": "4.0%",
"rateSource": "Visa",
"rrn": "531874025374",
"dccBillingAmount": "527,109.55",
"dccDisclaimer": "I have been offered a choice of currencies and agree to pay in COP\nThis currency conversion service is provided to the merchant by DNA Payments",
"authenticationResult": "AUTHORISED",
"responseCode": "00",
"verificationDetails": "CARDHOLDER PIN VERIFIED",
"debitTxt": "Please debit my account with",
"transactionAmountShown": "Transaction Amount Shown",
"authCode": "386586",
"reference": "TEST",
"receiptType": "**MERCHANT COPY**",
"penniesTxt1": "Charity Information",
"penniesTxt2": "www.pennies.org.uk",
"pennies": "Thank you for your donation of £ 0.05"
},
"cardholderReceiptData": {
"addressLine0": "axept PRO",
"addressLine1": "Address Line 1",
"addressLine2": "Address Line 2",
"addressLine4": "Town",
"addressLine5": "County",
"addressLine6": "AB12 3CD",
"dateTime": "14/11/2025 12:42:54",
"pid": "40836/21",
"mid": "*******0002",
"tid": "****0218",
"aid": "A0000000041010",
"receiptNo": "15",
"appSeqNo": "0",
"captureMethod": "ICC",
"cardType": "MasterCard",
"maskedPan": "************1707",
"transactionType": "SALE",
"amount": "£ 100.00",
"tip": "£ 3.05",
"charitableDonation": "£ 0.05",
"exchangeRate": " 1 GBP=5112.605 COP",
"markup": "4.0%",
"rateSource": "Visa",
"rrn": "531874025374",
"dccBillingAmount": "527,109.55",
"dccDisclaimer": "I have been offered a choice of currencies and agree to pay in COP\nThis currency conversion service is provided to the merchant by DNA Payments",
"authenticationResult": "AUTHORISED",
"responseCode": "00",
"verificationDetails": "CARDHOLDER PIN VERIFIED",
"authCode": "386586",
"reference": "TEST",
"receiptType": "**CARDHOLDER COPY**",
"retainReceipt": "PLEASE RETAIN RECEIPTS",
"penniesTxt1": "Charity Information",
"penniesTxt2": "www.pennies.org.uk",
"pennies": "Thank you for your donation of £ 0.05"
}