a a

SurchX API Documentation

surchxflow

How does the API work?

The SurchX Transaction Fee API is used whenever a credit card processing action will happen. Our API has four endpoints (listed below)

Our Endpoints

Sample POST Call
{
    "campaign": [
        "justTesting"
    ],
    "country": "840",
    "region": "90210",
    "processor": "SurchX",
    "amount": 49.95,
    "nicn": "414709",
    "mTxId": "order-2018-09-01-0001",
    "sTxId": "569f6973-db7a-454f-9f69-73db7a954f68"
}

Sample Response
{
    "transactionFee": 3.04,
    "sTxId": "569f6973-db7a-454f-9f69-73db7a954f68",
    "message": "ok"
}

Response Codes
Success:    201 Transaction fee calculated.


Failure:    400 Invalid input. See required parameters

            401 Authorization information is missing or invalid

Sample POST Call
{
    "campaign": [
        "justTesting"
    ],
    "country": "840",
    "region": "90210",
    "processor": "SurchX",
    "amount": 49.95,
    "nicn": "414709",
    "mTxId": "order-2018-09-01-0001",
    "sTxId": "569f6973-db7a-454f-9f69-73db7a954f68"
}

Sample Response
{
    "transactionFee": 3.04,
    "sTxId": "569f6973-db7a-454f-9f69-73db7a954f68",
    "message": "ok"
}

Response Codes
Success:    201 Transaction fee calculated.


Failure:    400 Invalid input. See required parameters

            401 Authorization information is missing or invalid

Example NICNs
NICNType(Non)Chargeable
343434AMEXChargeable
444433VisaChargeable
446203Visa DebitNonchargeable
555555MastercardChargeable
601111DiscoverChargeable
These states currently do not allow surcharging
StateState AbbreviationSample Zip Code
ColoradoCO80011
ConnecticutCT06001
KansasKS66103
MaineME04004
MassachusettsMA01001
OklahomaOK73001
US IslandsGuam, American Samoa, Puerto Rico, Virgin Islands, US Outlying islands96910