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 - Check sale transaction

Send a Sale request to the relevant endpoint to take a dollar amount from a customer's checking account.

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.

For details regarding each API field for both a request and a response, refer to the API Reference.

Important things to consider

You must save the reference_id that you create in your request. To run follow-on transactions that link to the original transaction, you must include the reference_id as part of the endpoint URL. If you want to save the customer's checking account details to use for future transactions, you must include the create_token field in your request.

Endpoints

Environment	HTTP Method	URL
Partner Integration Test	POST	https://api.pit.paygateway.com/transactions/checksales
Production	POST	https://api.paygateway.com/transactions/checksales

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}
{
  "reference_id": "MER-41e40db1-02c8-4214-b2c8-1399aea79afa",
  "check": {
    "account_type": "Checking",
    "account_number": "001221111221",
    "routing_number": "026009593"
},
  "customer": {
    "first_name": "Joe",
     "last_name": "Doe"
},
  "payment": {
     "amount": "23.09",
     "currency_code": "840"
},
  "transaction": {
    "country_code": "840",
    "entry_class": "WEB"
  }
}

Sample response

{
    "checksale_id": "000000084343",
    "status": "check_submitted",
    "check": {
        "masked_account_number": "X2121",
        "routing_number": "112000066",
        "check_number": "999000000084343",
        "token": "qh5gnKAp2m"
    },
    "payment": {
        "amount": "3.94",
        "currency_code": "840",
        "type": "check"
    },
    "transaction": {
        "entry_class": "PPD",
        "language": "en-US"
    },
    "links": [
        {
            "checksale_id": [
                {
                    "href": "https://api.pit.paygateway.com/transactions/checksales/000000084343",
                    "relation": "self",
                    "method": "GET",
                    "description": "Use this endpoint to retrieve a check sales transaction."
                },
                {
                    "href": "https://api.pit.paygateway.com/transactions/checksales/000000084343/checkrefunds",
                    "relation": "refund",
                    "method": "POST",
                    "description": "Use this endpoint to create a check refunds transaction associated with a prior check sale using checksale id."
                }
            ]
        },
        {
            "reference_id": [
                {
                    "href": "https://api.pit.paygateway.com/transactions/checksales/reference_id/MER-5837dbb6-b6a2-444c-bcf3-b7fad889e2cf",
                    "relation": "self",
                    "method": "GET",
                    "description": "Use this endpoint to retrieve a check sales transaction using reference_id."
                },
                {
                    "href": "https://api.pit.paygateway.com/transactions/checksales/reference_id/MER-5837dbb6-b6a2-444c-bcf3-b7fad889e2cf/checkrefunds",
                    "relation": "refund",
                    "method": "POST",
                    "description": "Use this endpoint to create a check refund transaction associated with a prior check sale using reference id."
                }
            ]
        }
    ],
    "reference_id": "MER-5837dbb6-b6a2-444c-bcf3-b7fad889e2cf"
}

Hosted Fields - Check sale transaction | Global Payments

Policies

Connect