Running a Credit Authorization

Column 1	Column 2	Column 3
Environment	HTTP Method	URL
Test	Post	https://api.pit.paygateway.com/transactions/cardpresent/auths
Production	Post	https://api.paygateway.com/transactions/cardpresent/auths

Column 1

Column 2

Column 3

Environment

HTTP Method

URL

Test

Post

https://api.pit.paygateway.com/transactions/cardpresent/auths

Production

Post

https://api.paygateway.com/transactions/cardpresent/auths

Column 1	Column 2	Column 3	Column 4	Column 5	Column 6
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.
payment	amount	String	1-10	Required	Total dollar amount for the sale. 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.
invoice_number	String	1-8	Required	Alphanumeric invoice number or order number that the merchant creates and assigns to the sale.
gratuity_eligible_amount	String	1-7	Optional	Gratuity amount included in the total amount for the transaction. Maximum value: 9999.99.
healthcare_amounts	Object		Optional	Object that includes options for additional healthcare details. For a list of parameters, see the healthcare amounts object.
purchase_order	Object		Optional	Object that includes options for additional purchase order details. For a list of parameters, see the purchase amount object.
receipt	clerk_id	String	1-20	Required	Clerk ID that the merchant wants to display on the receipt. This is an alphanumeric value that the merchant assigns to a clerk, for example, Al090-John Doe.
transaction	keyed_entry_mode	String	Explicit	Optional	Indicates if the device allows the user to enter the card details using the keypad. Send one of the following values: default - The device uses only keyed entry. allowed - The device can accept keyed entry and displays it as an option on the payment selection screen. Note: If you don’t send a value, the device doesn’t display keyed entry as an option on the payment selection screen.
	country_code	String	Explicit	Required	ISO code for the country where the sale originated. For a list of possible values, see the country code enumeration
	language		Explicit	Optional	Language for transaction. Unless overridden by EMV chip in payment card, POS device prompts and receipts are generated in this language. Example: en-US
	processing_indicators	Object		Optional	Object that includes options for additional actions. For a list of parameters, see the processing indicators object.
	create_token_reason	String	Explicit	Conditional	If the value for create_token is true, you must indicate who requested the transaction. Send one of the following values: unscheduled_merchant_initiated_transaction - The merchant requested the transaction. unscheduled_customer_initiated_transaction - The customer requested the transaction.
	terminal	Object		Optional	Terminal information. See the terminal object.

Column 1

Column 2

Column 3

Column 4

Column 5

Column 6

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.

payment

amount

String

1-10

Required

Total dollar amount for the sale. 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.

invoice_number

String

1-8

Required

Alphanumeric invoice number or order number that the merchant creates and assigns to the sale.

gratuity_eligible_amount

String

1-7

Optional

Gratuity amount included in the total amount for the transaction. Maximum value: 9999.99.

healthcare_amounts

Object

Optional

Object that includes options for additional healthcare details. For a list of parameters, see the healthcare amounts object.

purchase_order

Object

Optional

Object that includes options for additional purchase order details. For a list of parameters, see the purchase amount object.

receipt

clerk_id

String

1-20

Required

Clerk ID that the merchant wants to display on the receipt. This is an alphanumeric value that the merchant assigns to a clerk, for example, Al090-John Doe.

transaction

keyed_entry_mode

String

Explicit

Optional

Indicates if the device allows the user to enter the card details using the keypad. Send one of the following values:
default - The device uses only keyed entry.
allowed - The device can accept keyed entry and displays it as an option on the payment selection screen.
Note: If you don’t send a value, the device doesn’t display keyed entry as an option on the payment selection screen.

country_code

String

Explicit

Required

ISO code for the country where the sale originated. For a list of possible values, see the country code enumeration

language

Explicit

Optional

Language for transaction. Unless overridden by EMV chip in payment card, POS device prompts and receipts are generated in this language. Example: en-US

processing_indicators

Object

Optional

Object that includes options for additional actions. For a list of parameters, see the processing indicators object.

create_token_reason

String

Explicit

Conditional

If the value for create_token is true, you must indicate who requested the transaction. Send one of the following values:
unscheduled_merchant_initiated_transaction - The merchant requested the transaction.
unscheduled_customer_initiated_transaction - The customer requested the transaction.

terminal

Object

Optional

Terminal information. See the terminal object.

Column 1	Column 2	Column 3	Column 4	Column 5
Parameter	Type	Size	Required?	Description
copay_amount	String	1-9	Optional;	Itemized fixed amount paid for a health care service.
clinical_amount	String	1-9	Optional	Itemized health care amount for clinical services.
dental_amount	String	1-9	Optional	Itemized health care amount for dental services.
prescription_amount	String	1-9	Optional	Itemized health care amount for prescription costs.
vision_amount	String	1-9	Optional	Itemized health care amount for optician costs.
healthcare_total_amount	String	1-9	Optional	Total amount of all itemized health care amounts.

Column 1

Column 2

Column 3

Column 4

Column 5

Parameter

Type

Size

Required?

Description

copay_amount

String

1-9

Optional;

Itemized fixed amount paid for a health care service.

clinical_amount

String

1-9

Optional

Itemized health care amount for clinical services.

dental_amount

String

1-9

Optional

Itemized health care amount for dental services.

prescription_amount

String

1-9

Optional

Itemized health care amount for prescription costs.

vision_amount

String

1-9

Optional

Itemized health care amount for optician costs.

healthcare_total_amount

String

1-9

Optional

Total amount of all itemized health care amounts.

Column 1	Column 2	Column 3	Column 4	Column 5
Parameter	Type	Size	Required?	Description
destination_postal_code	String	9	Optional	Postal code for setup transport keys.
po_number	String	17	Optional	Merchant-generated purchase order number for the transaction. Used for corporate purchase cards.
tax_amount	String	1-8	Optional	Tax amount for a staging order transaction.

Column 1

Column 2

Column 3

Column 4

Column 5

Parameter

Type

Size

Required?

Description

destination_postal_code

String

Optional

Postal code for setup transport keys.

po_number

String

Optional

Merchant-generated purchase order number for the transaction. Used for corporate purchase cards.

tax_amount

String

1-8

Optional

Tax amount for a staging order transaction.

Column 1	Column 2	Column 3	Column 4	Column 5
Parameter	Type	Size	Required?	Description
allow_duplicate	Boolean	Explicit	Optional	If set to true, you can send duplicate requests. The default time frame to block duplicate transactions is 15 minutes.
create_token	Boolean	Explicit	Optional	If set to true, we save the card details to our vault. Our gateway creates a token and returns it in the response.
partial_approval	Boolean	Explicit	Optional	If set to true, we allow you to accept partial approvals.

Column 1

Column 2

Column 3

Column 4

Column 5

Parameter

Type

Size

Required?

Description

allow_duplicate

Boolean

Explicit

Optional

If set to true, you can send duplicate requests. The default time frame to block duplicate transactions is 15 minutes.

create_token

Boolean

Explicit

Optional

If set to true, we save the card details to our vault. Our gateway creates a token and returns it in the response.

partial_approval

Boolean

Explicit

Optional

If set to true, we allow you to accept partial approvals.

Column 1	Column 2	Column 3	Column 4	Column 5
Parameter	Type	Size	Required?	Description
terminal_id	String	8-10	Optional	US/CA gateway issued terminal id.

Column 1

Column 2

Column 3

Column 4

Column 5

Parameter

Type

Size

Required?

Description

terminal_id

String

8-10

Optional

US/CA gateway issued terminal id.

Column 1	Column 2	Column 3	Column 4
Object	Field	Type	Description
	invoice_number	String	Merchant-generated invoice number for transaction.
	amount	String	Total dollar amount of the sale. Note: If the transaction was partially approved, the amount we return is less than the dollar amount you sent in the request. If the request included a tip, the amount we return is greater than the amount you send in the request.
	status	String	Indicates the status of the request. For a list of possible values, see the request status enumeration.
	currency_code	String	ISO currency code for the sale. For a list of possible values, see the currency code enumeration.
	gratuity_amount	String	Dollar amount that was tip in the original sale.
transactions	tender_type	String	The payment type that the customer used for the sale. The value is one of the following: credit debit
	entry_type	String	Indicates how the user entered the card details. The value is one of the following: Contact Contactless Manual Swipe
id	String	Unique identifier that our gateway generated for the sale. Note: This is the creditsale_id or debitsale_id that you can include in the endpoint URL for follow-on transactions.
reference_id	String	Unique identifier for the sale that the merchant created. Note: This is the reference_id that you can include in the endpoint URL for follow-on transactions.
status	String	Indicates the status of the sale. For a list of possible values, see the transaction status enumeration.
status_code	String	Indicates the status of the request. For a list of status codes, see handling responses.
processor_response	String	Transaction response from the processor.
transaction_datetime	String	Date and time of the sale that the processor returns in YYYY-MM-DDThh:mm:ssZ format, for example, 2019-12-15T13:00:00Z.
credit_attributes	String	Object that contains details of credit card transactions. See the credit_attributes object.

Column 1

Column 2

Column 3

Column 4

Object

Field

Type

Description

invoice_number

String

Merchant-generated invoice number for transaction.

amount

String

Total dollar amount of the sale.
Note:
If the transaction was partially approved, the amount we return is less than the dollar amount you sent in the request.
If the request included a tip, the amount we return is greater than the amount you send in the request.

status

String

Indicates the status of the request. For a list of possible values, see the request status enumeration.

currency_code

String

ISO currency code for the sale. For a list of possible values, see the currency code enumeration.

gratuity_amount

String

Dollar amount that was tip in the original sale.

transactions

tender_type

String

The payment type that the customer used for the sale. The value is one of the following:
credit
debit

entry_type

String

Indicates how the user entered the card details. The value is one of the following:
Contact
Contactless
Manual
Swipe

String

Unique identifier that our gateway generated for the sale.
Note: This is the creditsale_id or debitsale_id that you can include in the endpoint URL for follow-on transactions.

reference_id

String

Unique identifier for the sale that the merchant created.
Note: This is the reference_id that you can include in the endpoint URL for follow-on transactions.

status

String

Indicates the status of the sale. For a list of possible values, see the transaction status enumeration.

status_code

String

Indicates the status of the request. For a list of status codes, see handling responses.

processor_response

String

Transaction response from the processor.

transaction_datetime

String

Date and time of the sale that the processor returns in YYYY-MM-DDThh:mm:ssZ format, for example, 2019-12-15T13:00:00Z.

credit_attributes

String

Object that contains details of credit card transactions. See the credit_attributes object.

Column 1	Column 2	Column 3	Column 4
Object	Field	Type	Description
N/A	approval_code	String	Approval code for the sale from the processor.
N/A	avs_response	String	Response code from an address verification service (AVS) lookup. For a list of possible values, see the AVS response enumeration.
N/A	avs_response_description	String	Text that describes the response code that the processor returned in the avs_response field.
N/A	cardsecurity_response	String	Indicates if the card security code (CSC) that the customer entered matches the CSC of the card. For a list of possible values, see the card security response enumeration.
payment	amount	String	Total dollar amount for the sale.
	cashback_amount	String	Dollar amount of cashback for the sale.
	type	String	Type of payment for the sale. For a list of possible values, see the payment type enumeration.
	fees	String	Object that contains details of the fees that the customer paid. For a list of fees, see the fees object below.
card	masked_card_number	String	Masked card number of the card that the customer used for the sale. We mask all digits except the first six and the last four.
	cardholder_name	String	Name that appears on the customer’s card.
	expiry_month	String	Month that the card expires in MM format.
	expiry_year	String	Year that the card expires in YY format.
	token	String	Unique reference for the customer's payment details that they stored on our vault.
	type	String	Name of the card brand that issued the card. For a list of possible values, see the card type enumeration.
	balance	String	Dollar amount that remains on the card.
	postal_code	String	Postal code that the card is registered to.
	rfmiq	String	Unique token that tracks the customer’s spending habits.
	card_on_file_attributes

Column 1

Column 2

Column 3

Column 4

Object

Field

Type

Description

N/A

approval_code

String

Approval code for the sale from the processor.

N/A

avs_response

String

Response code from an address verification service (AVS) lookup. For a list of possible values, see the AVS response enumeration.

N/A

avs_response_description

String

Text that describes the response code that the processor returned in the avs_response field.

N/A

cardsecurity_response

String

Indicates if the card security code (CSC) that the customer entered matches the CSC of the card. For a list of possible values, see the card security response enumeration.

payment

amount

String

Total dollar amount for the sale.

cashback_amount

String

Dollar amount of cashback for the sale.

type

String

Type of payment for the sale. For a list of possible values, see the payment type enumeration.

fees

String

Object that contains details of the fees that the customer paid. For a list of fees, see the fees object below.

card

masked_card_number

String

Masked card number of the card that the customer used for the sale. We mask all digits except the first six and the last four.

cardholder_name

String

Name that appears on the customer’s card.

expiry_month

String

Month that the card expires in MM format.

expiry_year

String

Year that the card expires in YY format.

token

String

Unique reference for the customer's payment details that they stored on our vault.

type

String

Name of the card brand that issued the card. For a list of possible values, see the card type enumeration.

balance

String

Dollar amount that remains on the card.

postal_code

String

Postal code that the card is registered to.

rfmiq

String

Unique token that tracks the customer’s spending habits.

card_on_file_attributes

Parameter	Type	Size	Description
customer_fee_amount	String	1-9	If customer fees have been configured for the merchant account, this is the total fee amount applied to the amount submitted in the transaction.
surcharge_amount	Numeric	Variable	For US credit transactions, this is the surcharge amount applied to the amount submitted in the transaction request if surcharge fees have been configured for the merchant in the gateway. It is a dollar amount the merchant charged the cardholder as a surcharge for paying using a credit card.

Parameter

Type

Size

Description

customer_fee_amount

String

1-9

If customer fees have been configured for the merchant account, this is the total fee amount applied to the amount submitted in the transaction.

surcharge_amount

Numeric

Variable

For US credit transactions, this is the surcharge amount applied to the amount submitted in the transaction request if surcharge fees have been configured for the merchant in the gateway. It is a dollar amount the merchant charged the cardholder as a surcharge for paying using a credit card.

Column 1	Column 2	Column 3
Field	Type	Description
tokenization_error_code	String	Response code from our gateway.
tokenization_error_message	String	Text that describes why our gateway could not store the card details.

Column 1

Column 2

Column 3

Field

Type

Description

tokenization_error_code

String

Response code from our gateway.

tokenization_error_message

String

Text that describes why our gateway could not store the card details.

Column 1	Column 2	Column 3
Field	Type	Description
amount_authorized	String	Dollar amount that was approved for the sale.
amount_other	String	Dollar amount that was cashback.

Column 1

Column 2

Column 3

Field

Type

Description

amount_authorized

String

Dollar amount that was approved for the sale.

amount_other

String

Dollar amount that was cashback.

Column 1	Column 2	Column 3
Field	Type	Description
dedicated_file_name	String	Name of the EMV Dedicated File for receipts. For more information, refer to the EMVCo website.
application_label	String	Application label for an EMV transaction.
application_expiry_date	String	Date the application expires.
application_effective_date	String	Date the application was released.
application_interchange_profile	String	Indicates the card’s functions.
application_version_number	String	Version number of the application.
application_transaction_counter	String	Application transaction counter (ATC) for an EMV transaction.
application_usage_control	String	Indicates the geographic and service restrictions that the issuer has placed on the card.
application_preferred_name	String	Name of the application in the cardholder’s local language.
application_display_name	String	Name of the application to display.
application_pan_sequence_number	String	Sequence number to identify cards with the same PAN in a transaction.
application_cryptogram	String	Application cryptogram (AC) for an EMV transaction.
application_cryptogram_type	String	Type of cryptogram that the application uses. The value is one of the following: TC - Transaction Certificate AAC - Application Authorization Cryptogram ARQC - Authorization Request Cryptogram
cardholder_verification_method_results	String	Result of the last card verification.
issuer_application_data	String	Information for sending the transaction request to the issuer.
terminal_verification_results	String	Terminal verification results (TVR) for an EMV transaction.
unpredictable_number	String	Value that the terminal uses to generate a cryptogram.
pos_entry_mode	String	Indicates how the device read the card details.
terminal_type	String	Details of the terminal that sent the transaction.

Column 1

Column 2

Column 3

Field

Type

Description

dedicated_file_name

String

Name of the EMV Dedicated File for receipts. For more information, refer to the EMVCo website.

application_label

String

Application label for an EMV transaction.

application_expiry_date

String

Date the application expires.

application_effective_date

String

Date the application was released.

application_interchange_profile

String

Indicates the card’s functions.

application_version_number

String

Version number of the application.

application_transaction_counter

String

Application transaction counter (ATC) for an EMV transaction.

application_usage_control

String

Indicates the geographic and service restrictions that the issuer has placed on the card.

application_preferred_name

String

Name of the application in the cardholder’s local language.

application_display_name

String

Name of the application to display.

application_pan_sequence_number

String

Sequence number to identify cards with the same PAN in a transaction.

application_cryptogram

String

Application cryptogram (AC) for an EMV transaction.

application_cryptogram_type

String

Type of cryptogram that the application uses. The value is one of the following:
TC - Transaction Certificate
AAC - Application Authorization Cryptogram
ARQC - Authorization Request Cryptogram

cardholder_verification_method_results

String

Result of the last card verification.

issuer_application_data

String

Information for sending the transaction request to the issuer.

terminal_verification_results

String

Terminal verification results (TVR) for an EMV transaction.

unpredictable_number

String

Value that the terminal uses to generate a cryptogram.

pos_entry_mode

String

Indicates how the device read the card details.

terminal_type

String

Details of the terminal that sent the transaction.

Running a Credit Authorization

Endpoints

Endpoint:

Request

healthcare_amounts object

purchase_order object

processing_indicators object

terminal object

Request example

Response

credit_attributes object

fees object

card_on_file_attributes object

amount object

icc object

Response example