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.

Loading...

Transactions API

Integrate with the Transactions API to allow your merchants to run transactions using the OpenEdge gateway. The Transactions API has the following features:

HTTPS-based
REST API
JSON payloads for requests and responses
TLS 1.2 encryption

Supported regions

The Transactions API is available in the following regions:

US
Canada
Australia
New Zealand
UK

Note: Restrictions apply in the following regions:

In the UK, the Transactions API supports only credit transactions.
In New Zealand, the Transactions API doesn’t support American Express or Diners Club cards.

API versions

Important: Use Transactions API V2 for new integrations.

Transactions API V1

The API specification and YAML file for Version 1 are available for older integrations.

V1 API specification V1 YAML file

Transactions API V2

Version 2 is the current version of our Transactions API.

V2 YAML file

Version 2 includes the following updates:

New endpoints
Updated endpoints
Updated header fields
Updated parameters
Updated enumerations

New endpoints

Method	Endpoint
Create a card present sales transaction	https://api.paygateway.com/transactions/cardpresent/sales
Create a card present returns transaction	https://api.paygateway.com/transactions/cardpresent/returns
Get a card based sales transaction	https://api.paygateway.com/transactions/card/sales/reference\_id/{reference_id}
Get a card based returns transaction	https://api.paygateway.com/transactions/card/returns/reference\_id/{reference_id}
Get a debit sales transaction	https://api.paygateway.com/transactions/debitsales/{debitsale_id}
Get a debit sales transaction using a reference_id	https://api.paygateway.com/transactions/debitsales/reference\_id/{reference_id}
Void a debit sales transaction	https://api.paygateway.com/transactions/debitsales/{debitsale_id}/voids
Void a debit sales transaction using a reference_id	https://api.paygateway.com/transactions/debitsales/reference\_id/{reference_id}/voids
Get a debit return transaction	https://api.paygateway.com/transactions/debitreturns/{debitreturn_id}
Get a debit return transaction using a reference_id	https://api.paygateway.com/transactions/debitreturns/reference\_id/{reference_id}
Get an EBT sales transaction	https://api.paygateway.com/transactions/ebtsales/{ebtsale_id}
Get an EBT sales transaction using a reference_id	https://api.paygateway.com/transactions/ebtsales/reference\_id/{reference_id}
Get an EBT voucher clear transaction	https://api.paygateway.com/transactions/ebtvoucherclears/{ebtvoucherclear_id}
Get an EBT voucher clear transaction using a reference_id	https://api.paygateway.com/transactions/ebtvoucherclears/reference\_id/{reference_id}
Get an EBT return transaction	https://api.paygateway.com/transactions/ebtreturns/{ebtreturn_id}
Get an EBT return transaction using a reference_id	https://api.paygateway.com/transactions/ebtreturns/reference\_id/{reference_id}
Create a loan sale transaction	https://api.paygateway.com/transactions/loansales
Return a loan sale transaction	https://api.paygateway.com/transactions/loansales/{loansale_id}/loanreturns
Return a loan sale using a reference_id	https://api.paygateway.com/transactions/loansales/reference\_id/{reference_id}/loanreturns
Void a loan sale transaction	https://api.paygateway.com/transactions/loansales/{loansale_id}/voids
Void a loan sale transaction using a reference_id	https://api.paygateway.com/transactions/loansales/reference\_id/{reference_id}/voids
Void a loan return transaction	https://api.paygateway.com/transactions/loanreturns/{loanreturn_id}/voids
Void a loan return transaction using a reference_id	https://api.paygateway.com/transactions/loanreturns/reference\_id/{reference_id}/voids

Updated endpoints

Method	Endpoint	Version 1	Version 2
Create a credit sales transaction	https://api.paygateway.com/transactions/sales	https://api.paygateway.com/transactions/creditsales
Get a credit sales transaction	https://api.paygateway.com/transactions/sales/{sale_id}	https://api.paygateway.com/transactions/creditsales/{creditsale_id}
Update a credit sale transaction	https://api.paygateway.com/transactions/sales/{sale_id}	https://api.paygateway.com/transactions/creditsales/{creditsale_id}
Void a credit sale	https://api.paygateway.com/transactions/sales/{sale_id}/voids	https://api.paygateway.com/transactions/creditsales/{creditsale_id}/voids
Return a credit sale	https://api.paygateway.com/transactions/sales/{sale_id}/returns

Updated header fields

Header field	Change
X-GP-Partner-App-Name	Added
X-GP-Partner-App-Version	Added
X-GP-Source-App-Name	Removed
X-GP-Source-App-Version	Removed

Updated parameters

Parameter	Change
customer_code	Renamed to destination_postal_code
invoice_number	Required for card present requests and transport key requests
reference_id	Moved from payment object into the main body of requests
gratuity_eligible_amount	Added to transport key requests
healthcare_details	Added to transport key requests
destination_postal_code	Added to transport key requests
create_token_reason	Added to transport key requests
terminal.terminal_id	Added to transport key requests

Updated enumerations

Enumeration	Change
status	Values follow snake case