TPS – Stored Value Accounts

  1. Home
  2. Commerce Web Services
  3. API Reference
  4. REST API Reference
  5. TPS – Stored Value Accounts

REST API Reference

Print Friendly, PDF & Email

TPS – Stored Value Accounts

 

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": "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,
      "EmployeeId": "7788",
      "CurrencyCode": "USD",
      "EntryMode": "Keyed"
    }
  },
  "ApplicationProfileId": "781887",
  "MerchantProfileId": "SVA"
}
 

Response

 {
  "Amount": 100.0,
  "Status": "Successful",
  "FeeAmount": 0.0,
  "StatusCode": "000",
  "ApprovalCode": "3O197Q",
  "StatusMessage": "APPROVED",
  "CVResult": "NotSet",
  "TransactionId": "85366B11C4D1444582D4E7797BAB74F1",
  "CashBackAmount": 0.0,
  "OriginatorTransactionId": "117",
  "LockAmount": 0.0,
  "ServiceTransactionId": "",
  "NewBalance": 1.0,
  "ServiceTransactionDateTime": {
    "Date": null,
    "Time": null,
    "TimeZone": null
  },
  "PreviousBalance": 0.0,
  "Addendum": null,
  "CardStatus": "NotSet",
  "CaptureState": "Captured",
  "AccountNumber": "",
  "TransactionState": "Captured",
  "CVData": "",
  "IsAcknowledged": false,
  "CardRestrictionValue": null,
  "Reference": null,
  "PaymentAccountDataToken": "85366b11-c4d1-4445-82d4-e7797bab74f144620160-5b60-485f-a827-d264fb3f05f3",
  "TransmissionNumber": null,
  "MaskedPAN": "XXXXXXXXXX",
  "TransactionCode": null,
  "OrderId": "17",
  "HostMessageId": null,
  "Expire": "",
  "Geolocation": null
}
ManageAccount - 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": "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,
      "EmployeeId": "7788",
      "CurrencyCode": "USD",
      "EntryMode": "Keyed",
      "OperationType": "Activate"
    }
  },
  "ApplicationProfileId": "781887",
  "MerchantProfileId": "SVA"
}
Note: the OperationType value can be changed to Activate, Reload, or De-Activate depending on the desired operation type.
 

Response

{
  "Amount": 100.0,
  "Status": "Successful",
  "FeeAmount": 0.0,
  "StatusCode": "000",
  "ApprovalCode": "34GXVT",
  "StatusMessage": "APPROVED",
  "CVResult": "NotSet",
  "TransactionId": "3F8F4D9E1BC8498FABFBAC5273F07C46",
  "CashBackAmount": 0.0,
  "OriginatorTransactionId": "118",
  "LockAmount": 0.0,
  "ServiceTransactionId": "",
  "NewBalance": 100.0,
  "ServiceTransactionDateTime": {
    "Date": null,
    "Time": null,
    "TimeZone": null
  },
  "PreviousBalance": 0.0,
  "Addendum": null,
  "CardStatus": "NotSet",
  "CaptureState": "Captured",
  "AccountNumber": "",
  "TransactionState": "NotSet",
  "CVData": "",
  "IsAcknowledged": false,
  "CardRestrictionValue": null,
  "Reference": null,
  "PaymentAccountDataToken": "3f8f4d9e-1bc8-498f-abfb-ac5273f07c467483ab95-29f8-4e92-a59d-9bebd91e56d9",
  "TransmissionNumber": null,
  "MaskedPAN": "XXXXXXXXXX",
  "TransactionCode": null,
  "OrderId": "18",
  "HostMessageId": null,
  "Expire": "",
  "Geolocation": null
}
ManageAccountById
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": "ManageAccountById, http://schemas.evosnap.com/CWS/v2.0/Transactions/Rest",
  "DifferenceData": {
    "$type": "StoredValueManage, http://schemas.evosnap.com/CWS/v2.0/Transactions/StoredValue",
    "Amount": 25.00,
    "TransactionId": "0DB9E8F5524F4F4E8DE8716E2B43FC6B",
    "OperationType": "Reload"
  },
  "ApplicationProfileId": "781887"
}
Note: the OperationType value can be changed to Activate, Reload, or De-Activate depending on the desired operation type.
 

Response

{
  "Amount": 25.0,
  "Status": "Successful",
  "FeeAmount": 0.0,
  "StatusCode": "000",
  "ApprovalCode": "523BMK",
  "StatusMessage": "APPROVED",
  "CVResult": "NotSet",
  "TransactionId": "A423CF9A8B0D45B19FF782F551DFFCE1",
  "CashBackAmount": 0.0,
  "OriginatorTransactionId": "123",
  "LockAmount": 0.0,
  "ServiceTransactionId": "",
  "NewBalance": 25.0,
  "ServiceTransactionDateTime": {
    "Date": null,
    "Time": null,
    "TimeZone": null
  },
  "PreviousBalance": 0.0,
  "Addendum": null,
  "CardStatus": "NotSet",
  "CaptureState": "Captured",
  "AccountNumber": "",
  "TransactionState": "NotSet",
  "CVData": "",
  "IsAcknowledged": false,
  "CardRestrictionValue": null,
  "Reference": null,
  "PaymentAccountDataToken": "0db9e8f5-524f-4f4e-8de8-716e2b43fc6b8a9e6854-c634-47ad-a45a-79e281e04cd7",
  "TransmissionNumber": null,
  "MaskedPAN": "XXXXXXXXXX",
  "TransactionCode": null,
  "OrderId": "21",
  "HostMessageId": null,
  "Expire": "",
  "Geolocation": null
}