AUTH

AUTH simply authorizes a transaction WITHOUT CAPTURE. It is generally used for eCommerce transactions with delayed product shipment.

Successful requests will be indicated with a 2xx HTTP response code and the Approved attribute set to 'true'.

NOTE

It is possible to receive an HTTP 2xx response code indicating that the request was successfully received, understood, and processed at the HTTP protocol level, but still have the Approved attribute set to false. (A 2xx response code with an Approved attribute set to false means the server successfully handled the request itself; however the actual business or application logic determined that the request was not approved).

Available Functions

Perform an 'auth' transaction

POST, /v0/transaction/auth

REQUEST Object Attributes

View REQUEST Object Attributes

authTable

Attribute	Data Type	Description	Required
Amount	object	Amount Object	True
Total	decimal	Total Transaction Amount Total is aKey/Value of the "Amount" Object	True
Tip	decimal	Tip associated with the Transaction Tip is aKey/Value of the "Amount" Object	False
Fee	decimal	Fee associated with the Transaction Fee is aKey/Value of the "Amount" Object	False
Tax	decimal	Tax associated with the Transaction Tax is aKey/Value of the "Amount" Object	False
Taxable	decimal	Tax associated with the Transaction Taxable is aKey/Value of the "Amount" Object	False
Shipping	decimal	Shipping associated with the Transaction Shipping is aKey/Value of the "Amount" Object	False
Duty	decimal	Duty associated with the Transaction Duty is aKey/Value of the "Amount" Object	False
Discount	decimal	Discount associated with the Transaction (Informational Only) Discount is aKey/Value of the "Amount" Object	False
Cashback	decimal	Use requires special permission from PayNetworx. Cash back amount associated with the Transaction Cashback is aKey/Value of the "Amount" Object	False
Currency	string	ISO 3-letter currency code Currency is aKey/Value of the "Amount" Object	True
PaymentMethod	object	Transaction Payment Method	True
Card	object	Card info Card is aKey/Value of the "PaymentMethod" Object	True
CardPresent	boolean	Indicates if this card is present CardPresent is aKey/Value of the "PaymentMethod" > "Card" Object	True
CVC	object	Card Verification Value (AKA CVV2) CVC is aKey/Value of the "PaymentMethod" > "Card" Object	False
CVC	string	Card Verification Value (AKA CVV2) CVC is aKey/Value of the "PaymentMethod" > "Card" > "CVC" Object	False
PAN	object	Personal Account Number Info PAN is aKey/Value of the "PaymentMethod" > "Card" Object	True
PAN	string	Personal Account Number PAN is aKey/Value of the "PaymentMethod" > "Card" > "PAN" Object	True
ExpMonth	string	Account Expiration Month (MM) ExpMonth is aKey/Value of the "PaymentMethod" > "Card" > "PAN" Object	True
ExpYear	string	Account Expiration Year (YY) ExpYear is aKey/Value of the "PaymentMethod" > "Card" > "PAN" Object	True
Track2	object	Track 2 Data Track2 is aKey/Value of the "PaymentMethod" > "Card" Object	False
Track2	string	Track 2 string ("Start" and "End" sentinels required) Track2 is aKey/Value of the "PaymentMethod" > "Card" > "Track2" Object	False
BillingAddress	object	Customer billing address BillingAddress is aKey/Value of the "PaymentMethod" > "Card" Object	False
Name	string	Customer name (Full Name) Name is aKey/Value of the "PaymentMethod" > "Card" > "BillingAddress" Object	False
Line1	string	Customer address line 1 Line1 is aKey/Value of the "PaymentMethod" > "Card" > "BillingAddress" Object	False
Line2	string	Customer address line 2 Line2 is aKey/Value of the "PaymentMethod" > "Card" > "BillingAddress" Object	False
City	string	Customer city City is aKey/Value of the "PaymentMethod" > "Card" > "BillingAddress" Object	False
State	string	Customer state State is aKey/Value of the "PaymentMethod" > "Card" > "BillingAddress" Object	False
PostalCode	string	Customer postal code (AKA Zip Code) PostalCode is aKey/Value of the "PaymentMethod" > "Card" > "BillingAddress" Object	False
Country	string	Customer country Country is aKey/Value of the "PaymentMethod" > "Card" > "BillingAddress" Object	False
Phone	string	Customer Phone Number Phone is aKey/Value of the "PaymentMethod" > "Card" > "BillingAddress" Object	False
Email	string	Customer Email Email is aKey/Value of the "PaymentMethod" > "Card" > "BillingAddress" Object	False
3DSecure	object	3D Secure Result data for verification of card transactions 3DSecure is aKey/Value of the "PaymentMethod" > "Card" Object	False
AuthenticationValue	string	Authentication value from 3D Secure results Authentication Value is aKey/Value of the "PaymentMethod" > "Card" > "3DSecure" Object	False
ECommerceIndicator	string	ECommerce indicator (ECI) from 3D Secure results ECommerceIndicator is aKey/Value of the "PaymentMethod" > "Card" > "3DSecure" Object	False
3DSecureTransactionID	string	3D Secure Transaction ID from 3D Secure results 3DSecureTransactionID is aKey/Value of the "PaymentMethod" > "Card" > "3DSecure" Object	False
Token	object	Indicates the Token ID as the payment method Token is aKey/Value of the "PaymentMethod" Object	False
TokenID	ksuid	Token ID TokenID is aKey/Value of the "PaymentMethod" > "Token" Object	False
DataAction	string	Data Action	False
Attributes	object	Transaction attributes	False
EntryMode	object	Description of the card entry mode EntryMode is aKey/Value of the "Attributes" Object	False
ProcessingSpecifiers	object	Description of the specific data used for processing the transaction. ProcessingSpecifiers is aKey/Value of the "Attributes" Object	False
TransactionDescriptor	object	Description of the transaction used for dynamic descriptors. TransactionDescriptor is aKey/Value of the "Attributes" Object	False
Prefix	object	The Prefix for the transaction used for dynamic descriptors. Prefix is aKey/Value of the "Attributes" > "TransactionDescriptor" Object	False
Detail	object	The Detail for the transaction used for dynamic descriptors. Detail is aKey/Value of the "Attributes" > "TransactionDescriptor" Object	False
Recurring	object	See Recurring Section (Use with Recurring Payment, Standing Payment, Unscheduled Payment requests)	False
Detail	object	Transaction Details	False
MerchantData	object	Merchant Defined Transaction Data (supports 1 or more Merchant Defined Keys) MerchantData is aKey/Value of the "Detail" Object	False
MerchantDefinedKey1	string	Merchant - defined transaction data (field 1) MerchantDefinedKey1 is aKey/Value of the "Detail" > "MerchantData" Object	False
MerchantDefinedKey2	string	Merchant - defined transaction data (field 2) MerchantDefinedKey2 is aKey/Value of the "Detail" > "MerchantData" Object	False
Order	object	Order data details for purchase (Standard Data and Corporate Data) Order is aKey/Value of the "Detail" Object	False
Item	object array	Item data details for purchase (Standard Data and Corporate Data) Item is aKey/Value of the "Detail" Object	False
ShipTo	object	ShipTo receiver data (Standard Data and Corporate Data) ShipTo is aKey/Value of the "Detail" Object	False
ShipFrom	object	ShipFrom sender data (Standard Data and Corporate Data) ShipFrom is aKey/Value of the "Detail" Object	False
Shipment	object array	Shipment details in Detail Shipment Data Section (Standard Data and Corporate Data) Shipment is aKey/Value of the "Detail" Object	False
TransactionEntry	object	See Transaction Entry Section (Information about transaction entry)	False

REQUEST Object Non-Required Attributes

Non-required attributes should only be included if needed for your use case. If not used, they should be omitted from the request object.

When should I include non-required attributes?

"Fee" attribute:

Include only if adding a fee to the transaction

"Tip" attribute:

Include only if adding tip to a transaction

"Fee" attribute:

Include only if adding a fee to a transaction

"Tax" attribute:

Include only if adding tax to a transaction

"Taxable" attribute:

Include only if adding tax to a transaction

"Shipping" attribute:

Include only if adding shipping to a transaction

"Duty" attribute:

Include only if adding duty fees to a transaction

"Discount" attribute:

Include only if adding a discount to a transaction

"Cashback" attribute:

Use requires special permission from PayNetWorx. Include only if adding a cash back to a transaction

---

"CVC" attribute:

Include only if card verification value (aka CVV2) is present. Will take form of CVC: {CVC: 'string'}

"CVC" sub-attribute:

Include only if CVC attribute is used

---

"Data" sub-attribute:

Include only if PIN attribute is present

"KSN" sub-attribute:

Include only if PIN attribute is present

---

"Billing Address" attribute:

Include only if a billing Address is required for the transaction

"Name" sub-attribute:

Include only if a Billing Address is present

"Line1" sub-attribute:

Include only if a Billing Address is present

"Line2" sub-attribute:

Include only if a Billing Address is present and Line1 sub-attribute is not sufficient

"City" sub-attribute:

Include only if a Billing Address is present

"State" sub-attribute:

Include only if a Billing Address is present

"Postal Code" sub-attribute:

Include only if a Billing Address is present

"Country" sub-attribute:

Include only if a Billing Address is present

"Phone" sub-attribute:

Include only if a Billing Address is present, and Phone number is available

"Email" sub-attribute:

Include only if a Billing Address is present, and Email address is available

---

"DebitType" sub-attribute:

Include only if a this is a debit transaction

---

"Detail" attribute:

Include when specific transaction detail must accompany the request

"Order" attribute:

Include Order data details for purchases when the merchant prefers to provide data or needs to provide data (i.e., corporate cards)

"Items" attribute:

Include Items data details for purchases when the merchant prefers to provide data or needs to provide data (i.e., corporate cards)

"ShipTo" attribute:

Include ShipTo data details for purchases when the merchant prefers to provide data or needs to provide data (i.e., corporate cards)

"ShipFrom" attribute:

Include ShipFrom data details for purchases when the merchant prefers to provide data or needs to provide data (i.e., corporate cards)

"Shipment" attribute:

Include Shipment data details for purchases when the merchant prefers to provide data or needs to provide data (i.e., corporate cards)

Include only if adding the "Merchant Data" attribute

"Merchant Data" attribute:

Include only if adding custom merchant defined transaction data using the "MerchantDefinedKey1" and/or "Merchant DefinedKey2" attribute(s)

"MerchantDefinedKey1" attribute:

Include only for adding custom merchant data (ex. OrderNumber, CustomerID)

"MerchantDefinedKey2" attribute:

Include only for adding custom merchant data (ex. OrderNumber, CustomerID)

The Request examples show example uses of optional fields in practice.

REQUEST Example: eCommerce

Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/auth
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 5.50,
        "Fee": 0.50,
        "Tax": 0.90,
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Card": {
            "CardPresent": false,
            "CVC": {
                "CVC": "1234"
            },
            "PAN": {
                "PAN": "5204910211482784",
                "ExpMonth": "12",
                "ExpYear": "25"
            },
            "BillingAddress": {
                "Name": "Jane Doe",
                "Line1": "1234 Main St",
                "Line2": "Suite A",
                "City": "Cityville",
                "State": "TX",
                "PostalCode": "75000",
                "Country": "US",
                "Phone": "555-555-5555",
                "Email": "example@example.com"
            }
        }
    },
    "Attributes": {
        "EntryMode": "manual",
        "ProcessingSpecifiers": {
            "InitiatedByECommerce": true
        }
    },
    "TransactionEntry": {
        "Device": "NA",
        "DeviceVersion": "NA",
        "Application": "Merchant Website Express",
        "ApplicationVersion": "1.0",
        "Timestamp": "2020-03-03T17:01:44"
    },
    "Detail": {
        "MerchantData": {
            "OrderNumber": "22-1111",
            "TrackingID": "123456789",
            "CustomerID": "991111"
        }
    }
}'

REQUEST Example: eCommerce with an embedded Token Add request

Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/auth
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 5.50,
        "Fee": 0.50,
        "Tax": 0.90,
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Card": {
            "CardPresent": false,
            "CVC": {
                "CVC": "1234"
            },
            "PAN": {
                "PAN": "5204910211482784",
                "ExpMonth": "12",
                "ExpYear": "25"
            },
            "BillingAddress": {
                "Name": "Jane Doe",
                "Line1": "1234 Main St",
                "Line2": "Suite A",
                "City": "Cityville",
                "State": "TX",
                "PostalCode": "75000",
                "Country": "US",
                "Phone": "555-555-5555",
                "Email": "example@example.com"
            }
        }
    },
    "DataAction": "token/add",
    "Attributes": {
        "EntryMode": "manual",
        "ProcessingSpecifiers": {
            "InitiatedByECommerce": true
        }
    },
    "TransactionEntry": {
        "Device": "NA",
        "DeviceVersion": "NA",
        "Application": "Merchant Website Express",
        "ApplicationVersion": "1.0",
        "Timestamp": "2020-03-03T17:01:44"
    },
    "Detail": {
        "MerchantData": {
            "OrderNumber": "22-1111",
            "TrackingID": "123456789",
            "CustomerID": "991111"
        }
    }
}'

REQUEST Example: eCommerce using Token ID

Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/auth
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 5.50,
        "Fee": 0.50,
        "Tax": 0.90,
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Token": {
            "TokenID": "1wxhkFx6JoPktNoPYpgFpSGmTMF"
        },
        "Card": {
            "BillingAddress": {
                "Name": "Jane Doe",
                "Line1": "1234 Main St",
                "Line2": "Suite A",
                "City": "Cityville",
                "State": "TX",
                "PostalCode": "75000",
                "Country": "US",
                "Phone": "555-555-5555",
                "Email": "example@example.com"
            }
        }
    },
    "Attributes": {
        "EntryMode": "card-on-file",
        "ProcessingSpecifiers": {
            "InitiatedByECommerce": true
        }
    },
    "TransactionEntry": {
        "Device": "NA",
        "DeviceVersion": "NA",
        "Application": "Merchant Website Express",
        "ApplicationVersion": "1.0",
        "Timestamp": "2020-03-03T17:01:44"
    },
    "Detail": {
        "MerchantData": {
            "OrderNumber": "22-1111",
            "TrackingID": "123456789",
            "CustomerID": "991111"
        }
    }
}'

REQUEST Example: eCommerce Using 3DSecure

Permission Required

Use of 3DSecure functionality requires special permission from PayNetWorx.

Code Sample using CURL (American Express)

URL=https://api.qa.paynetworx.net/v0/transaction/auth
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 5.50,
        "Fee": 0.50,
        "Tax": 0.90,
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Card": {
            "CardPresent": false,
            "CVC": {
                "CVC": "1234"
            },
            "PAN": {
                "PAN": "5204910211482784",
                "ExpMonth": "12",
                "ExpYear": "25"
            },
            "BillingAddress": {
                "Name": "Jane Doe",
                "Line1": "1234 Main St",
                "Line2": "Suite A",
                "City": "Cityville",
                "State": "TX",
                "PostalCode": "75000",
                "Country": "US",
                "Phone": "555-555-5555",
                "Email": "example@example.com"
            },
            "3DSecure": {
                "ECommerceIndicator": "05",
                "AuthenticationValue": "AAABBWcSNIdjeUZThmNHAAAAAAA="
            }
        }
    },
    "Attributes": {
        "EntryMode": "manual",
        "ProcessingSpecifiers": {
            "InitiatedByECommerce": true
        }
    },
    "TransactionEntry": {
        "Device": "NA",
        "DeviceVersion": "NA",
        "Application": "Merchant Website Express",
        "ApplicationVersion": "1.0",
        "Timestamp": "2020-03-03T17:01:44"
    },
    "Detail": {
        "MerchantData": {
            "OrderNumber": "22-1111",
            "TrackingID": "123456789",
            "CustomerID": "991111"
        }
    }
}'

Code Sample using CURL (VISA)

URL=https://api.qa.paynetworx.net/v0/transaction/auth
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 5.50,
        "Fee": 0.50,
        "Tax": 0.90,
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Card": {
            "CardPresent": false,
            "CVC": {
                "CVC": "1234"
            },
            "PAN": {
                "PAN": "4012001037141112",
                "ExpMonth": "12",
                "ExpYear": "27"
            },
            "BillingAddress": {
                "Name": "Jane Doe",
                "Line1": "1234 Main St",
                "Line2": "Suite A",
                "City": "Cityville",
                "State": "TX",
                "PostalCode": "75000",
                "Country": "US",
                "Phone": "555-555-5555",
                "Email": "example@example.com"
            },
            "3DSecure": {
                "AuthenticationValue": "0099010618111100000000788400707000000000",
                "ECommerceIndicator": "05"
            }
        }
    },
    "Attributes": {
        "EntryMode": "manual",
        "ProcessingSpecifiers": {
            "InitiatedByECommerce": true
        }
    },
    "TransactionEntry": {
        "Device": "NA",
        "DeviceVersion": "NA",
        "Application": "Merchant Website Express",
        "ApplicationVersion": "1.0",
        "Timestamp": "2020-03-03T17:01:44"
    },
    "Detail": {
        "MerchantData": {
            "OrderNumber": "22-1111",
            "TrackingID": "123456789",
            "CustomerID": "991111"
        }
    }
}'

RESPONSE Object Attributes

View RESPONSE Object Attributes

defaultResponseTable

Attribute	Data Type	Description
TransactionID	ksuid	Unique transaction lifetime system ID
EventID	ksuid	Unique transaction event system ID
RequestID	ksuid	Unique transaction request system ID
Approved	boolean	Request approval indicator
Token	object	Request approval indicator
TokenID	ksuid	Token ID TokenID is aKey/Value of the "Token" Object
TokenName	string	Unique Name of the Token Used TokenName is aKey/Value of the "Token" Object
AddressLine1Check	string	Address verification result (pass, fail, unavailable, unchecked)
AddressZipCheck	string	Postal code verification result (pass, fail, unavailable, unchecked)
CVCCheck	string	CVC result (pass, fail, unavailable, unchecked)
CVCCheckResultCode	string	Letter Code (returned from the card association)

RESPONSE Example

JSON Response Object

{
  "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
  "EventID": "1XSnvq7J5ggxZg70sWuRg4kEBcu",
  "RequestID": "1XSnzEjZ4IBh5Nj0OEVPTWpwYo8",
  "Approved": true,
  "AddressLine1Check": "pass",
  "AddressZipCheck": "pass",
  "CVCCheck": "pass"
}

RESPONSE Example with an embedded Token Add request

JSON Response Object

{
  "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
  "EventID": "1XSnvq7J5ggxZg70sWuRg4kEBcu",
  "RequestID": "1XSnzEjZ4IBh5Nj0OEVPTWpwYo8",
  "Approved": true,
  "Token": {
    "TokenID": "1wxhkFx6JoPktNoPYpgFpSGmTMF",
    "TokenName": "************2784"
  },
  "AddressLine1Check": "pass",
  "AddressZipCheck": "pass",
  "CVCCheck": "pass"
}

RESPONSE Example using Token ID

JSON Response Object

{
  "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
  "EventID": "1XSnvq7J5ggxZg70sWuRg4kEBcu",
  "RequestID": "1XSnzEjZ4IBh5Nj0OEVPTWpwYo8",
  "Approved": true,
  "Token": {
    "TokenID": "1wxhkFx6JoPktNoPYpgFpSGmTMF",
    "TokenName": "************2784"
  },
  "AddressLine1Check": "pass",
  "AddressZipCheck": "pass",
  "CVCCheck": "pass"
}