BALANCE

BALANCE Inquiry transactions request the related balance amount fields for the card through the appropriate card association.

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 a 'balance' transaction

POST, /v0/transaction/balance

REQUEST Object Attributes

View REQUEST Object Attributes

balanceTable

Attribute	Data Type	Description	Required
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
Token	object	Indicates the Token ID as the payment method Token is aKey/Value of the "PaymentMethod" > "Card" Object	False
TokenID	ksuid	Token ID TokenID is aKey/Value of the "PaymentMethod" > "Card" > "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
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
TransactionEntry	object	See Transaction Entry Section (Information about transaction entry)	False

REQUEST Example: Balance request

Added Tax and Added Custom Merchant Data Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/balance
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "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": {
            "InitiatedByPOS": true
        }
    },
    "TransactionEntry": {
        "Device": "Ingenico Move/5000",
        "DeviceVersion": "0.0",
        "Application": "EXAMPLE POS App",
        "ApplicationVersion": "0.0",
        "Timestamp": "2021-02-02T14:06:18"
    },
    "Detail": {
        "MerchantData": {
            "OrderNumber": "22-1111",
            "TrackingID": "123456789",
            "CustomerID": "991111"
        }
    }
}'

REQUEST Example: Balance with an embedded Token Add request

Added Tax and Added Custom Merchant Data Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/balance
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "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": {
            "InitiatedByPOS": true
        }
    },
    "TransactionEntry": {
        "Device": "Ingenico Move/5000",
        "DeviceVersion": "0.0",
        "Application": "EXAMPLE POS App",
        "ApplicationVersion": "0.0",
        "Timestamp": "2021-02-02T14:06:18"
    },
    "Detail": {
        "MerchantData": {
            "OrderNumber": "22-1111",
            "TrackingID": "123456789",
            "CustomerID": "991111"
        }
    }
}'

REQUEST Example: Balance using Token ID

Added Tax and Added Custom Merchant Data Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/balance
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "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": {
            "InitiatedByPOS": true
        }
    },
    "TransactionEntry": {
        "Device": "Ingenico Move/5000",
        "DeviceVersion": "0.0",
        "Application": "EXAMPLE POS App",
        "ApplicationVersion": "0.0",
        "Timestamp": "2021-02-02T14:06:18"
    },
    "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"
}