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

Authorization

To authorize your request, include the information in the Header parameters table in each request header.

Header parameters

Parameter	Type	Required?	Description
Authorization	String	Required	AuthTokenV2 to authenticate your request. Send in AuthToken format. For more information about how to generate an AuthToken, see AuthTokenV2. Note: The region-specific value you send when you generate the AuthTokenV2 must match the region enumeration you send in your transaction requests. Provide a region enumeration for the language parameter, the country_code parameter, and the currency_code parameter.
Content Type	String	Required	Indicates the type of data that you are sending in your request. Send application/json.
X-GP-Api-Key	String	Required	Your unique API key. Note: If you haven’t received your API key, contact our Integration Services team.
X-GP-Request-Id	String	Optional	Version-4 UUID you generate to identify each request you send to our gateway. Add a prefix of MER- to your ID. For example: MER-ba96b9c5-828c-434c-be74-d73c8e853526 Note: If you don’t send a value for this parameter, we generate a value with a prefix of API- and return it in the header of the response.
X-GP-Request-Id	String	Optional	Version-4 UUID you generate to identify each request you send to our gateway. Add a prefix of MER- to your ID. For example: MER-ba96b9c5-828c-434c-be74-d73c8e853526 Note: If you don’t send a value for this parameter, we generate a value with a prefix of API- and return it in the header of the response.
X-GP-Partner-App-Name	String	Required	Name of your application.
X-GP-Version	String	Required	API version in YYYY-MM-DD format.

Authorization request example

Running a check sale

Send a POST request to the relevant endpoint to run a check sales transaction.

Endpoints

Environment	URL
Test	https://api.pit.paygateway.com/transactions/checksales
Production	https://api.paygateway.com/transactions/checksales

Request

Object	Parameter	Type	Size	Required?	Description
N/A	reference_id	String	1-50	Required	Unique identifier for the sale. This is an alphanumeric value that the merchant creates, for example, XAZR863990.
check	account_number	String	1-17	Required	The payer account number used for a check transaction. Maximum length is 17 for the US and 12 for Canada.
routing_number	String	9	Required	Routing number for a check transaction.
account_type	String		Optional	The type of payer account used for a check transaction: • checking • savings
customer	first_name	String	1-50	Required	Customer’s first name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
middle_name	String	1-50	Optional	Customer’s middle name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
last_name	String	1-50	Required	Customer’s last name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
business_name	String	1-50	Required	Business name. Note: If the customer is not a business, send a value for each of the following parameters: first_name and last_name.
payment	amount	String	1-9	Required	Total amount that the merchant wants to take from the customer's account. The value includes two decimal places, for example, 10.00.
currency_code	String	Explicit	Required	ISO currency code for the sale. For a list of possible values, see the currency code enumeration.
transaction	entry_class	String	Explicit		Standard entry class to designate how the transaction was authorized by the originator. Applicable for US check transactions only.Possible values:• CCD• PPD• TEL• WEB

processing_indicators object

Parameter	Type	Size	Required?	Description
create_token	Boolean	Explicit	Optional	If set to true, our gateway saves the card details to our vault. Our gateway creates a token and returns it in the response.

Request body example

Successful response schema

Object	Field	Type	Description
	checksale_id	String	Unique id identifying a check sales transaction.
	status	String	Indicates the status of the transaction. Possible values: • check_approved • check_daily_amount_limit_exceeded • check_monthly_amount_limit_exceeded • check_returned • check_scheduled • check_submitted • check_transaction_amount_limit_exceeded • check_verification_configuration_error • check_verification_failed • ineligible_for_ach_network • rdfi_not_qualified_to_participate
	reference_id	String	Unique identifier that the merchant created for the transaction. If the merchant does not send this in the request, our gateway automatically creates the reference_id instead. Note: This is the reference_id that you can include in the endpoint URL for follow-on transactions.
check	masked_account_number	String	Masked account number used for a check transaction.
routing_number	String	Routing number used for a check transaction.
check_number	String	The check number used for the transaction.
token	String	Unique reference for the customer's payment details that they stored in our vault. Note: Do not send this token in follow-on transactions as it is not yet compliant with card brand regulations.
payment	amount	String	Total amount taken from the customer's account.
currency_code	String	ISO currency code for the transaction. For a list of possible values, see the currency code enumeration.
type	String	Type of payment for the transaction. For a list of possible values, see the payment type enumeration.
transaction	entry_class	String	Standard entry class to designate how the transaction was authorized by the originator. Applicable for US check transactions only. Possible values: • CCD • PPD • TEL • WEB
links	checksale_id	Object	Object that includes HATEOAS links for follow-on transactions using the checksale_id.
reference_id	Object	Object that includes HATEOAS links for follow-on transactions using the referencee_id.

checksale_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the checksale_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description		Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a sale id.

reference_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the reference_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • POST
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a reference id.

Successful response example

Running a check sale (Canada)

Send a POST request to the relevant endpoint to run a check sales transaction.

Endpoints

Environment	URL
Test	https://api.pit.paygateway.com/transactions/checksales
Production	https://api.paygateway.com/transactions/checksales

Request

Object	Parameter	Type	Size	Required?	Description
N/A	reference_id	String	1-50	Required	Unique identifier for the sale. This is an alphanumeric value that the merchant creates, for example, XAZR863990.
check	account_number	String	1-7	Required	The payer account number used for a check transaction. Maximum length is 17 for the US and 12 for Canada.
financial_institution_number	String	3	Required	Three digit number that identifies the financial institution used for the check transaction.
branch_transit_number	String	5	Required	Identifies the specific bank branch of a Canadian financial institution used for the check transaction. The five-digit code is the first series of numbers listed along the bottom of a check.
account_type	String		Required	The type of payer account used for a check transaction: • Checking • Savings
customer	first_name	String	1-50		Customer’s first name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
middle_name	String	1-50		Customer’s middle name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
last_name	String	1-50		Customer’s last name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
business_name	String	1-50		Business name. Note: If the customer is not a business, send a value for each of the following parameters: title first_name middle_name last_name
payment	amount	String	1-9	Required	Total amount that the merchant wants to take from the customer's account. The value includes two decimal places, for example, 10.00.
currency_code	String	Explicit	Required	ISO currency code for the sale. For a list of possible values, see the currency code enumeration.
transaction	payment_purpose_code	String	3	Required	Three digit code used by a payment originator to identify a Canada check payment and enables the identification of payment types to customers.

processing_indictors object

Parameter	Type	Size	Required?	Description
create_token	Boolean	Explicit	Optional	If set to true, our gateway saves the card details to our vault. Our gateway creates a token and returns it in the response.

Request body example

Successful response schema

Object	Field	Type	Description
	checksale_id	String	Unique id identifying a check sales transaction.
	status	String	Indicates the status of the transaction. Possible values: • check_approved • check_daily_amount_limit_exceeded • check_monthly_amount_limit_exceeded • check_returned • check_scheduled • check_submitted • check_transaction_amount_limit_exceeded • check_verification_configuration_error • check_verification_failed • ineligible_for_ach_network • rdfi_not_qualified_to_participate
	reference_id	String	Unique identifier that the merchant created for the transaction. If the merchant does not send this in the request, our gateway automatically creates the reference_id instead. Note: This is the reference_id that you can include in the endpoint URL for follow-on transactions.
check	masked_account_number	String	Masked account number used for a check transaction.
branch_transit_number	String	Identifies the specific bank branch of a Canadian financial institution used for the check transaction. The five-digit code is the first series of numbers listed along the bottom of a check.
financial_institution_number	String	Three digit number that identifies the financial institution used for the check transaction.
check_number	String	The check number used for the transaction.
token	String	Unique reference for the customer's payment details that they stored in our vault.
payment	amount	String	Total amount taken from the customer's account.
currency_code	String	ISO currency code for the transaction. For a list of possible values, see the currency code enumeration.
type	String	Type of payment for the transaction. For a list of possible values, see the payment type enumeration.
transaction	payment_purpose_code	String	Three digit code used by a payment originator to identify a Canada check payment and enables the identification of payment types to customers.
language	String	Language for the text that displays on the device and receipts. For a list of possible values, see the language enumeration.
links	checksale_id

checksale_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the checksale_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a reference id.

Reference_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the reference_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • POST
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a reference id.

Successful response example

Refunding a check sale

Send a POST request to the relevant endpoint to refund a check sales transaction.

Endpoints

Environment	URL
Test	https://api.pit.paygateway.com/transactions/checksales/reference\_id/{reference_id}/checkrefunds
Production	https://api.paygateway.com/transactions/checksales/reference\_id/{reference_id}/checkrefunds

Request

Object	Parameter	Type	Size	Required?	Description
check	account_type	String		Required	The type of payer account used for a check transaction: • Checking • Savings
payment	amount	String	1-9	Required	Total amount that the merchant wants to take from the customer's account. The value includes two decimal places, for example, 10.00.
transaction	entry_class	String		Required	Standard entry class to designate how the transaction was authorized by the originator. Applicable for US check transactions only. Possible values: • CCD • PPD • TEL • WEB

Request body example

Successful response schema

Successful response schema

Object	Field	Type	Description
	checkrefund_id	String	Unique id identifying a check refund transaction.
	status	String	Indicates the status of the transaction. Possible values: • check_approved • check_daily_amount_limit_exceeded • check_monthly_amount_limit_exceeded • check_returned • check_scheduled • check_submitted • check_transaction_amount_limit_exceeded • check_verification_configuration_error • check_verification_failed • ineligible_for_ach_network • rdfi_not_qualified_to_participate
	reference_id	String	Unique identifier that the merchant created for the transaction. If the merchant does not send this in the request, our gateway automatically creates the reference_id instead. Note: This is the reference_id that you can include in the endpoint URL for follow-on transactions.
check	masked_account_number	String	Masked account number used for a check transaction.
routing_number	String	Routing number used for a check transaction.
check_number	String	The check number used for the transaction.
payment	amount	String	Total amount taken from the customer's account.
type	String	Type of payment for the transaction. For a list of possible values, see the payment type enumeration.
transaction	entry_class	String	Standard entry class to designate how the transaction was authorized by the originator. Applicable for US check transactions only. Possible values: • CCD • PPD • TEL • WEB
links	checkrefund_id	Object	Object that includes HATEOAS links for follow-on transactions using the checkrefund_id.
reference_id	Object	Object that includes HATEOAS links for follow-on transactions using the referencee_id.

checkrefund_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the checkrefund_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a sale id.

reference_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the reference_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a reference id.

Successful response example

Refunding a check sale (Canada)

Send a POST request to the relevant endpoint to refund a check sales transaction.

Endpoints

Environment	URL
Test	https://api.pit.paygateway.com/transactions/checksales/reference\_id/{reference_id}/checkrefunds
Production	https://api.paygateway.com/transactions/checksales/reference\_id/{reference_id}/checkrefunds

Request

Object	Parameter	Type	Size	Required?	Description
check	account_type	String		Required	The type of payer account used for a check transaction: • Checking • Savings
payment	amount	String	1-9	Required	Total amount that the merchant wants to take from the customer's account. The value includes two decimal places, for example, 10.00.
transaction	entry_class	String	3	Required	Three digit code used by a payment originator to identify a Canada check payment and enables the identification of payment types to customers.

Request body example

Successful response schema

Object	Field	Type	Description
	checkrefund_id	String	Unique id identifying a check refund transaction.
	status	String	Indicates the status of the transaction. Possible values: • check_approved • check_daily_amount_limit_exceeded • check_monthly_amount_limit_exceeded • check_returned • check_scheduled • check_submitted • check_transaction_amount_limit_exceeded • check_verification_configuration_error • check_verification_failed • ineligible_for_ach_network • rdfi_not_qualified_to_participate
	reference_id	String	Unique identifier that the merchant created for the transaction. If the merchant does not send this in the request, our gateway automatically creates the reference_id instead. Note: This is the reference_id that you can include in the endpoint URL for follow-on transactions.
check	masked_account_number	String	Masked account number used for a check transaction.
branch_transit_number	String	Identifies the specific bank branch of a Canadian financial institution used for the check transaction. The five-digit code is the first series of numbers listed along the bottom of a check.
financial_institution_number	String	Three digit number that identifies the financial institution used for the check transaction.
check_number	String	The check number used for the transaction.
payment	amount	String	Total amount taken from the customer's account.
type	String	Type of payment for the transaction. For a list of possible values, see the payment type enumeration.
transaction	payment_purpose_code	String	Three digit code used by a payment originator to identify a Canada check payment and enables the identification of payment types to customers.
links	checkrefund_id	Object	Object that includes HATEOAS links for follow-on transactions using the checkrefund_id.
reference_id	Object	Object that includes HATEOAS links for follow-on transactions using the referencee_id.

checkrefund_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the checkrefund_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a sale id.

reference_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the reference_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a reference id.

Successful response example

Refunding a check sale without link to previous transaction

Send a POST request to the relevant endpoint to refund a check sales transaction without linking to a previous transaction.

Environment	URL
Test	https://api.pit.paygateway.com/transactions/checkrefunds
Production	https://api.paygateway.com/transactions/checkrefunds

Request

Object	Parameter	Type	Size	Required?	Description
N/A	reference_id	String	1-50	Required	Unique identifier for the sale. This is an alphanumeric value that the merchant creates, for example, XAZR863990.
check	account_number	String		Required	The type of payer account used for a check transaction: • Checking • Savings
routing_number	String	9	Required	Routing number for a check transaction.
account_type	String		Required	The type of payer account used for a check transaction: • Checking • Savings
customer	first_name	String	1-50	Required	Customer’s first name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
middle_name	String	1-50	Optional	Customer’s middle name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
last_name	String	1-50	Required	Customer’s last name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
payment	amount	String	1-9	Required	Total amount that the merchant wants to take from the customer's account. The value includes two decimal places, for example, 10.00.
currency_code	String	Explicit	Required	ISO currency code for the sale. For a list of possible values, see the currency code enumeration.
transaction	entry_class	String		Required	Standard entry class to designate how the transaction was authorized by the originator. Applicable for US check transactions only. Possible values: • CCD • PPD • TEL • WEB
country_code	String	3	Required	Code that represents the country where the transaction originated. For a list of possible values, see the country code enumeration.

Request body example

Successful response schema

Object	Field	Type	Description
	checkrefund_id	String	Unique id identifying a check refund transaction.
	status	String	Indicates the status of the transaction. Possible values: • check_approved • check_daily_amount_limit_exceeded • check_monthly_amount_limit_exceeded • check_returned • check_scheduled • check_submitted • check_transaction_amount_limit_exceeded • check_verification_configuration_error • check_verification_failed • ineligible_for_ach_network • rdfi_not_qualified_to_participate
	reference_id	String	Unique identifier that the merchant created for the transaction. If the merchant does not send this in the request, our gateway automatically creates the reference_id instead. Note: This is the reference_id that you can include in the endpoint URL for follow-on transactions.
check	masked_account_number	String	Masked account number used for a check transaction.
routing_number	String	Routing number used for a check transaction.
check_number	String	The check number used for the transaction.
payment	amount	String	Total amount taken from the customer's account.
currency_code	String	ISO currency code for the transaction. For a list of possible values, see the currency code enumeration.
type	String	Type of payment for the transaction. For a list of possible values, see the payment type enumeration.
transaction	entry_class	String	Standard entry class to designate how the transaction was authorized by the originator. Applicable for US check transactions only. Possible values: • CCD • PPD • TEL • WEB
language	String	Language for the text that displays on the device and receipts. For a list of possible values, see the language enumeration.
links	checkrefund_id	Object	Object that includes HATEOAS links for follow-on transactions using the checkrefund_id.
reference_id	Object	Object that includes HATEOAS links for follow-on transactions using the referencee_id.

checkrefund_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the checkrefund_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a sale id.

reference_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the reference_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a reference id.

Successful response example

Refunding a check sale without link to previous transaction (Canada)

Send a POST request to the relevant endpoint to refund a check sales transaction without linking to a previous transaction.

Endpoints

Environment	URL
Test	https://api.pit.paygateway.com/transactions/checkrefunds
Production	https://api.paygateway.com/transactions/checkrefunds

Request

Object	Parameter	Type	Size	Required?	Description
N/A	reference_id	String	1-50	Required	Unique identifier for the sale. This is an alphanumeric value that the merchant creates, for example, XAZR863990.
check	account_type	String		Required	The type of payer account used for a check transaction: • Checking • Savings
financial_institution_number	String	3	Required	Three digit number that identifies the financial institution used for the check transaction.
branch_transit_number	String	5	Required	Identifies the specific bank branch of a Canadian financial institution used for the check transaction. The five-digit code is the first series of numbers listed along the bottom of a check.
account_type	String		Required	The type of payer account used for a check transaction: • Checking • Savings
customer	first_name	String	1-50	Required	Customer’s first name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
middle_name	String	1-50	Required	Customer’s middle name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
last_name	String	1-50	Required	Customer’s last name. Note: If the customer is a business, do not send this parameter. Send the business_name parameter.
payment	amount	String	1-9	Required	Total amount that the merchant wants to take from the customer's account. The value includes two decimal places, for example, 10.00.
currency_code	String	Explicit	Required	ISO currency code for the sale. For a list of possible values, see the currency code enumeration.
transaction	payment_purpose_code	String	3	Required	Three digit code used by a payment originator to identify a Canada check payment and enables the identification of payment types to customers.
language	String	Explicit		Language for the text that displays on the device and receipts. For a list of possible values, see the language enumeration.

Request body example

Successful response schema

Object	Field	Type	Description
	checksale_id	String	Unique id identifying a check sales transaction.
	status	String	Indicates the status of the transaction. Possible values: • check_approved • check_daily_amount_limit_exceeded • check_monthly_amount_limit_exceeded • check_returned • check_scheduled • check_submitted • check_transaction_amount_limit_exceeded • check_verification_configuration_error • check_verification_failed • ineligible_for_ach_network • rdfi_not_qualified_to_participate
	reference_id	String	Unique identifier that the merchant created for the transaction. If the merchant does not send this in the request, our gateway automatically creates the reference_id instead. Note: This is the reference_id that you can include in the endpoint URL for follow-on transactions.
check	masked_account_number	String	Masked account number used for a check transaction.
branch_transit_number	String	Identifies the specific bank branch of a Canadian financial institution used for the check transaction. The five-digit code is the first series of numbers listed along the bottom of a check.
financial_institution_number	String	Three digit number that identifies the financial institution used for the check transaction.
check_number	String	The check number used for the transaction.
payment	amount	String	Total amount taken from the customer's account.
currency_code	String	ISO currency code for the transaction. For a list of possible values, see the currency code enumeration.
type	String	Type of payment for the transaction. For a list of possible values, see the payment type enumeration.
transaction	payment_purpose_code	String	Three digit code used by a payment originator to identify a Canada check payment and enables the identification of payment types to customers.
language	String	Language for the text that displays on the device and receipts. For a list of possible values, see the language enumeration.
links	checkrefund_id	Object	Object that includes HATEOAS links for follow-on transactions using the checkrefund_id.
reference_id

checkrefund_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the checkrefund_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a sale id.

reference_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the reference_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a reference id.

Successful response example

Viewing details of a check sale

To view the details of a check sale, send a GET request including either the checksale_id or the reference_id to the relevant endpoint.

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).

Identifying a check sale using the checksale_id.

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

Identifying a check sale using the reference_id.

Environment	HTTP Method	URL
Test	GET	https://api.pit.paygateway.com/transactions/creditsales/reference\_id/{reference_id}
Production	GET	https://api.paygateway.com/transactions/creditsales/reference\_id/{reference_id}

Request

Parameter	Type	Description
checksale_id	String	Unique identifier for the check sale that the merchant created or that our gateway created.
reference_id	String	Unique identifier for the sale that the merchant created or that our gateway created.

Request header example

Successful response schema

Object	Field	Type	Description
	checksale_id	String	Unique id identifying a check sales transaction.
	status	String	Indicates the status of the transaction. Possible values: • check_approved • check_daily_amount_limit_exceeded • check_monthly_amount_limit_exceeded • check_returned • check_scheduled • check_submitted • check_transaction_amount_limit_exceeded • check_verification_configuration_error • check_verification_failed • ineligible_for_ach_network • rdfi_not_qualified_to_participate
	reference_id	String	Unique identifier that the merchant created for the transaction. If the merchant does not send this in the request, our gateway automatically creates the reference_id instead. Note: This is the reference_id that you can include in the endpoint URL for follow-on transactions.
check	masked_account_number	String	Masked account number used for a check transaction.
routing_number	String	Routing number used for a check transaction.
check_number	String	The check number used for the transaction.
token	String	Unique reference for the customer's payment details that they stored in our vault. Note: Do not send this token in follow-on transactions as it is not yet compliant with card brand regulations.
payment	amount	String	Total amount taken from the customer's account.
type	String	Type of payment for the transaction. For a list of possible values, see the payment type enumeration.
transaction	entry_class	String	Standard entry class to designate how the transaction was authorized by the originator. Applicable for US check transactions only. Possible values: • CCD • PPD • TEL • WEB
links	checksale_id	Object	Object that includes HATEOAS links for follow-on transactions using the checksale_id.
reference_id	Object	Object that includes HATEOAS links for follow-on transactions using the referencee_id.

checkrefund_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the checkrefund_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a sale id.

reference_id object

Field	Type	Description
href	String	Endpoint URL for the follow-on transaction using the reference_id.
relation	String	Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following: • return - The transaction uses the returns endpoint. • self - The transaction uses the same type of endpoint as the original request. • void - The transaction uses the void endpoint.
method	String	HTTP method for sending the request. The value is one of the following: • GET • PATCH • POST • PUT
description	String	Text that describes how to use the endpoint URL our gateway provided in the href field. For example, Use this endpoint to retrieve a previous check sales transaction using a reference id.