a a

InterPayments API Documentation

How To Include Surcharging In Your Payments Workflow?

Integration of the InterPayments surcharging solution into your payments workflow requires two calls to our service. The first call is made to determine if the transaction is allowed to be surcharged and if it is then it determines the proper amount for the surcharge. The second call tells us the transaction is complete.

In a typical implementation the Transaction Fee call is made as soon as the three required pieces of information are known: 1) Transaction Amount - in US dollars 2) Customer Location - shipping address zip code 3) Card BIN Number - first six digits of the credit card

The surcharging solution will determine if a surcharge should be applied and return the proper surcharge to be added to the transaction total and presented to the customer as a separate line item on the customers receipt.

Once the customer has confirmed the completion of the sale, the Sale call is made to InterPayments to update the InterPayments transaction status from “in-progress” to “completed”.

Our Endpoints

Sample transaction fee POST call
{
    "region":"85004",
    "nicn":"424242",
    "amount":100.00,

    "campaign": ["Optional text field1"]
}

Sample Response
{
    "transactionFee": 3.35,
    "sTxId": "5ml635gste9log31t5llq2akg",
    "message": "ok"
}

Response Codes
Success:    201 Transaction fee calculated.


Failure:    400 Invalid input. See required parameters

            401 Authorization information is missing or invalid

Sample transaction fee POST call
{
    "region":"85004",
    "nicn":"424242",
    "amount":100.00,

    "campaign": ["Optional text field1"]
}

Sample Response
{
    "transactionFee": 3.35,
    "sTxId": "5ml635gste9log31t5llq2akg",
    "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
MassachusettsMA01001
US IslandsGuam, American Samoa, Puerto Rico, Virgin Islands, US Outlying islands96910