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.

ACH transactions

Debit a customer’s checking account used for one‑time payments, e‑commerce purchases, or scheduled withdrawals.

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

Process an ACH/EFT sale

Use the ACH sale endpoint to debit a customer’s checking account for a specific dollar amount, also referred to as processing a Check Sale.

To process a follow-on transaction that links to the original transaction, you can include the reference_id or the checksale_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. Sensitive bank account data must never be stored in plaintext.

For more information about follow-on transactions, see Manage Payments.

Endpoints

Important: For authentication, you must include the required headers in each request. For more information, please refer to Authenticating Your Requests.

Environment	HTTP Method	URL
Sandbox	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": "Smith"
},
  "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"
}

Tokenize ACH/EFT details

Tokenize a customer’s check account details to store them securely in the vault for future ACH/EFT transactions.

Endpoints

Important: For authentication, you must include the required headers in each request. For more information, please refer to Authenticating Your Requests.

Environment	HTTP Method	URL
Sandbox	POST	https://api.pit.paygateway.com/tokenization/checktokens
Production	POST	https://api.paygateway.com/tokenization/checktokens

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-Source-App-Version: {Version of integrating application}
X-GP-Source-App-Name: {Name of integrating application}
{
  "check": {
    "account_number": "12121",
    "routing_number": "112000066",
    "accountholder_name": "John Smith"
  }
}

Sample response

{
    "transaction_id": "000000002275",
    "status": "Approved",
    "check": {
        "masked_account_number": "X2121",
        "routing_number": "112000066",
        "token": "3SizZN5u0T"
    }
}

Process an ACH/EFT sale with a token

To take the dollar amount for the transaction using the token for the saved checking account, send a Sale request to the relevant endpoint.

Endpoints

Important: For authentication, you must include the required headers in each request. For more information, please refer to Authenticating Your Requests.

Environment	HTTP Method	URL
Sandbox	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",
    "token": "xxXXXxXXxX"
},
  "customer": {
    "first_name": "Joe",
     "last_name": "Doe"
},
  "payment": {
     "amount": "23.09",
     "currency_code": "840"
},
  "transaction": {
    "country_code": "840",
    "entry_class": "PPD"
  }
}

Sample request

{
    "checksale_id": "000000084350",
    "status": "check_submitted",
    "check": {
        "masked_account_number": "X2121",
        "routing_number": "112000066",
        "check_number": "999000000084350"
    },
    "payment": {
        "amount": "3.89",
        "currency_code": "840",
        "type": "check"
    },
    "transaction": {
        "entry_class": "PPD",
        "language": "en-US"
    },
    "links": [
        {
            "checksale_id": [
                {
                    "href": "https://api.pit.paygateway.com/transactions/checksales/000000084350",
                    "relation": "self",
                    "method": "GET",
                    "description": "Use this endpoint to retrieve a check sales transaction."
                },
                {
                    "href": "https://api.pit.paygateway.com/transactions/checksales/000000084350/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-6a738380-d5b6-49f8-a80a-c078b67e32cf",
                    "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-6a738380-d5b6-49f8-a80a-c078b67e32cf/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-6a738380-d5b6-49f8-a80a-c078b67e32cf"
}

Test and expand your integration

Testing

Test your integration

Response Codes

Handle response codes

Enumerations

Detailed enumerations

Manage Payments

Follow-on transactions

Tokenization

Tokenize card details

API Reference

Direct API reference

ACH transactions | Global Payments