130 Weber St. W., Suite 100,
Kitchener, Ontario CANADA N2H 4A2
|
|
Kognitiv 130 Weber St. W., Suite 100, Kitchener, Ontario CANADA N2H 4A2 |
|
|
|
| SimpleTransactionWithCustomFields |
| Overview | |
| Service URL: | https://app.kognitivloyalty.com/v2/Services/Transaction.asmx (Production) |
| Service WSDL URL: | https://app.kognitivloyalty.com/Services/v2/Transaction.asmx?WSDL (Production) |
| Method: | SimpleTransactionWithCustomFields |
| Sample SOAP Packets: | https://app.kognitivloyalty.com/Services/v2/Transaction.asmx?op=SimpleTransactionWithCustomFields (Production) |
| Description: | Inserts a Simple Transaction for Provided Member including Transaction Custom Fields |
| Interface | |
| Input Parameters: | Takes parameter 'preqSimpleTransactionWithCustomFields' of type 'reqSimpleTransactionWithCustomFields' (defined below) |
| Returns: | Returns record of type 'respSimpleTransactionWithCustomFields' (defined below) |
| Type: | reqSimpleTransactionWithCustomFields |
| Field: | SecurityToken (String) Required- Web Service Security Token generated via the Smart Button Loyalty Platform Application |
| Field: | CardNumber (String) - Required Max Length(60) |
| Field: | LoyaltyProgramId (Integer)Required - The Loyalty Program Id to validate (Hardcoded value for the specific Loyalty Program) |
| Field: | LocationExternalReference (String) Required - Location of the Transaction to be added |
| Field: | TransactionTypeExternalReference (String) Required - The Transaction Type to add |
| Field: | ActivityTimestamp (String) Required - Local Timestamp. Activity Date of Transaction |
| Field: | TransactionAmount (Float) - Required - Retail amount of Transaction |
| Field: | TransactionPointAmount (Float) - Required - used if Transaction is setup for Direct Entry of Points |
| Field: | UniqueTransactionId (String) Required - If not blank, must be unique id within Transaction Type for Member |
| Field: | CustomFieldPairs - Key / Value Pairs for Custom Fields (Keys = Transaction Custom Field External References setup via Application) |
| Type: | respSimpleTransactionWithCustomFields |
| Field: | ReturnCode (Integer) - (0) - Success / (Non-Zero) - Error (See Below) |
| Field: | Warnings (Array of Strings) - May be empty, Contains a Array of All Warning Messages generated by Custom Field Processing |
| Field: | TransactionId(Long) - The Kognitiv Loyalty Transaction Id of the Transaction Inserted if Return Code is Success |
| Additional Information | |
| Notes: | Custom Field Errors will NOT prevent the transaction from being inserted - the return code is the return code of the transaction insert. |
| Error Codes | |
| Possible Return Codes: |
(0) - Success (1) - Undefined Error (Please Contact Support) (2) - Required Field Missing (100) - Invalid Security Token (101) - Invalid Permission for Method (300) - Invalid Card Number (301) - Card Number is Inactive (302) - Member Account is Inactive (305) - Member Not Enrolled in Loyalty Program (306) - Loyalty Program is Locked (503) - Invalid Location External Reference (900) - Invalid Transaction Type External Reference (901) - Invalid Activity Date supplied (902) - Transaction Type not support for this Method (903) - UniqueTransactionId already processed - Transaction Skipped |
| Reference | |
| click for: | Web Services Overview |
| link: | Web Services Map |
| link: | SBLP Security Token Information |
|
Copyright © 2003-2021 Kognitiv, Corp. All rights reserved. |