REST API Reference

Print Friendly, PDF & Email

TPS – Bankcard

 

Authorize Transaction - Required fields only
RequestUri https://api.cipcert.goevo.com/2.1.28/REST/TPS.svc/[serviceId]
Method POST
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

 {
  "$type": "AuthorizeTransaction, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "Transaction": {
    "$type": "BankcardTransactionPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
    "TenderData": {
      "$type": "BankcardTenderDataPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
      "CardData": {
        "CardType": "Visa",
        "PAN": "411111111111111",
        "Expire": "0122"
      }
    },
    "TransactionData": {
      "$type": "BankcardTransactionDataPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
      "Amount": 10.00,
      "CurrencyCode": "USD",
      "EntryMode": "Keyed"
    }
  },
  "ApplicationProfileId": "772763",
  "MerchantProfileId": "Dev_Test_28"
}
 

Implementation Notes

The following implementation notes are specific to the Authorize operation:
  • Visa and MasterCard support authorizations of $0.00.
  • American Express and Discover do not support authorizations of $0.00.
  • Discover supports the reversal (void) of authorizations, so the reversal will not show on the cardholder's statement.
  • American Express does not support the reversal (void) of authorizations. Any authorized amount will roll off after 30 days and will show on the cardholder's statement.
  • Be sure to set a unique OrderNumber in the BankcardTransactionData object. This ensures fast and convenient recovery of transactionIds in the event of communication failures.
  • The BankcardTransactionPro object is required to support BankcardInterchangeData used for recurring, installment, and deferred billing payments.
  • The BankcardTransactionDataPro object is required to support Level 2 and/or Level 3 transaction data.
Note: The HTTP Authorization Header must contain the required sessionToken value.
Capture Transaction
RequestUri https://api.cipcert.goevo.com/2.1.28/REST/TPS.svc/[serviceId]/[transactionId]
Method POST
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

{
  "$type": "Capture, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "DifferenceData": {
    "$type": "BankcardCapture, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard",
    "Amount": 13.00,
    "TransactionId": "4B760D21E24B4B7BBD71578BE87390FA",
    "TipAmount": 3.00
  },
  "ApplicationProfileId": "772763"
}
 

Response

  {
  "BatchId": "1729",
  "Status": "Successful",
  "IndustryType": "NotSet",
  "StatusCode": "1",
  "TransactionSummaryData": {
    "CashBackTotals": null,
    "NetTotals": {
      "NetAmount": 13.0,
      "Count": 1
    },
    "ReturnTotals": null,
    "SaleTotals": {
      "NetAmount": 13.0,
      "Count": 1
    },
    "VoidTotals": null,
    "PINDebitReturnTotals": null,
    "PINDebitSaleTotals": null
  },
  "StatusMessage": "Approved",
  "PrepaidCard": "NotSet",
  "TransactionId": "038B2E95E82B418D910B1B82D1ECF95B",
  "ErrorType": null,
  "OriginatorTransactionId": "9409",
  "ServiceTransactionId": "94220757",
  "ServiceTransactionDateTime": {
    "Date": "2017-03-29",
    "Time": "17:02:05.255",
    "TimeZone": "-06:00"
  },
  "Addendum": null,
  "CaptureState": "Captured",
  "TransactionState": "Captured",
  "IsAcknowledged": false,
  "Reference": null,
  "TransmissionNumber": null,
  "TransactionCode": null,
  "HostMessageId": null,
  "Geolocation": null
}
AuthorizeAndCapture Transaction - Required fields only
RequestUri https://api.cipcert.goevo.com/2.1.28/REST/TPS.svc/[serviceId]
Method POST
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

 {
  "$type": "AuthorizeAndCaptureTransaction, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "Transaction": {
    "$type": "BankcardTransactionPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
    "TenderData": {
      "$type": "BankcardTenderDataPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
      "CardData": {
        "CardType": "Visa",
        "PAN": "411111111111111",
        "Expire": "0122"
      }
    },
    "TransactionData": {
      "$type": "BankcardTransactionDataPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
      "Amount": 10.00,
      "CurrencyCode": "USD",
      "EntryMode": "Keyed"
    }
  },
  "ApplicationProfileId": "772763",
  "MerchantProfileId": "Dev_Test_28"
}
ReturnById Transaction - Required fields only
RequestUri https://api.cipcert.goevo.com/2.1.28/REST/TPS.svc/[serviceId]
Method POST
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

{
  "$type": "ReturnById, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "DifferenceData": {
    "$type": "BankcardReturn, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard",
    "TransactionId": "64E17E1FECE8465B96B9B2C855B00CF6"
  },
  "ApplicationProfileId": "772763",
  "MerchantProfileId": "Dev_Test_28"
}
Return Transaction
RequestUri https://api.cipcert.goevo.com/2.1.28/REST/TPS.svc/[serviceId]
Method POST
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

{
  "$type": "ReturnTransaction, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "Transaction": {
    "$type": "BankcardTransactionPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
    "TenderData": {
      "$type": "BankcardTenderDataPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
      "CardData": {
        "CardType": "Visa",
        "PAN": "411111111111111",
        "Expire": "0122"
      }
    },
    "TransactionData": {
      "$type": "BankcardTransactionDataPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
      "Amount": 10.00,
      "CurrencyCode": "USD",
      "EntryMode": "Keyed"
    }
  },
  "ApplicationProfileId": "772763",
  "MerchantProfileId": "Dev_Test_28"
}
Undo Transaction
RequestUri https://api.cipcert.goevo.com/2.1.28/REST/TPS.svc/[serviceId]/[transactionId]
Method PUT
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

{
  "$type": "Undo, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "DifferenceData": {
    "$type": "BankcardUndo, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard",
    "TransactionId": "9A8F6604457B41CB9CD58843D8823254"
  },
  "ApplicationProfileId": "772763"
}
QueryAccount Transaction
RequestUri https://api.cipcert.goevo.com/2.1.28/REST/TPS.svc/[serviceId]/query
Method POST
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

{
  "$type": "AuthorizeTransaction, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "Transaction": {
    "$type": "BankcardTransactionPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
    "TenderData": {
      "$type": "BankcardTenderDataPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
      "CardData": {
        "CardType": "Visa",
        "PAN": "",
        "Expire": "0122",
        "Track2Data": "4003000123456781=15125025432198712345"
      },
      "CardSecurityData": {
        "KeySerialNumber": "key serial num",
        "PIN": "pin"
      }
    },
    "TransactionData": {
      "$type": "BankcardTransactionDataPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
      "AccountType": "CheckingAccount",
      "Amount": 10.00,
      "CurrencyCode": "USD",
      "EntryMode": "TrackDataFromMSR"
    }
  },
  "ApplicationProfileId": "772763",
  "MerchantProfileId": "Dev_Test_28"
}
Verify Transaction
RequestUri https://api.cipcert.goevo.com/2.1.28/REST/TPS.svc/[serviceId]/verify
Method POST
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

{
  "$type": "AuthorizeTransaction, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "Transaction": {
    "$type": "BankcardTransactionPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
    "TenderData": {
      "$type": "BankcardTenderDataPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
      "CardData": {
        "CardType": "Visa",
        "PAN": "411111111111111",
        "Expire": "0122"
      }
    },
    "TransactionData": {
      "$type": "BankcardTransactionDataPro, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard/Pro",
      "Amount": 10.00,
      "CurrencyCode": "USD",
      "EntryMode": "Keyed"
    }
  },
  "ApplicationProfileId": "772763",
  "MerchantProfileId": "Dev_Test_28"
}
ManageAccount Transaction
RequestUri https://api.cipcert.goevo.com/2.1.28/REST/TPS.svc/[serviceId]
Method POST
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

{
  "$type": "ManageAccount, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "Transaction": {
    "$type": "StoredValueTransaction, http://schemas.evosnap.com/CWS/v2.0/Transactions/StoredValue",
    "TenderData": {
      "$type": "StoredValueActivateTenderData, http://schemas.evosnap.com/CWS/v2.0/Transactions/StoredValue",
      "CardData": {
        "AccountNumber": "1234567890"
      }
    },
    "TransactionData": {
      "Amount": 100.00,
      "OperationType": "Reload"
    }
  },
  "ApplicationProfileId": "772763",
  "MerchantProfileId": "Dev_Test_28"
}
SendReceipt
RequestUri https://api.cipcert.goevo.com/2.1.28/REST/TPS.svc/sendReceipt
Method POST
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

{
  "$type": "ReceiptRequest, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "TransactionId": "A7984D6C81194C098CC213BF731A5D24",
  "Email": "jeannine.goren@evopayments.com"
}
 

Response

Example Bankcard Response:
{
  "AdviceResponse": "NotSet",
  "Amount": 10.0,
  "Status": "Successful",
  "CommercialCardResponse": "NotSet",
  "CardType": "Visa",
  "StatusCode": "1",
  "ReturnedACI": "NotSet",
  "FeeAmount": 0.0,
  "StatusMessage": "Approved - 000:APPROVED",
  "ApprovalCode": "5UO152",
  "TransactionId": "4CB95CCE0A9B48B8961163A5B9D0A01B",
  "AVSResult": {
    "ActualResult": "0",
    "AddressResult": "NotVerified",
    "StateResult": "NotSet",
    "CountryResult": "NotSet",
    "PostalCodeResult": "NotVerified",
    "PhoneResult": "NotSet",
    "CardholderNameResult": "NotSet",
    "CityResult": "NotSet"
  },
  "OriginatorTransactionId": "2518",
  "BatchId": "1709",
  "ServiceTransactionId": "90757885",
  "CVResult": "NotProcessed",
  "ServiceTransactionDateTime": {
    "Date": "2017-01-09",
    "Time": "23:08:58.766",
    "TimeZone": "-06:00"
  },
  "CardLevel": "",
  "Addendum": null,
  "DowngradeCode": "",
  "CaptureState": "Captured",
  "MaskedPAN": "411111XXXXX1111",
  "TransactionState": "Captured",
  "PaymentAccountDataToken": "4cb95cce-0a9b-48b8-9611-63a5b9d0a01b23c8b0e9-b3f4-42b9-9822-f70ae5fdc612",
  "IsAcknowledged": false,
  "RetrievalReferenceNumber": "",
  "Reference": "",
  "Resubmit": "NotSet",
  "TransmissionNumber": "",
  "SettlementDate": "0001-01-01T00:00:00",
  "TransactionCode": "",
  "FinalBalance": 0.0,
  "HostMessageId": "",
  "OrderId": "2418",
  "Geolocation": null,
  "CashBackAmount": 0.0,
  "PrepaidCard": "NotSet",
  "Expire": "0122",
  "ErrorType": null,
  "AuthorizationServerUrl": "",
  "PaymentAuthorizationRequest": "",
  "ProcessedAs3D": false,
  "EMVDataResponse": null,
  "Level3Added": "NotSet",
  "LastPANDigits": "",
  "BatchAmount": 0.0,
  "MessageAuthenticationCode": "",
  "TokenInformation": null,
  "ForcePostCode": "",
  "MerchantId": "ES0000000000002",
  "TerminalId": "001",
  "BankResponseCode": null,
  "InitialEncryptionKeys": null
}
Resubmit Transaction
RequestUri https://api.cipcert.goevo.com/2.1.29/REST/TPS.svc/[serviceId]
Method POST
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

{
  "$type": "ResubmitTransaction, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "Transaction": {
    "TransactionId": "924E6160D8DA4CC0BB2ECE801595306D",
    "ResubmitReason": "Correction",
    "Amount": 25.00,
    "TipAmount": 5.0
  },
  "ApplicationProfileId": "772763",
  "MerchantProfileId": "Dev Test .28"
}
ResubmitOrderUpdate
RequestUri https://api.cipcert.goevo.com/2.1.29/REST/TPS.svc/[serviceId]
Method POST
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

 {
  "$type": "ResubmitTransaction, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "Transaction": {
  "$type": "ResubmitOrderUpdate, http://schemas.evosnap.com/CWS/v2.0/Transactions/Bankcard",
  "TransactionId": "FD4772F3B4564B3DAEC1374BB6ECAE30",
  "Level2Data": null,
  "ResubmitReason": "OrderUpdate",
  "LineItemDetails": [
  {
  "Amount": 2.00,
  "CommodityCode": null,
  "Description": "description",
  "DiscountAmount": 0.00,
  "DiscountIncluded": false,
  "ProductCode": null,
  "Quantity": 0.00,
  "Tax": null,
  "TaxIncluded": false,
  "UnitOfMeasure": "NotSet",
  "UnitPrice": 0.00,
  "UPC": null
  }
  ],
  "CVV": null,
  "Addendum": null,
  "Amount": 0.00,
  "TipAmount": 0.00,
  "ProductIndicator": null
  },
  "ApplicationProfileId": "772763",
  "MerchantProfileId": "Dev Test .28"
  }
CaptureAll Transaction
RequestUri https://api.cipcert.goevo.com/2.1.29/REST/TPS.svc/[serviceId]
Method PUT
Authentication Session token set as Username on Authentication header.
Accept application/json
 

Request

 {
  "$type": "CaptureAll, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "DifferenceData": null,
  "MerchantProfileId": "Dev Test .29 NGT",
  "BatchIds": null,
  "ForceClose": false,
  "ApplicationProfileId": "786642"
  }
 

Example Bankcard Response

{
  "AdviceResponse": "NotSet",
  "Amount": 10.0,
  "Status": "Successful",
  "CommercialCardResponse": "NotSet",
  "CardType": "Visa",
  "StatusCode": "1",
  "ReturnedACI": "NotSet",
  "FeeAmount": 0.0,
  "StatusMessage": "Approved - 000:APPROVED",
  "ApprovalCode": "5UO152",
  "TransactionId": "4CB95CCE0A9B48B8961163A5B9D0A01B",
  "AVSResult": {
    "ActualResult": "0",
    "AddressResult": "NotVerified",
    "StateResult": "NotSet",
    "CountryResult": "NotSet",
    "PostalCodeResult": "NotVerified",
    "PhoneResult": "NotSet",
    "CardholderNameResult": "NotSet",
    "CityResult": "NotSet"
  },
  "OriginatorTransactionId": "2518",
  "BatchId": "1709",
  "ServiceTransactionId": "90757885",
  "CVResult": "NotProcessed",
  "ServiceTransactionDateTime": {
    "Date": "2017-01-09",
    "Time": "23:08:58.766",
    "TimeZone": "-06:00"
  },
  "CardLevel": "",
  "Addendum": null,
  "DowngradeCode": "",
  "CaptureState": "Captured",
  "MaskedPAN": "411111XXXXX1111",
  "TransactionState": "Captured",
  "PaymentAccountDataToken": "4cb95cce-0a9b-48b8-9611-63a5b9d0a01b23c8b0e9-b3f4-42b9-9822-f70ae5fdc612",
  "IsAcknowledged": false,
  "RetrievalReferenceNumber": "",
  "Reference": "",
  "Resubmit": "NotSet",
  "TransmissionNumber": "",
  "SettlementDate": "0001-01-01T00:00:00",
  "TransactionCode": "",
  "FinalBalance": 0.0,
  "HostMessageId": "",
  "OrderId": "2418",
  "Geolocation": null,
  "CashBackAmount": 0.0,
  "PrepaidCard": "NotSet",
  "Expire": "0122",
  "ErrorType": null,
  "AuthorizationServerUrl": "",
  "PaymentAuthorizationRequest": "",
  "ProcessedAs3D": false,
  "EMVDataResponse": null,
  "Level3Added": "NotSet",
  "LastPANDigits": "",
  "BatchAmount": 0.0,
  "MessageAuthenticationCode": "",
  "TokenInformation": null,
  "ForcePostCode": "",
  "MerchantId": "ES0000000000002",
  "TerminalId": "001",
  "BankResponseCode": null,
  "InitialEncryptionKeys": null
}