For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

Receipts

Generate the building blocks of receipts.

Automatically generate the building blocks of a receipt, reducing the workload to manually construct receipts on your server.

How it works

Once the transaction is approved or declined, the REST API returns the building blocks of a receipt, which the POS consumes and then uses to create the receipt.
The receipt information is included in the receipt object as part of the response.
To retrieve the receipt object in a response, you can do either of the following:
- Process a transaction and in the request include the generate_receipt parameter (set to true) as part of the processing_indicators object.
- Once the transaction is processed, use the GET method and include the generate_receipt parameter (set to true) in the URL endpoint. For example: https://api.pit.paygateway.com/transactions/creditsales/{creditsale_id}?generate_receipt=true

Supported transaction types

These transactions support the generate_receipt parameter in the REST API request.

Transaction Type	HTTP Method
Credit Auth	POST
Capture Credit Auth	POST
Credit Sale	POST
Update Credit Sale	PATCH
Void Sale	PUT
Refund Sale (linked)	POST
Refund (unlinked)	POST

The following reporting actions support the generate_receipt parameter as part of the URL endpoint.

Transaction Type	HTTP Method
Auth	GET
Sale	GET
Refund	GET
PIN Debit Sale	GET

Example request

{ 
    "reference_id": "MER-65564643-d0eb-4c6f-bf09-3fc272f25b2c", 
    "transaction": { 
        "country_code": "840" 
        "processing_indicators": { 
           "generate_receipt": true 
    }, 
    "payment": { 
        "amount": "13.00", 
        "currency_code": "840" 
    }, 
    "card": { 
        "card_number": "4761739001010028", 
        "cardholder_name": "James Mason", 
        "expiry_month": "12", 
        "expiry_year": "33" 
    } 
}

Example response

{ 
  "creditsale_id": "0000012345678903266", 
  "status": "approved", 
  "approval_code": "ADB123", 
  "avs_response": "full_match", 
  "avs_response_description": "Match - Street Address", 
  "cardsecurity_response": "match", 
  "processor_response": "APPROVAL ADB123", 
  "reference_id": "XAZR863990", 
  "card": { 
    "masked_card_number": "XXXXXXXXXXX5538", 
    "cardholder_name": "Joe Doe", 
    "expiry_month": "03", 
    "expiry_year": "23", 
    "token": "EnzMcSVlkP", 
    "type": "visa", 
    "balance": "12.09" 
  }, 
  "payment": { 
    "amount": "23.09", 
    "currency_code": "840", 
    "fees": { 
      "customer_fee_amount": "10.03", 
      "surcharge_amount": "10.00" 
    }, 
    "gratuity_amount": "10.00", 
    "invoice_number": "239087", 
    "type": "credit", 
    "purchase_order": { 
      "po_number": "2343445", 
      "tax_amount": "20.01" 
    } 
  }, 
  "transaction": { 
    "batch_amount": "12.09", 
    "batch_number": "001333", 
    "entry_type": "contactless", 
    "language": "en-US" 
  }, 
  "receipt": { 
    "id": "72845", 
    "text": { 
      "customer_receipt": "\\nBatch #             000161\\nTrans ID            000000141687\\nOrder ID            PAYAPIa0155b35-420c-\\n                    46a5-9b0a-f01ac0004a\\n                    76\\nReceipt #           123456890\\nTrans Type          Return\\nClerk ID            Al090\\nDate/Time           2018-12-10 21:56:16\\nCard Type           Visa\\nCard Number         XXXXXXXXXXXX2222\\nEntry Legend        MAG STRIPE\\nEntry Method        CONTACTLESS\\nApproval Code       577279\\n\\nTotal Amount        USD$132.00\\n\\n          Approved - Thank You\\n\\n X____________________________________\\n           Signature: Joe Doe\\n\\n         ****Customer Copy****\\n     Retain this copy for statement\\n              verification", 
      "merchant_receipt": "\\nBatch #             000161\\nTrans ID            000000141687\\nOrder ID            PAYAPIa0155b35-420c-\\n                    46a5-9b0a-f01ac0004a\\n                    76\\nReceipt #           123456890\\nTrans Type          Return\\nClerk ID            Al090\\nDate/Time           2018-12-10 21:56:16\\nCard Type           Visa\\nCard Number         XXXXXXXXXXXX2222\\nEntry Legend        MAG STRIPE\\nEntry Method        CONTACTLESS\\nApproval Code       577279\\n\\nTotal Amount        USD$132.00\\n\\n          Approved - Thank You\\n\\n X____________________________________\\n           Signature: Joe Doe\\n\\n         ****Merchant Copy****" 
    }, 
    "attributes": { 
      "authorization_agreement": "I agree to pay above total amount according to card issuer agreement", 
      "call_issuer": "CALL ISSUER", 
      "copy_label_customer": "****Customer Copy**** Retain this copy for statement verification", 
      "copy_label_merchant": "MERCHANT COPY", 
      "merchant_address": "2578 West 600 North", 
      "merchant_footer": "Thank you. Come again.", 
      "merchant_header": "ABC Grocery", 
      "merchant_name": "ABC Stores", 
      "merchant_phone": "901-492-7269", 
      "merchant_policy": "Generally, merchandise purchased in store or online can be returned or exchanged within ninety (90) days of purchase with or without a receipt", 
      "verbiage": "Approved - Thank You" 
    }, 
    "labeled_attributes": { 
      "amount": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "approval_code": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "authorization_response_code": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "avs_response_code": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "batch_number": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "card_balance": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "card_type": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "cardsecurity_response_code": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "clerk_id": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "entry_legend": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "entry_method": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "gratuity_amount": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "masked_card_number": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "merchant_id": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "original_auth_code": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "payment_type": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "number": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "reference_id": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "subtotal_amount": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "total_amount": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "transaction_datetime": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "transaction_id": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "transaction_type": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "validation_code": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "application_cryptogram": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "application_identifier": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "application_label": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "application_preferred_name": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      }, 
      "application_transaction_counter": { 
        "label": "Total Amount", 
        "value": "$99.45 USD" 
      } 
    } 
}

Parsed receipt

MERCHANT NAME 
123 The Street 
City, ZIP 
--------------------------------- 
TRANSACTION RECEIPT 
--------------------------------- 
Transaction Type: Sale
Date/Time: 2025-12-10 21:56:16
Total Amount: 132.00
--------------------------------- 
Card Type: Visa 
Card Number: XXXXXXXXXXXX2222
Entry Method: CONTACTLESS
--------------------------------- 
Batch: 000161
Transaction ID: 000000141687
Order ID: 0155b35-420c 
Receipt: 123456890 
Clerk ID: Al090 
-------------------------------- 
Approval Code: 577279
Approved – Thank you 
** CUSTOMER COPY **

Additional Card Present Data

EMV (chip) transactions return ICC (Integrated Circuit Card) data that can be included on merchant receipts to meet card-network requirements. The icc object returned in a transaction response contains the relevant EMV chip fields generated during a transaction. These fields may vary by terminal, region, or card brand.

Using the REST API, process a Sale.
Returned in the transaction response is the emv object which contains the icc object.
Parse the fields contained within the icc object and print the required fields on the EMV receipt.

Example response

{ 
  "invoice_number": "239087", 
  "amount": "23.09", 
  "status": "completed", 
  "currency_code": "840", 
  "gratuity_amount": "10.00", 
  "transactions": [ 
    { 
      "tender_type": "credit", 
      "entry_type": "contactless", 
      "id": "0000012345678903266", 
      "reference_id": "XAZR863990", 
      "status": "approved", 
      "status_code": "200", 
      "processor_response": "APPROVAL ADB123", 
      "transaction_datetime": "2019-12-15T13:00:00Z", 
      "credit_attributes": { 
        "approval_code": "ADB123", 
        "avs_response": "full_match", 
        "avs_response_description": "Match - Street Address", 
        "cardsecurity_response": "match", 
        "payment": { 
          "amount": "23.09", 
          "cashback_amount": "10.00", 
          "type": "credit", 
          "fees": { 
            "surcharge_amount": "10.00" 
          } 
        }, 
        "card": { 
          "masked_card_number": "XXXXXXXXXXX5538", 
          "cardholder_name": "Joe Doe", 
          "expiry_month": "03", 
          "expiry_year": "23", 
          "token": "EnzMcSVlkP", 
          "type": "visa", 
          "balance": "12.09", 
          "postal_code": "84042", 
          "rfmiq": "ADB12", 
          "card_on_file_attributes": { 
            "tokenization_error_code": "ADB12", 
            "tokenization_error_message": "ADB12" 
          } 
        }, 
        "emv": { 
          "amount": { 
            "amount_authorized": "225.09", 
            "amount_other": "225.09" 
          }, 
          "icc": { 
            "dedicated_file_name": "A000000004101", 
            "application_label": "Visa", 
            "application_expiry_date": "string", 
            "application_effective_date": "string", 
            "application_interchange_profile": "5C00", 
            "application_version_number": "0001", 
            "application_transaction_counter": "3601", 
            "application_usage_control": "stri", 
            "application_preferred_name": "4D617374657243617264", 
            "application_display_name": "string", 
            "application_pan_sequence_number": "99", 
            "application_cryptogram": "AC2E521325F52EEC", 
            "application_cryptogram_type": "TC", 
            "cardholder_verification_method_results": "string", 
            "issuer_application_data": "0210A0800F240000000000000000000000FF", 
            "terminal_verification_results": "0200008000", 
            "unpredictable_number": "95637FFD", 
            "pos_entry_mode": "st", 
            "terminal_type": "21", 
            "ifd_serial_number": "stringstringstri", 
            "terminal_country_code": "840", 
            "terminal_identification": "stringstringstri", 
            "tac_default": "ABCFFF", 
            "tac_denial": "ABCFFF", 
            "tac_online": "ABCFFF", 
            "transaction_type": "00", 
            "transaction_currency_code": "840", 
            "transaction_status_information": "E800", 
            "cryptogram_information_data": "80", 
            "pin_statement": "PIN Verified", 
            "cvm_method": "string", 
            "iac_default": "AABB32", 
            "iac_denial": "AABB32", 
            "iac_online": "string", 
            "authorization_response_code": "st" 
          } 
       }

Policies

Connect

Additional Resources

Receipts

How it works

Supported transaction types

Example request

Example response

Parsed receipt

Additional Card Present Data

Example response