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.

View the details of a return

Retrieve transaction details of a card based return.

Important: For authentication, you must include the required HTTPS headers in each request. For more information about the authentication HTTPS headers, see Authenticating Your Requests.

Endpoints

To view the details of any return, send a GET request including the reference_id to the relevant endpoint.

Environment	HTTP Method	URL
Partner Integration Test	GET	https://api.pit.paygateway.com/transactions/card/returns/reference_id/{reference_id}
Production	GET	https://api.paygateway.com/transactions/card/returns/reference_id/{reference_id}

Sample request

GET /transactions/card/returns/reference_id/XAZR863990

Sample response

{
  "invoice_number": "239087",
  "amount": "23.09",
  "currency_code": "840",
  "transactions": [
    {
      "tender_type": "credit",
      "entry_type": "contactless",
      "id": "000008639902",
      "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",
          "type": "credit"
        },
        "card": {
          "masked_card_number": "XXXXXXXXXXX5538",
          "cardholder_name": "Joe Doe",
          "expiry_month": "03",
          "expiry_year": "23",
          "type": "visa",
          "balance": "12.09",
          "postal_code": "84042",
          "rfmiq": "ADB12"
        }
      },
      "debit_attributes": {
        "approval_code": "ADB123",
        "avs_response": "full_match",
        "avs_response_description": "Match - Street Address",
        "cardsecurity_response": "match",
        "payment": {
          "amount": "23.09",
          "type": "credit"
        },
        "card": {
          "masked_card_number": "XXXXXXXXXXX5538",
          "cardholder_name": "Joe Doe",
          "expiry_month": "03",
          "expiry_year": "23",
          "type": "visa",
          "balance": "12.09",
          "postal_code": "84042",
          "rfmiq": "ADB12",
          "debit_trace_number": "dbttrace"
        }
      }
    }
  ]
}