Sale or Authorization

post

https://api.openpath.io/api/transact.php

The Openpath NMI Emulation API accepts transactions via query string, form data, or recommended URL-encoded POST. Responses include metadata in custom headers like PacketId and GatewayName.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

type

string

required

The type of transaction to be processed. Values: 'sale', 'auth', 'credit', 'validate', or 'offline'

username

string

required

Site Username assigned to a merchant Site account as API Login ID.

password

string

required

Site Password assigned to a merchant Site account as Transaction Key.

ccnumber

integer

required

Credit card number.

ccexp

integer

required

Credit card expiration date. Format: MMYY

cvv

string

The card security code. While this is not required, it is strongly recommended.

amount

double

required

Total amount to be charged. For validate, the amount must be omitted or set to 0.00. Format: x.xx

decline_code

string

If using decline recapture, Response code received from the gateway.

decline_description

string

If using decline recapture, Description of the response, usually the response message.

decline_source

string

If using decline recapture, This is the source of the code from the original transaction E.g.: "nmi", "Paypal", "WorldPay", "Tenerum", "Stripe", "Authorize.Net"

decline_avs_code

string

If using decline recapture, Address Verification Service result code.

decline_cvv_code

string

If using decline recapture, Card Verification Value result code.

sec_code

string

The Standard Entry Class code of the ACH transaction. Values: 'PPD', 'WEB', 'TEL', or 'CCD'

surcharge

double

Surcharge amount. Format: x.xx

currency

string

The transaction currency. Format: ISO 4217

payment

string

The type of payment. Default: 'creditcard' Values: 'creditcard', 'check', or 'cash'

dup_seconds

integer

Sets the time in seconds for duplicate transaction checking on supported processors. Set to 0 to disable duplicate checking. This value should not exceed 7862400.

descriptor

string

Set payment descriptor on supported processors.

descriptor_phone

string

Set payment descriptor phone on supported processors.

descriptor_address

string

Set payment descriptor address on supported processors.

descriptor_city

string

Set payment descriptor city on supported processors.

descriptor_state

string

Set payment descriptor state on supported processors.

descriptor_postal

string

Set payment descriptor postal code on supported processors.

descriptor_country

string

Set payment descriptor country on supported processors.

descriptor_mcc

integer

Set payment descriptor mcc on supported processors.

descriptor_merchant_id

string

Set payment descriptor merchant id on supported processors.

descriptor_url

string

Set payment descriptor url on supported processors.

order_description

string

Order description. Legacy variable includes: orderdescription

orderid

string

Order Id.

ipaddress

string

IP address of cardholder, this field is recommended. Format: xxx.xxx.xxx.xxx

tax

double

The sales tax included in the transaction amount associated with the purchase. Setting tax equal to any negative value indicates an order that is exempt from sales tax. Default: '0.00' Format: x.xx

shipping

double

Total shipping amount.

first_name

string

Cardholder's first name. Legacy variable includes: firstname

last_name

string

Cardholder's last name Legacy variable includes: lastname

company

string

Cardholder's company.

address1

string

Card billing address.

address2

string

Card billing address, line 2.

city

string

Card billing city.

state

string

Card billing state. Format: CC

zip

string

Card billing zip code.

country

string

Card billing country. Country codes are as shown in ISO 3166. Format: CC

phone

string

Billing phone number.

string

Billing email address.

shipping_address1

string

Shipping address.

shipping_city

string

Shipping city.

shipping_state

string

Shipping state Format: CC.

shipping_zip

string

Shipping zip code.

shipping_country

string

Shipping country Country codes are as shown in ISO 3166. Format: CC

item_product_code_1

string

item_product_code_# where # equals line number Merchant defined description code of the item being purchased.

item_description_1

string

item_description_# equals line number Description of the item(s) being supplied.

item_unit_cost_1

float

item_unit_cost_# equals line number Unit cost of item purchased, may contain up to 4 decimal places.

item_quantity_1

float

item_quantity_# equals line number Quantity of the item(s) being purchased. Default: '1'

item_total_amount_1

double

item_total_amount_# equals line number Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default: '0.00' Format: x.xx

item_product_code_2

string

item_product_code_# where # equals line number Merchant defined description code of the item being purchased.

item_description_2

string

item_description_# equals line number Description of the item(s) being supplied.

item_unit_cost_2

float

item_unit_cost_# equals line number Unit cost of item purchased, may contain up to 4 decimal places.

item_quantity_2

float

item_quantity_# equals line number Quantity of the item(s) being purchased. Default: '1'

item_total_amount_2

double

item_total_amount_# equals line number Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default: '0.00' Format: x.xx

Form Data

Headers

Content-Type

string

Response

200OK