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 loan return | Global Payments

View the details of a loan return

Retrieve transaction details of a loan return.

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 loanreturn_id (generated by the gateway) or the reference_id (generated by the merchant's POS).

Using the loanreturn_id

Environment	HTTP Method	URL
Partner Integration Test	GET	http://api.pit.paygateway.com/transactions/loanreturns/{loanreturn_id}
Production	GET	http://api.paygateway.com/transactions/loanreturns/{loanreturn_id}

Using the reference_id

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

Sample request

GET /transactions/loanreturns/000008639902

Sample response

{
  "loanreturn_id": "000008639902",
  "reference_id": "XAZR863990",
  "status": "approved",
  "processor_response": "APPROVAL ADB123",
  "payment": {
    "amount": "23.09",
    "invoice_number": "239087",
    "type": "credit"
  },
  "links": [
    {
      "loansale_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/sales/000000106821",
          "relation": "self",
          "method": "POST",
          "description": "Use this endpoint to retrieve a previous sales transaction using reference id."
        }
      ]
    }
  ]
}