Receipt

Generate a transaction receipt

post

Use this call to request receipt details in HTML format for a particular TXID (Transaction ID). This method works for card on file documents as well as transaction receipts. You will need the TXID (Transaction ID) as well as a receipt type and a targeted recipient ( Customer or Merchant ).

The following will provide a customer receipt for TXID 123: { "REFID": 123, "ReceiptType": 1 (Sales Receipt) "Recipient": 1 (Customer Copy) }

Recipient 1 Merchant 2 Customer 3 Both

Receipt Types 1 Transaction 2 Void 3 Refund 4 Annual Consent 5 Recurring Consent 6 Subscription 7 ACH Transaction 8 ACH Void 9 ACH Refund

Important you must replace all Unicode characters to consume clean HTML

Example : CleanHtml = Regex.Replace(my, @"[^\u0000-\u007F]+", string.Empty);

Header parameters

SessKeystringrequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

REFIDintegeroptional

The unique reference identifier for the transaction

Example: 158

ReceiptTypeinteger · enumoptional

The type of receipt

• 1: Transaction
• 2: Void
• 3: Refund
• 4: Annual Consent
• 5: Recurring Consent
• 6: Subscription
• 7: ACH Transaction
• 8: ACH Void
• 9: ACH Refund

Example: 2

Options: 1, 2, 3, 4, 5, 6, 7, 8, 9

Recipientinteger · enumoptional

The targeted recipient type

• 1: Merchant
• 2: Customer
• 3: Both

Example: 1

Options: 1, 2, 3

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/Receipt/ReceiptGenerate' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
    "REFID": 158,
    "ReceiptType": 1,
    "Recipient": 1
  }'

200

200

{
  "ReceiptGenerateResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "ReceiptHtml": "html",
    "RespMsg": "Successfully Returned Transaction Receipt Markup"
  }
}

Successfully generated transaction receipt