3.10. Receipt and message templates¶
Both receipt and message templates must be sent to Apropay support for installation.
Message server must be specified on Project or End point level.
Apropay supports receipt and message delivery to customer after each successful transaction.
Receipts are accessed by unique URL described below. Messages can be sent by SMS or E-mail using merchant message server.
3.10.1. Receipt Template¶
Receipts can be sent only in HTML format.
To view the receipt use sandbox.apropay.com/paynet/view-receipt/ENDPOINT-ID/RECEIPT-ID for staging environment or gate.apropay.com/paynet/view-receipt/ENDPOINT-ID/RECEIPT-ID for production.
Receipt ID can be found in status response.
Receipt template macros¶
| Field Name Macro | Description |
|---|---|
| $!{PAYMENT_FORM_HEADER} | Name on payment form in End Point |
| $!{DATE} | Order date. |
| $!{DESCRIPTION} | Brief order description. |
| $!{AMOUNT} | Amount. |
| $!{CURRENCY} | Currency the transaction is charged in (three-letter currency code). |
| $!{PAYNET_ORDER_ID} | Apropay order id. |
| $!{MERCHANT_ORDER_ID} | Order ID assigned to this order by the Merchant. |
| $!{RRN} | Bank Receiver Registration Number. |
| $!{AUTH_CODE} | Authorization Code. |
| $!{AUTH_RESPONSE_CODE} | A two- to six-digit alphanumeric code provided by the issuer that indicates the authorization response (approval or denial). |
| $!{STATUS} | Order status. |
| $!{SKIN_VERSION} | CSS skin version. |
| $!{BIN} | Bank BIN of customer credit card number. |
| $!{LAST_FOUR_DIGITS} | Last four digits of a card. |
| $!{CARD_TYPE} | Card type. |
| $!{CARDHOLDER_NAME} | Card holder name. |
| $!{DESTINATION_BIN} | Bank BIN of destination credit card number. |
| $!{DESTINATION_LAST_FOUR_DIGITS} | Last four digits of a destination card. |
| $!{DESTINATION_CARD_TYPE} | Destination card type. |
| $!{PAYNET_PROCESSING_DATE} | Apropay processing date. |
| $!{ACQUIRER_PROCESSING_DATE} | Acquirer bank processing date. |
| $!{READER_PROCESSING_DATE} | Reader terminal processing date. |
| $!{TERMINAL_ID} | Terminal ID. |
| $!{EMV_ISSUER_RESPONSE} | A response code to an authorization request sent by the issuer. |
| $!{EMV_TERMINAL_AID_9F06} | Application Identifier terminal. Identifies the application as described in ISO/IEC 7816-5. |
| $!{EMV_TVR_95} | Terminal Verification Results. Status of the different functions as seen from the terminal. |
| $!{EVM_CID_9F27} | Cryptogram Information Data. Indicates the type of cryptogram and the actions to be performed by the terminal. |
| $!{EMV_APP_LABEL_50} | Application Label. Mnemonic associated with the AID according to ISO/IEC 7816-5. |
| $!{EMV_CVR_9F34} | Cardholder Verification Method (CVM) Results. Indicates the results of the last CVM performed. |
| $!{EMV_APP_CRYPTOGRAM_9f26} | Application Cryptogram. Cryptogram returned by the ICC in response of the GENERATE AC command. |
| $!{EMV_PAN_SEQUENCE_5f34} | Application Primary Account Number (PAN) Sequence Number. Identifies and differentiates cards with the same PAN. |
| $!{PIN_OR_SIGNATURE} | Ask for PIN or just have a signature. |
| $!{READER_ENTRY_MODE} | Client authentication configuration in terminal. |
| $!{HAS_SIGNATURE} | Presence of a signature (TRUE or FALSE). |
| $!{RECEIPT_ID} | Receipt ID. |
| $!{RECEIPT_URL} | URI of the current receipt. |
| $!{FUNCTIONS} | Library of functions for working with strings. |
Receipt template example¶
<!DOCTYPE html>
<html>
<body style="font-family:'tahoma';color:#1A407D;">
<div style="font-family:'tahoma';max-width:640px;margin:auto;margin-top:20px;text-align: center;background-color:#F5F6F6;padding:20px;border-top:6px solid #1A407D;border-radius:42px;border-right:1px solid #E7E7E7;border-left:1px solid #E7E7E7;border-bottom:1px solid #E7E7E7;direction:ltr;">
<h1 style="font-weight:900;color:#7D1A40;">
$!AMOUNT $!CURRENCY Paid
</h1>
<p style="font-family:'tahoma';color:#1A407D;font-weight:700;font-size:17px;line-height:20px;">
Hi $!CARDHOLDER_NAME,
<br>
Thank you for your payment through Apropay!
<br>
Here are your transaction details:
</p>
<p style="font-family:'tahoma';color:#1A407D;text-align: left;margin-top:70px;margin-bottom:70px;">
$!CARDHOLDER_NAME
<br>
Transaction # : $!PAYNET_ORDER_ID
<br>
Paid with $!CARD_TYPE ending with $!LAST_FOUR_DIGITS
<br>
$!DATE
</p>
<p style="font-family:'tahoma';color:#1A407D;text-align: left;">
The transaction will appear on your credit card statement as nymeria.
</p>
<div style="height: 2px;background-color:#E7E7E7;margin-top:32px;margin-bottom:32px;"></div>
<br>
<a style="font-family:'tahoma';color:#1A407D;" href="https://site.company_server/"><span>gate.apropay.com</span></a>
<span style="font-family:'tahoma';color:#1A407D;margin-right:16px;margin-left:16px;">Support@gate.apropay.com</span>
</div>
</body>
</html>
3.10.2. Message template¶
Messages can be sent to customer in plain text, SMS or HTML format.
Message template macros¶
| Field Name Macro | Description |
|---|---|
| $!{CARDHOLDER_VALUE} | Card printed name. |
| $!{CARDHOLDER_EMAIL} | Card holder email sent in incoming API request. |
| $!{CARDHOLDER_PHONE} | Card holder phone number sent in incoming API request. |
| $!{CUSTOMER_FULL_NAME} | Customer full name sent by merchant via input parameters. |
| $!{CUSTOMER_FIRST_NAME} | Customer first name sent by merchant via input parameters. |
| $!{CUSTOMER_LAST_NAME} | Customer last name sent by merchant via input parameters. |
| $!{CUSTOMER_COUNTRY_NAME} | Customer country name sent in incoming API request. |
| $!{CUSTOMER_COUNTRY_CODE} | Billing country of customer sent in incoming API request. For example, IL, RU, etc. |
| $!{CUSTOMER_STATE_NAME} | Customer state name sent by merchant via input parameters, if there are any in customer’s country. |
| $!{CUSTOMER_STATE_CODE} | Customer state code sent by merchant via input parameters, if there are any in customer’s country. |
| $!{CUSTOMER_CITY} | Customer city name sent in incoming API request. |
| $!{CUSTOMER_ZIP_CODE} | Customer’s ZIP code. |
| $!{CUSTOMER_ADDRESS1} | Customer address sent in incoming API request. |
| $!{CUSTOMER_ADDRESS2} | Customer address sent in incoming API request, if the additional address was required. |
| $!{AMOUNT} | Amount. |
| $!{GATEDESCRIPTOR} | Gate descriptor, specified in payment gate. |
| $!{ORDERDESCRIPTION} | Order description. |
| $!{CURRENCY} | Currency the transaction is charged in (three-letter currency code). |
| $!{CARD_NUMBER} | 6 + 4 masked card number |
| $!{BIN} | Bank BIN of customer credit card number. |
| $!{LAST_FOUR_DIGITS} | Last four digits of a card. |
| $!{CARD_TYPE} | Card type. |
| $!{PAYNET_ORDER_ID} | Apropay order id. |
| $!{MERCHANT_ORDER_ID} | Order ID assigned to this order by the Merchant. |
| $!{CREATED_DATE} | Transaction creation date in Apropay. |
| $!{CREATED_YEAR} | Transaction creation year in Apropay |
| $!{CREATED_MONTH} | Transaction creation month in Apropay |
| $!{CREATED_DAY} | Transaction creation day in Apropay |
| $!{MERCHANT} | End point display name. |
| $!{MERCHANT_NAME} | Merchant display name. |
| $!{ENDPOINT_ID} | End point ID. |
| $!{PAYMENT_FORM_NAME} | Name on payment form in End Point. |
| $!{RRN} | Bank Receiver Registration Number. |
| $!{APPROVAL_CODE} | Verification code needed to authorize a payment |
| $!{AUTH_RESPONSE_CODE} | A two- to six-digit alphanumeric code provided by the issuer that indicates the authorization response (approval or denial). |
| $!{STATUS} | Status of the order. |
| $!{PAYNET_PROCESSING_DATE} | Apropay processing date (year, month, day and time in MSK timezone). |
| $!{ACQUIRER_PROCESSING_DATE} | Acquirer bank processing date (year, month, day and time in MSK timezone). |
| $!{READER_PROCESSING_DATE} | Reader terminal processing date (year, month, day and time in MSK timezone). |
| $!{TERMINAL_ID} | Terminal ID. |
| $!{EMV_ISSUER_RESPONSE} | A response code to an authorization request sent by the issuer. |
| $!{EMV_TVR_95} | Terminal Verification Results. Status of the different functions as seen from the terminal. |
| $!{EVM_CID_9F27} | Cryptogram Information Data. Indicates the type of cryptogram and the actions to be performed by the terminal. |
| $!{EMV_APP_LABEL_50} | Application Label. Mnemonic associated with the AID according to ISO/IEC 7816-5. |
| $!{EMV_CVR_9F34} | Cardholder Verification Method (CVM) Results. Indicates the results of the last CVM performed. |
| $!{EMV_APP_CRYPTOGRAM_9f26} | Application Cryptogram. Cryptogram returned by the ICC in response of the GENERATE AC command. |
| $!{EMV_PAN_SEQUENCE_5f34} | Application Primary Account Number (PAN) Sequence Number. Identifies and differentiates cards with the same PAN. |
| $!{PIN_OR_SIGNATURE} | Ask for PIN or just have a signature. |
| $!{READER_ENTRY_MODE} | Client authentication configuration in terminal. |
| $!{HAS_SIGNATURE} | Presence of a signature (TRUE or FALSE). |
| $!{RECEIPT_ID} | Receipt ID. |
| $!{RECEIPT_URI} | URN of the current receipt (/view-receipt/ENDPOINT-ID/RECEIPT-ID). |
| $!{PURPOSE} | Any additional information sent by Merchant. |
| $!{MERCHANT_DATA} | Any additional information for this transaction which may be useful in Merchant’s external systems. |
| $!{ENDPOINT_SEQUENCE_VALUE} | Used when there is a sequence of end points, increasing by one in numerical format. |
Message template examples¶
Plain text and SMS template example:
$!{AMOUNT} $!{CURRENCY} Paid
Hi $!{CARDHOLDER_VALUE},
Thank you for your payment through Apropay!
Here are your transaction details:
$!{CARDHOLDER_VALUE}
Transaction # : $!{PAYNET_ORDER_ID}
Paid with $!{CARD_TYPE} ending with $!{LAST_FOUR_DIGITS}
$!{CREATED_DATE}
The transaction will appear on your credit card statement as nymeria.
HTML template example:
<!DOCTYPE html>
<html>
<body style="font-family:'tahoma';color:#1A407D;">
<div style="font-family:'tahoma';max-width:640px;margin:auto;margin-top:20px;text-align: center;background-color:#F5F6F6;padding:20px;border-top:6px solid #1A407D;border-radius:42px;border-right:1px solid #E7E7E7;border-left:1px solid #E7E7E7;border-bottom:1px solid #E7E7E7;direction:ltr;">
<h1 style="font-weight:900;color:#7D1A40;">
$!AMOUNT $!CURRENCY Paid
</h1>
<p style="font-family:'tahoma';color:#1A407D;font-weight:700;font-size:17px;line-height:20px;">
Hi $!CARDHOLDER_VALUE,
<br>
Thank you for your payment through Apropay!
<br>
Here are your transaction details:
</p>
<p style="font-family:'tahoma';color:#1A407D;text-align: left;margin-top:70px;margin-bottom:70px;">
$!CARDHOLDER_VALUE
<br>
Transaction # : $!PAYNET_ORDER_ID
<br>
Paid with $!CARD_TYPE ending with $!LAST_FOUR_DIGITS
<br>
$!CREATED_DATE
</p>
<p style="font-family:'tahoma';color:#1A407D;text-align: left;">
The transaction will appear on your credit card statement as nymeria.
</p>
<div style="height: 2px;background-color:#E7E7E7;margin-top:32px;margin-bottom:32px;"></div>
<br>
<a style="font-family:'tahoma';color:#1A407D;" href="https://site.company_server/"><span>gate.apropay.com</span></a>
<span style="font-family:'tahoma';color:#1A407D;margin-right:16px;margin-left:16px;">Support@gate.apropay.com</span>
</div>
</body>
</html>