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.

Hosted Fields - Transaction Query Guide

Manage your customers payment experience with hosted fields

Querying a transaction

To view the details of a previous transaction, send a CreateQuery request to the relevant endpoint.

How it works

Program the POS to send a CreateQuery request to the relevant endpoint. To identify the original transaction, send the reference_id of the original transaction in the endpoint URL for the CreateQuery request. For example, https://api.pit.paygateway.com/transactions/card/sales/reference_id/MER-41e0db1-02c8-4214-b2c8-1399aea79afa.

Scenario	Merchant uses the POS to:
A transaction has timed out and the merchant wants to confirm if it was processed.	Find the transaction and view the transaction details.

Payment sources: reference_id

Important things to consider

You can refund a partial amount, however, the total dollar amount for all partial refunds cannot be higher than the total dollar amount for the original transaction.

Sample request

Content-Type: application/json
Authorization: AuthToken {AuthTokenV2}
X-GP-Request-Id: {request_id}
X-GP-Version: 2021-04-08
X-GP-Api-Key: {API Key}
X-GP-Partner-App-Name: {Name of integrating application}

Sample response

{
    "amount": "5.31",
    "transactions": [
        {
            "tender_type": "credit",
            "transaction_datetime": "20230616113655",
            "processor_response": "DEVELOPMENT APPROVAL",
            "reference_id": "MER-b934f82c-b0c6-42f5-b8bd-3bcbdf570789",
            "id": "000000084326",
            "status": "approved",
            "status_code": "200",
            "credit_attributes": {
                "payment": {
                    "amount": "5.31",
                    "type": "credit"
                },
                "approval_code": "416109",
                "avs_response": "full_match",
                "avs_response_description": "Match - Street Address, Match - Postal Code",
                "card": {
                    "masked_card_number": "476173XXXXXX0010",
                    "expiry_month": "12",
                    "expiry_year": "25",
                    "type": "visa",
                    "postal_code": "12345"
                }
            }
        }
    ]
}