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 check sale

Retrieve transaction details of a check sale.

These solutions are available in US and Canada only. For all other regions, please contact us for support.

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

The endpoint you use depends on whether you identify the sale using the checksale_id (generated by the gateway) or the reference_id (generated by the merchant's POS).

Using the checksale_id

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

Using the reference_id

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

Sample request

GET /transactions/checksales/000008639902

Sample response

{
  "checksale_id": "000008639902",
  "reference_id": "XAZR863990",
  "status": "check_submitted",
  "check": {
    "check_number": "121002048",
    "masked_account_number": "XXXXXXXXXXXXX0099",
    "bank_number": "123456",
    "branch_transit_number": "12345",
    "bsb_number": "123-456",
    "financial_institution_number": "999",
    "routing_number": "026009593",
    "token": "EnzMcSVlkP"
  },
  "payment": {
    "amount": "23.09",
    "fees": {
      "customer_fee_amount": "10.03",
      "surcharge_amount": "10.03"
    },
    "type": "credit"
  },
  "transaction": {
    "aft_ca": {
      "return_date": "2018-09-14",
      "return_code": "R01",
      "return_description": "Check Returned"
    },
    "entry_class": "WEB",
    "payment_purpose_code": "150",
    "verification_code": "25457812586C",
    "nacha": {
      "return_date": "2018-09-14",
      "return_code": "R01",
      "return_description": "Check Returned",
      "noc_code": "C01",
      "noc_description": "The account number is incorrect or is formatted incorrectly"
    },
    "auspaynet": {
      "return_code": "2",
      "return_description": "Check Returned"
    },
    "paymentsnz": {
      "return_code": "2",
      "return_description": "Check Returned"
    }
  },
  "links": [
    {
      "checksale_id": [
        {
          "href": "https://api.paygateway.com/cnp-payments/checksales/000000106821",
          "relation": "self",
          "method": "POST",
          "description": "Use this endpoint to retrieve a previous sales transaction using reference id."
        }
      ],
      "reference_id": [
        {
          "href": "https://api.paygateway.com/cnp-payments/checksales/000000106821",
          "relation": "self",
          "method": "POST",
          "description": "Use this endpoint to retrieve a previous sales transaction using reference id."
        }
      ]
    }
  ]
}

View the details of a check sale | Global Payments