WebManager API

svcutil.exe https://api.samport.com/wm/WebManagerAPI.svc

C#

                class Test
                        {
                static void Main()
                            {
                WebManagerAPIClient client = new WebManagerAPIClient();
                // Use the 'client' variable to call operations on the service.
                // Always close the client.        
                                client.Close();
                            }
                        }

Visual Basic

Class Test
    Shared Sub Main()
        Dim client As WebManagerAPIClient = New WebManagerAPIClient()
        ' Use the 'client' variable to call operations on the service.
        ' Always close the client.
        client.Close()
    End Sub
End Class

GetTransactionID

Gets the transaction ID for an offline transaction.
Returns the transaction ID for the offline transaction ID (TerminalRRN), in the format RESPONSECODE;TRANSACTIONID;ERRORMESSAGE. A response code is a two character code, with 00 meaning OK and all other codes FAILED. However if the code is SX, then a retry at a later time is advised.

 

SOAP

String GetTransactionID(String MerchantID, String TerminalID, String TerminalRRN, String WebManagerKey)

 

XML

https://api.samport.com/wm/WebManagerAPI.svc/xml/GetTransactionID?MerchantID={MERCHANTID}&TerminalID={TERMINALID}&TerminalRRN={TERMINALRRN}&WebManagerKey={WEBMANAGERKEY}

 

JSON

https://api.samport.com/wm/WebManagerAPI.svc/json/GetTransactionID?MerchantID={MERCHANTID}&TerminalID={TERMINALID}&TerminalRRN={TERMINALRRN}&WebManagerKey={WEBMANAGERKEY}

 

MerchantID:

The identity of your company in the system. Can be found in the web tools.

TerminalID:

The identity of the terminal used for the original transaction, i.e. the serial number. Can be found on the back of the terminal.

TerminalRRN:

The offline retrieval reference number, used to identify offline transactions.

WebManagerKey:

The key associated with the account.

AdditionalSale

Incurs an additional payment on an already successful transaction.
Returns the response code and the transaction ID for the recurring sale, in the format RESPONSECODE;TRANSACTIONID;ERRORMESSAGE. A response code is a two character code, with 00 meaning OK and all other codes FAILED. However if the code is SX, then a retry at a later time is advised.

 

SOAP

String AdditionalSale(String MerchantID, String TerminalID, String TransactionID, String Amount, String Message, String MerchantData, String WebManagerKey)

 

XML

https://api.samport.com/wm/WebManagerAPI.svc/xml/AdditionalSale?MerchantID={MERCHANTID}&TerminalID={TERMINALID}&TransactionID={TRANSACTIONID}&Amount={AMOUNT}&Message={MESSAGE}&MerchantData={MERCHANTDATA}&WebManagerKey={WEBMANAGERKEY}

 

JSON

https://api.samport.com/wm/WebManagerAPI.svc/json/AdditionalSale?MerchantID={MERCHANTID}&TerminalID={TERMINALID}&TransactionID={TRANSACTIONID}&Amount={AMOUNT}&Message={MESSAGE}&MerchantData={MERCHANTDATA}&WebManagerKey={WEBMANAGERKEY}

 

MerchantID:

The identity of your company in the system. Can be found in the web tools.

TerminalID:

The identity of the terminal used for the original transaction, i.e. the serial number. Can be found on the back of the terminal.

TransactionID:

A reference to the transaction to make an additional payment on.

Amount:

The amount of the additional payment, with two decimal places. Must be within in certain limits, please check in the WebManager.

Message:

A human readable message used for annotation. Max length is 200 characters.

MerchantData:

A machine-readable message, in a form specified by Host2T2. Set to null or empty if not used. The format is of the form <key1>US<value1>US<key2>US<value2> etc, where US is the character 0x1F. The number of keys must match the number of values.

WebManagerKey:

The key associated with the account.

Refund

Refunds a transaction with a specific transaction ID.
Returns the response code and the transaction ID for the refund, in the format RESPONSECODE;TRANSACTIONID;ERRORMESSAGE. A response code is a two character code, with 00 meaning OK and all other codes FAILED. However if the code is SX, then a retry at a later time is advised.

 

SOAP

String Refund(String MerchantID, String TerminalID, String TransactionID, String Amount, String Message, String MerchantData, String WebManagerKey)

 

XML

https://api.samport.com/wm/WebManagerAPI.svc/xml/Refund?MerchantID={MERCHANTID}&TerminalID={TERMINALID}&TransactionID={TRANSACTIONID}&Amount={AMOUNT}&Message={MESSAGE}&MerchantData={MERCHANTDATA}&WebManagerKey={WEBMANAGERKEY}

 

JSON

https://api.samport.com/wm/WebManagerAPI.svc/json/Refund?MerchantID={MERCHANTID}&TerminalID={TERMINALID}&TransactionID={TRANSACTIONID}&Amount={AMOUNT}&Message={MESSAGE}&MerchantData={MERCHANTDATA}&WebManagerKey={WEBMANAGERKEY}

 

MerchantID:

The identity of your company in the system. Can be found in the web tools.

TerminalID:

The identity of the terminal used for the original transaction, i.e. the serial number. Can be found on the back of the terminal.

TransactionID:

A reference to the transaction to refund.

Amount:

The amount of the refund, with two decimal places. Must be within in certain limits, please check in the WebManager.

Message:

A human readable message used for annotation. Max length is 200 characters.

MerchantData:

A machine-readable message, in a form specified by Host2T2. Set to null or empty if not used. The format is of the form <key1>US<value1>US<key2>US<value2> etc, where US is the character 0x1F. The number of keys must match the number of values.

WebManagerKey:

The key associated with the account.

Void

Voids a transaction with a specific transaction ID.
Returns the response code and the transaction ID for the void, in the format RESPONSECODE;TRANSACTIONID;ERRORMESSAGE. A response code is a two character code, with 00 meaning OK and all other codes FAILED. However if the code is SX, then a retry at a later time is advised.

 

SOAP

String Void(String MerchantID, String TerminalID, String TransactionID, String Message, String MerchantData, String WebManagerKey)

 

XML

https://api.samport.com/wm/WebManagerAPI.svc/xml/Void?MerchantID={MERCHANTID}&TerminalID={TERMINALID}&TransactionID={TRANSACTIONID}&Message={MESSAGE}&MerchantData={MERCHANTDATA}&WebManagerKey={WEBMANAGERKEY}

 

JSON

https://api.samport.com/wm/WebManagerAPI.svc/json/Void?MerchantID={MERCHANTID}&TerminalID={TERMINALID}&TransactionID={TRANSACTIONID}&Message={MESSAGE}&MerchantData={MERCHANTDATA}&WebManagerKey={WEBMANAGERKEY}

 

MerchantID:

The identity of your company in the system. Can be found in the web tools.

TerminalID:

The identity of the terminal used for the original transaction, i.e. the serial number. Can be found on the back of the terminal.

TransactionID:

A reference to the transaction to void.

Message:

A human readable message used for annotation. Max length is 200 characters.

MerchantData:

A machine-readable message, in a form specified by Host2T2. Set to null or empty if not used. The format is of the form <key1>US<value1>US<key2>US<value2> etc, where US is the character 0x1F. The number of keys must match the number of values.

WebManagerKey:

The key associated with the account.

 

v.1.0.0.0