.. _receipt_message:
Receipt and message templates
##########################################################
.. contents::
:local:
.. role:: ex
.. role:: code
General Introduction
========================================
| Both receipt and message templates must be sent to Payneteasy support for installation.
| Payneteasy 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 Connecting Party message server.
Receipt Template
====================================
| Receipts can be sent only in HTML format.
| Receipt ID can be found in status response.
.. list-table::
:widths: 50, 50
:header-rows: 1
:class: longtable
* - Integration
- Production
* - :ex:`https://sandbox.payneteasy.com/paynet/view-receipt/ENDPOINT-ID/RECEIPT-ID`
- :ex:`https://gate.payneteasy.com/paynet/view-receipt/ENDPOINT-ID/RECEIPT-ID`
Receipt template macros
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. list-table::
:widths: 48, 52
:header-rows: 1
:class: longtable
* - Field Name Macro
- Description
* - :code:`$!{PAYMENT_FORM_HEADER}`
- Name on payment form in End Point
* - :code:`$!{DATE}`
- Order date.
* - :code:`$!{DESCRIPTION}`
- Brief order description.
* - :code:`$!{AMOUNT}`
- Amount.
* - :code:`$!{CURRENCY}`
- Currency the transaction is charged in (three-letter currency code).
* - :code:`$!{PAYNET_ORDER_ID}`
- Payneteasy order id.
* - :code:`$!{MERCHANT_ORDER_ID}`
- Order ID assigned to this order by the Connecting Party.
* - :code:`$!{RRN}`
- Bank Receiver Registration Number.
* - :code:`$!{AUTH_CODE}`
- Authorization Code.
* - :code:`$!{AUTH_RESPONSE_CODE}`
- A two- to six-digit alphanumeric code provided by the issuer that indicates the authorization response (approval or denial).
* - :code:`$!{STATUS}`
- Order status.
* - :code:`$!{SKIN_VERSION}`
- CSS skin version.
* - :code:`$!{BIN}`
- Bank BIN of customer credit card number.
* - :code:`$!{LAST_FOUR_DIGITS}`
- Last four digits of a card.
* - :code:`$!{CARD_TYPE}`
- Card type.
* - :code:`$!{CARDHOLDER_NAME}`
- Card holder name.
* - :code:`$!{DESTINATION_BIN}`
- Bank BIN of destination credit card number.
* - :code:`$!{DESTINATION_LAST_FOUR_DIGITS}`
- Last four digits of a destination card.
* - :code:`$!{DESTINATION_CARD_TYPE}`
- Destination card type.
* - :code:`$!{PAYNET_PROCESSING_DATE}`
- Payneteasy processing date.
* - :code:`$!{ACQUIRER_PROCESSING_DATE}`
- Acquirer bank processing date.
* - :code:`$!{READER_PROCESSING_DATE}`
- Reader terminal processing date.
* - :code:`$!{TERMINAL_ID}`
- Terminal ID.
* - :code:`$!{EMV_ISSUER_RESPONSE}`
- A response code to an authorization request sent by the issuer.
* - :code:`$!{EMV_TERMINAL_AID_9F06}`
- Application Identifier terminal. Identifies the application as described in ISO/IEC 7816-5.
* - :code:`$!{EMV_TVR_95}`
- Terminal Verification Results. Status of the different functions as seen from the terminal.
* - :code:`$!{EVM_CID_9F27}`
- Cryptogram Information Data. Indicates the type of cryptogram and the actions to be performed by the terminal.
* - :code:`$!{EMV_APP_LABEL_50}`
- Application Label. Mnemonic associated with the AID according to ISO/IEC 7816-5.
* - :code:`$!{EMV_CVR_9F34}`
- Cardholder Verification Method (CVM) Results. Indicates the results of the last CVM performed.
* - :code:`$!{EMV_APP_CRYPTOGRAM_9f26}`
- Application Cryptogram. Cryptogram returned by the ICC in response of the GENERATE AC command.
* - :code:`$!{EMV_PAN_SEQUENCE_5f34}`
- Application Primary Account Number (PAN) Sequence Number. Identifies and differentiates cards with the same PAN.
* - :code:`$!{PIN_OR_SIGNATURE}`
- Ask for PIN or just have a signature.
* - :code:`$!{READER_ENTRY_MODE}`
- Client authentication configuration in terminal.
* - :code:`$!{HAS_SIGNATURE}`
- Presence of a signature (:ex:`TRUE` or :ex:`FALSE`).
* - :code:`$!{RECEIPT_ID}`
- Receipt ID.
* - :code:`$!{RECEIPT_URL}`
- URI of the current receipt.
* - :code:`$!{FUNCTIONS}`
- Library of functions for working with strings.
Receipt template example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. highlight:: html
::
$!AMOUNT $!CURRENCY Paid
Hi $!CARDHOLDER_NAME,
Thank you for your payment through Payneteasy!
Here are your transaction details:
$!CARDHOLDER_NAME
Transaction # : $!PAYNET_ORDER_ID
Paid with $!CARD_TYPE ending with $!LAST_FOUR_DIGITS
$!DATE
The transaction will appear on your credit card statement as nymeria.
gate.payneteasy.com
Support@gate.payneteasy.com
Message template
================================
| Messages can be sent to customer in plain text, SMS or HTML format.
| Message server must be specified on Project or Endpoint level.
.. _template_macros:
Message template macros
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. list-table::
:widths: 55, 45
:header-rows: 1
:class: longtable
* - Field Name Macro
- Description
* - :code:`$!{CARDHOLDER_VALUE}`
- Card printed name.
* - :code:`$!{CARDHOLDER_EMAIL}`
- Card holder email sent in incoming API request.
* - :code:`$!{CARDHOLDER_PHONE}`
- Card holder phone number sent in incoming API request.
* - :code:`$!{CUSTOMER_FULL_NAME}`
- Customer full name sent by connecting party via input parameters.
* - :code:`$!{CUSTOMER_FIRST_NAME}`
- Customer first name sent by connecting party via input parameters.
* - :code:`$!{CUSTOMER_LAST_NAME}`
- Customer last name sent by connecting party via input parameters.
* - :code:`$!{CUSTOMER_COUNTRY_NAME}`
- Customer country name sent in incoming API request.
* - :code:`$!{CUSTOMER_COUNTRY_CODE}`
- Billing country of customer sent in incoming API request. For example, :ex:`IL`, :ex:`RU`, etc.
* - :code:`$!{CUSTOMER_STATE_NAME}`
- Customer state name sent by connecting party via input parameters, if there are any in customer's country.
* - :code:`$!{CUSTOMER_STATE_CODE}`
- Customer state code sent by connecting party via input parameters, if there are any in customer's country.
* - :code:`$!{CUSTOMER_CITY}`
- Customer city name sent in incoming API request.
* - :code:`$!{CUSTOMER_ZIP_CODE}`
- Customer's ZIP code.
* - :code:`$!{CUSTOMER_ADDRESS1}`
- Customer address sent in incoming API request.
* - :code:`$!{CUSTOMER_ADDRESS2}`
- Customer address sent in incoming API request, if the additional address was required.
* - :code:`$!{AMOUNT}`
- Amount.
* - :code:`$!{GATEDESCRIPTOR}`
- Gate descriptor, specified in payment gate.
* - :code:`$!{ORDERDESCRIPTION}`
- Order description.
* - :code:`$!{CURRENCY}`
- Currency the transaction is charged in (three-letter currency code).
* - :code:`$!{CARD_NUMBER}`
- 6 + 4 masked card number
* - :code:`$!{BIN}`
- Bank BIN of customer credit card number.
* - :code:`$!{LAST_FOUR_DIGITS}`
- Last four digits of a card.
* - :code:`$!{CARD_TYPE}`
- Card type.
* - :code:`$!{PAYNET_ORDER_ID}`
- Payneteasy order id.
* - :code:`$!{MERCHANT_ORDER_ID}`
- Order ID assigned to this order by the Connecting Party.
* - :code:`$!{CREATED_DATE}`
- Transaction creation date in Payneteasy.
* - :code:`$!{CREATED_YEAR}`
- Transaction creation year in Payneteasy
* - :code:`$!{CREATED_MONTH}`
- Transaction creation month in Payneteasy
* - :code:`$!{CREATED_DAY}`
- Transaction creation day in Payneteasy
* - :code:`$!{MERCHANT}`
- End point display name.
* - :code:`$!{MERCHANT_NAME}`
- Connecting Party display name.
* - :code:`$!{MERCHANT_EMAIL}`
- Connecting Party email.
* - :code:`$!{ENDPOINT_ID}`
- End point ID.
* - :code:`$!{PAYMENT_FORM_NAME}`
- Name on payment form in End Point.
* - :code:`$!{RRN}`
- Bank Receiver Registration Number.
* - :code:`$!{APPROVAL_CODE}`
- Verification code needed to authorize a payment
* - :code:`$!{AUTH_RESPONSE_CODE}`
- A two- to six-digit alphanumeric code provided by the issuer that indicates the authorization response (approval or denial).
* - :code:`$!{STATUS}`
- Status of the order.
* - :code:`$!{PAYNET_PROCESSING_DATE}`
- Payneteasy processing date (year, month, day and time in MSK timezone).
* - :code:`$!{ACQUIRER_PROCESSING_DATE}`
- Acquirer bank processing date (year, month, day and time in MSK timezone).
* - :code:`$!{READER_PROCESSING_DATE}`
- Reader terminal processing date (year, month, day and time in MSK timezone).
* - :code:`$!{TERMINAL_ID}`
- Terminal ID.
* - :code:`$!{EMV_ISSUER_RESPONSE}`
- A response code to an authorization request sent by the issuer.
* - :code:`$!{EMV_TVR_95}`
- Terminal Verification Results. Status of the different functions as seen from the terminal.
* - :code:`$!{EVM_CID_9F27}`
- Cryptogram Information Data. Indicates the type of cryptogram and the actions to be performed by the terminal.
* - :code:`$!{EMV_APP_LABEL_50}`
- Application Label. Mnemonic associated with the AID according to ISO/IEC 7816-5.
* - :code:`$!{EMV_CVR_9F34}`
- Cardholder Verification Method (CVM) Results. Indicates the results of the last CVM performed.
* - :code:`$!{EMV_APP_CRYPTOGRAM_9f26}`
- Application Cryptogram. Cryptogram returned by the ICC in response of the GENERATE AC command.
* - :code:`$!{EMV_PAN_SEQUENCE_5f34}`
- Application Primary Account Number (PAN) Sequence Number. Identifies and differentiates cards with the same PAN.
* - :code:`$!{PIN_OR_SIGNATURE}`
- Ask for PIN or just have a signature.
* - :code:`$!{READER_ENTRY_MODE}`
- Client authentication configuration in terminal.
* - :code:`$!{HAS_SIGNATURE}`
- Presence of a signature (:ex:`TRUE` or :ex:`FALSE`).
* - :code:`$!{RECEIPT_ID}`
- Receipt ID.
* - :code:`$!{RECEIPT_URI}`
- URN of the current receipt (:ex:`/view-receipt/ENDPOINT-ID/RECEIPT-ID`).
* - :code:`$!{PURPOSE}`
- Any additional information sent by Connecting Party.
* - :code:`$!{MERCHANT_DATA}`
- Any additional information for this transaction which may be useful in Connecting Party's external systems.
* - :code:`$!{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:
.. code-block:: none
$!{AMOUNT} $!{CURRENCY} Paid
Hi $!{CARDHOLDER_VALUE},
Thank you for your payment through Payneteasy!
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:
.. highlight:: html
::
$!AMOUNT $!CURRENCY Paid
Hi $!CARDHOLDER_VALUE,
Thank you for your payment through Payneteasy!
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.
gate.payneteasy.com
Support@gate.payneteasy.com