TEteya
Payment Requests

Get receipt text for a payment request

Returns a JSON response with a receipt_text field containing the plain-text receipt for a SUCCESSFUL payment request or refund.

The receipt includes store name and address, UTC transaction date/time, amount/tip/total, card details, AID, MID, TID, approval code, response code, entry mode, verification method, card type, card issuing country, DCC details, and receipt references. Optional fields are omitted if absent - no blank labels are printed.

Required Scopes (one of the following):

  • payment_requests/id (returned via the register API: POST /poslink/v1/epos/register)
  • default_access (deprecated, will be removed in the future; included for backward compatibility with existing integrations)
get/poslink/v3/payment-requests/{payment-request-id}/receipt-text

Request

Path parameters

payment-request-idstring uuid required

The ID of the payment request

Response

Receipt text for the successful payment request

receipt_textstring required

Plain-text receipt representation of the successful payment request. Fields absent from the payment metadata are omitted rather than printed as blanks.

Example response

{
  "receipt_text": "My Store\n123 Main Street\nLondon\nSW1A 1AA\nGB\n----------------------------------\nPAYMENT APPROVED\nDate/Time: 15/01/2024 14:30:00 UTC\n----------------------------------\nAmount: 10.99 GBP\nTip: 2.50 GBP\nTotal: 15.14 USD\n----------------------------------\nDebit Mastercard ****6787\nAID: A0000000041010\nMID: MID001234\nTID: term-001\nApproval Code: A8RLR8\nResponse Code: 00\nEntry Mode: CONTACT_ICC\nVerification Method: ONLINE_PIN\nCard Type: DEBIT\nCard Issuing Country: GB\n----------------------------------\nDCC\nPayment Currency: USD\nDCC Exchange Rate: 1.1223\nDCC Conversion Fee: 3.5%\nDCC Disclaimer: This currency\n  conversion service is provided by\n  Teya. I have been offered a choice of\n  currencies and have chosen to accept\n  DCC and pay in USD at the exchange\n  rate offered by Teya\n----------------------------------\nReference: gw-ref-123\nMerchant Ref: MR-TEST-001"
}

Changes

No recorded changes to this operation across all 1 revision of this API.