developer:soap-1.1:support

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.1:support [2009/07/02 09:13]
tem created
developer:soap-1.1:support [2009/07/02 09:17] (current)
tem
Line 3: Line 3:
 See [[developer:​soap:​releasenotes|release notes]] for more details about other versions of the API. See [[developer:​soap:​releasenotes|release notes]] for more details about other versions of the API.
  
-The Soap interface provides a collection of methods ​implementing ​a large portion of merchant and reseller functionality.+The Soap interface provides a collection of methods ​implementinag ​a large portion of merchant and reseller functionality.
  
 ===== Getting Started ===== ===== Getting Started =====
Line 9: Line 9:
 The following guides give specific setup instuctions/​background information on using Soap with some of the more common programming languages. If you are using a language not listed below, please feel free to contact us for assistance. The Soap interface can be used with any programming language that is able to communicate with an HTTPS connection. ​ The following guides give specific setup instuctions/​background information on using Soap with some of the more common programming languages. If you are using a language not listed below, please feel free to contact us for assistance. The Soap interface can be used with any programming language that is able to communicate with an HTTPS connection. ​
  
-  * [[developer:​soap:​howto:​php|PHP 5 (Built-in SoapClient)]] +  * [[.:​howto:​php|PHP 5 (Built-in SoapClient)]] 
-  * [[developer:​soap:​howto:​pearsoap| PHP 5 (Pear Library)]] +  * [[.:​howto:​pearsoap| PHP 5 (Pear Library)]] 
-  * [[developer:​soap:​howto:​vb|Visual Basic (.Net)]] +  * [[.:​howto:​vb|Visual Basic (.Net)]] 
-  * [[developer:​soap:​howto:​csharp|C# ​ (.Net)]]+  * [[.:​howto:​csharp|C# ​ (.Net)]]
  
  
Line 23: Line 23:
 ==== Transactions ==== ==== Transactions ====
  
-| [[developer:​soap:​methods:​runTransaction|runTransaction]] ​ | Runs a transaction using the Transaction API. |  +| [[.:​methods:​runTransaction|runTransaction]] ​ | Runs a transaction using the Transaction API. |  
-| [[developer:​soap:​methods:​runTransactionAPI|runTransactionAPI]] ​ | Provides a Soap wrapper for the Transaction API. | +| [[.:​methods:​runTransactionAPI|runTransactionAPI]] ​ | Provides a Soap wrapper for the Transaction API. | 
-| [[developer:​soap:​methods:​runSale|runSale]] | Run a new sale (debit) transaction for credit cards. ​  | +| [[.:​methods:​runSale|runSale]] | Run a new sale (debit) transaction for credit cards. ​  | 
-| [[developer:​soap:​methods:​runAuthOnly|runAuthOnly]] | Run a new authonly (debit) transaction for credit cards. ​  | +| [[.:​methods:​runAuthOnly|runAuthOnly]] | Run a new authonly (debit) transaction for credit cards. ​  | 
-| [[developer:​soap:​methods:​runCredit|runCredit]] ​ | Run a credit transaction for credit cards. | +| [[.:​methods:​runCredit|runCredit]] ​ | Run a credit transaction for credit cards. | 
-| [[developer:​soap:​methods:​runCheckSale|runCheckSale]] | Run a new sale (debit) transaction for checks. ​  | +| [[.:​methods:​runCheckSale|runCheckSale]] | Run a new sale (debit) transaction for checks. ​  | 
-| [[developer:​soap:​methods:​runCheckCredit|runCheckCredit]] ​ | Run a credit transaction for checks. | +| [[.:​methods:​runCheckCredit|runCheckCredit]] ​ | Run a credit transaction for checks. | 
-| [[developer:​soap:​methods:​runQuickSale|runQuickSale]] | Run a sale based on the credit card or check details of a previous transaction. | +| [[.:​methods:​runQuickSale|runQuickSale]] | Run a sale based on the credit card or check details of a previous transaction. | 
-| [[developer:​soap:​methods:​runQuickCredit|runQuickCredit]] | Run a credit based on the credit card or check details of a previous transaction. | +| [[.:​methods:​runQuickCredit|runQuickCredit]] | Run a credit based on the credit card or check details of a previous transaction. | 
-| [[developer:​soap:​methods:​postAuth|postAuth]] ​  | Post an offline authorization ​ |  +| [[.:​methods:​postAuth|postAuth]] ​  | Post an offline authorization ​ |  
-| [[developer:​soap:​methods:​captureTransaction|captureTransaction]] ​  | Capture a queued transaction. ​ | +| [[.:​methods:​captureTransaction|captureTransaction]] ​  | Capture a queued transaction. ​ | 
-| [[developer:​soap:​methods:​refundTransaction|refundTransaction]] ​  | Refund a specific transaction. ​ | +| [[.:​methods:​refundTransaction|refundTransaction]] ​  | Refund a specific transaction. ​ | 
-| [[developer:​soap:​methods:​overrideTransaction|overrideTransaction]] ​  | Override a specific transaction. | +| [[.:​methods:​overrideTransaction|overrideTransaction]] ​  | Override a specific transaction. | 
-| [[developer:​soap:​methods:​voidTransaction|voidTransaction]] ​  | Void a specific transaction. | +| [[.:​methods:​voidTransaction|voidTransaction]] ​  | Void a specific transaction. | 
-| [[developer:​soap:​methods:​getTransactionStatus|getTransactionStatus]] ​ | Retrieve the current status of a specific transaction. ​  | +| [[.:​methods:​getTransactionStatus|getTransactionStatus]] ​ | Retrieve the current status of a specific transaction. ​  | 
-| [[developer:​soap:​methods:​getTransaction|getTransaction]] ​  | Retrieves all details of a specified transaction. | +| [[.:​methods:​getTransaction|getTransaction]] ​  | Retrieves all details of a specified transaction. | 
-| [[developer:​soap:​methods:​getTransactionCustom|getTransactionCustom]] | Retrieves only selected details of a specified transaction. | +| [[.:​methods:​getTransactionCustom|getTransactionCustom]] | Retrieves only selected details of a specified transaction. | 
-| [[developer:​soap:​methods:​searchTransactions|searchTransactions]] | Search transactions and return full transaction records. ​ | +| [[.:​methods:​searchTransactions|searchTransactions]] | Search transactions and return full transaction records. ​ | 
-| [[developer:​soap:​methods:​searchTransactionsCustom|searchTransactionsCustom]] | Search transactions and return only specific fields. ​ | +| [[.:​methods:​searchTransactionsCustom|searchTransactionsCustom]] | Search transactions and return only specific fields. ​ | 
-| [[developer:​soap:​methods:​getTransactionReport|getTransactionReport]] | Pull a transaction report. ​ | +| [[.:​methods:​getTransactionReport|getTransactionReport]] | Pull a transaction report. ​ | 
-| [[developer:​soap:​methods:​convertTranToCust|convertTranToCust]] | Convert a transaction data to a stored customer record. ​ |+| [[.:​methods:​convertTranToCust|convertTranToCust]] | Convert a transaction data to a stored customer record. ​ |
  
  
Line 51: Line 51:
 ==== Batch Uploads ==== ==== Batch Uploads ====
  
-| [[developer:​soap:​methods:​createBatchUpload|createBatchUpload]] | Post a new batch of transactions to the gateway for processing. | +| [[.:​methods:​createBatchUpload|createBatchUpload]] | Post a new batch of transactions to the gateway for processing. | 
-| [[developer:​soap:​methods:​runBatchUpload|runBatchUpload]] | Resume processing a paused batch upload. ​ | +| [[.:​methods:​runBatchUpload|runBatchUpload]] | Resume processing a paused batch upload. ​ | 
-| [[developer:​soap:​methods:​pauseBatchUpload|pauseBatchUpload]] | Pause a Batch Upload that is already running. ​ | +| [[.:​methods:​pauseBatchUpload|pauseBatchUpload]] | Pause a Batch Upload that is already running. ​ | 
-| [[developer:​soap:​methods:​getBatchUploadStatus|getBatchUploadStatus]] | Retrieve the status of a currently running batch. |+| [[.:​methods:​getBatchUploadStatus|getBatchUploadStatus]] | Retrieve the status of a currently running batch. |
  
  
Line 60: Line 60:
 ==== Credit Card Batches ==== ==== Credit Card Batches ====
  
-| [[developer:​soap:​methods:​searchBatches]] | Search previously settled batches. ​  ​|  +| [[.:​methods:​searchBatches]] | Search previously settled batches. ​  ​|  
-| [[developer:​soap:​methods:​getBatchStatus]] | Retrieves the status of a batch specified by its BatchNum. ​  ​|  +| [[.:​methods:​getBatchStatus]] | Retrieves the status of a batch specified by its BatchNum. ​  ​|  
-| [[developer:​soap:​methods:​closeBatch]] | Close a batch specified by BatchNum. ​  ​|  +| [[.:​methods:​closeBatch]] | Close a batch specified by BatchNum. ​  ​|  
-| [[developer:​soap:​methods:​getBatchTransactions]] | Retrieve transactions in the batch specified by BatchNum ​  | +| [[.:​methods:​getBatchTransactions]] | Retrieve transactions in the batch specified by BatchNum ​  |
  
  
Line 71: Line 71:
 ==== Customers ==== ==== Customers ====
  
-| [[developer:​soap:​methods:​runCustomerTransaction|runCustomerTransaction]] | Run a transaction using payment data stored in the customer database. ​  ​|  +| [[.:​methods:​runCustomerTransaction|runCustomerTransaction]] | Run a transaction using payment data stored in the customer database. ​  ​|  
-| [[developer:​soap:​methods:​enableCustomer|enableCustomer]] | Enable recurring billing for a customer specified by CustNum. ​  ​|  +| [[.:​methods:​enableCustomer|enableCustomer]] | Enable recurring billing for a customer specified by CustNum. ​  ​|  
-| [[developer:​soap:​methods:​disableCustomer|disableCustomer]] | Disable the recurring billing for a customer specified by CustNum. ​  ​|  +| [[.:​methods:​disableCustomer|disableCustomer]] | Disable the recurring billing for a customer specified by CustNum. ​  ​|  
-| [[developer:​soap:​methods:​deleteCustomer|deleteCustomer]] | Delete the customer specified by CustNum. ​  ​|  +| [[.:​methods:​deleteCustomer|deleteCustomer]] | Delete the customer specified by CustNum. ​  ​|  
-| [[developer:​soap:​methods:​searchCustomerID|searchCustomerID]] | Find a CustNum (assigned by the gateway) using a CustID (assigned by merchant). ​  ​|  +| [[.:​methods:​searchCustomerID|searchCustomerID]] | Find a CustNum (assigned by the gateway) using a CustID (assigned by merchant). ​  ​|  
-| [[developer:​soap:​methods:​getCustomer|getCustomer]] | Retrieve the customer details for a given CustNum. ​  ​|  +| [[.:​methods:​getCustomer|getCustomer]] | Retrieve the customer details for a given CustNum. ​  ​|  
-| [[developer:​soap:​methods:​searchCustomers|searchCustomers]] | Search for customers. ​  | +| [[.:​methods:​searchCustomers|searchCustomers]] | Search for customers. ​  | 
-| [[developer:​soap:​methods:​searchCustomersCustom|searchCustomersCustom]] | Search for customers, returning custom columns. ​  |  +| [[.:​methods:​searchCustomersCustom|searchCustomersCustom]] | Search for customers, returning custom columns. ​  |  
-| [[developer:​soap:​methods:​getCustomerHistory|getCustomerHistory]] | Pull details of all transactions run for CustNum. ​  | +| [[.:​methods:​getCustomerHistory|getCustomerHistory]] | Pull details of all transactions run for CustNum. ​  | 
-| [[developer:​soap:​methods:​addCustomer|addCustomer]] | Add a customer to your stored customer database. ​  |  +| [[.:​methods:​addCustomer|addCustomer]] | Add a customer to your stored customer database. ​  |  
-| [[developer:​soap:​methods:​addCustomerPaymentMethod|addCustomerPaymentMethod]] | Add a payment method for an existing customer. ​  | +| [[.:​methods:​addCustomerPaymentMethod|addCustomerPaymentMethod]] | Add a payment method for an existing customer. ​  | 
-| [[developer:​soap:​methods:​deleteCustomerPaymentMethod|deleteCustomerPaymentMethod]] | Delete a payment method from an existing customer. ​  | +| [[.:​methods:​deleteCustomerPaymentMethod|deleteCustomerPaymentMethod]] | Delete a payment method from an existing customer. ​  | 
-| [[developer:​soap:​methods:​updateCustomer|updateCustomer]] | Replace all data for customer specified by CustNum. ​  | +| [[.:​methods:​updateCustomer|updateCustomer]] | Replace all data for customer specified by CustNum. ​  | 
-| [[developer:​soap:​methods:​quickUpdateCustomer|quickUpdateCustomer]] | Update customer data in selected fields only.   | +| [[.:​methods:​quickUpdateCustomer|quickUpdateCustomer]] | Update customer data in selected fields only.   | 
-| [[developer:​soap:​methods:​copyCustomer|copyCustomer]] | Copy customer from one merchant account to another. ​  | +| [[.:​methods:​copyCustomer|copyCustomer]] | Copy customer from one merchant account to another. ​  | 
-| [[developer:​soap:​methods:​moveCustomer|moveCustomer]] | Move customer from one merchant account to another. ​  |+| [[.:​methods:​moveCustomer|moveCustomer]] | Move customer from one merchant account to another. ​  |
  
  
 ==== General Merchant Methods ==== ==== General Merchant Methods ====
  
-| [[developer:​soap:​methods:​getAccountDetails|getAccountDetails]] | Retrieves information about merchant account. ​  ​|  +| [[.:​methods:​getAccountDetails|getAccountDetails]] | Retrieves information about merchant account. ​  ​|  
-| [[developer:​soap:​methods:​getSupportedCurrencies|getSupportedCurrencies]] | Retrieves an array of currencies supported by a merchant account. ​  |  +| [[.:​methods:​getSupportedCurrencies|getSupportedCurrencies]] | Retrieves an array of currencies supported by a merchant account. ​  |  
-| [[developer:​soap:​methods:​currencyConversion|currencyConversion]] | Find currency conversion rate for a transaction amount. ​  ​|  +| [[.:​methods:​currencyConversion|currencyConversion]] | Find currency conversion rate for a transaction amount. ​  ​|  
-| [[developer:​soap:​methods:​bulkCurrencyConversion|bulkCurrencyConversion]] | Converts multiple amounts in a single method call.   | +| [[.:​methods:​bulkCurrencyConversion|bulkCurrencyConversion]] | Converts multiple amounts in a single method call.   |
  
  
Line 101: Line 101:
 ==== Reseller Methods ==== ==== Reseller Methods ====
  
-| [[developer:​soap:​methods:​addMerchantApplication]] | Add a new merchant application to the system. ​  ​|  +| [[.:​methods:​addMerchantApplication]] | Add a new merchant application to the system. ​  ​|  
-| [[developer:​soap:​methods:​getMerchantApplicationStatus]] | Retrieve the status of a pending merchant application. ​  ​|  +| [[.:​methods:​getMerchantApplicationStatus]] | Retrieve the status of a pending merchant application. ​  ​|  
-| [[developer:​soap:​methods:​getMerchant]] | Retrieve details of a merchant'​s account. ​  ​|  +| [[.:​methods:​getMerchant]] | Retrieve details of a merchant'​s account. ​  ​|  
-| [[developer:​soap:​methods:​updateMerchant]] | Update details in a merchant'​s account. ​  ​|  +| [[.:​methods:​updateMerchant]] | Update details in a merchant'​s account. ​  ​|  
-| [[developer:​soap:​methods:​deleteMerchant]] | Request deletion of merchant account. ​  ​|  +| [[.:​methods:​deleteMerchant]] | Request deletion of merchant account. ​  ​|  
-| [[developer:​soap:​methods:​searchMerchants]] | Search active merchants. ​  ​|  +| [[.:​methods:​searchMerchants]] | Search active merchants. ​  ​|  
-| [[developer:​soap:​methods:​getMerchantSummary]] | View summary of merchant activity. ​  |+| [[.:​methods:​getMerchantSummary]] | View summary of merchant activity. ​  |
  
 ===== Objects ===== ===== Objects =====
  
-| [[developer:​soap:​objects:​AccountDetails|AccountDetails]] | Contains all relevant data pertaining to a merchant account. ​  |  +| [[.:​objects:​AccountDetails|AccountDetails]] | Contains all relevant data pertaining to a merchant account. ​  |  
-| [[developer:​soap:​objects:​Address|Address]] | Contains customer contact information. ​  |  +| [[.:​objects:​Address|Address]] | Contains customer contact information. ​  |  
-| [[developer:​soap:​objects:​BatchStatus|BatchStatus]] | Contains information about a batch awaiting settlement. ​  |  +| [[.:​objects:​BatchStatus|BatchStatus]] | Contains information about a batch awaiting settlement. ​  |  
-| [[developer:​soap:​objects:​BatchUploadStatus|BatchUploadStatus]] | Contains information on an uploaded batch. ​  |  +| [[.:​objects:​BatchUploadStatus|BatchUploadStatus]] | Contains information on an uploaded batch. ​  |  
-| [[developer:​soap:​objects:​CheckData|CheckData]] | Contains information for electronic check transactions. ​  |  +| [[.:​objects:​CheckData|CheckData]] | Contains information for electronic check transactions. ​  |  
-| [[developer:​soap:​objects:​CheckTrace|CheckTrace]] | Electronic check transaction tracking data.   |  +| [[.:​objects:​CheckTrace|CheckTrace]] | Electronic check transaction tracking data.   |  
-| [[developer:​soap:​objects:​CreditCardData|CreditCardData]] | This object contains credit card specific information for a transaction. ​  |  +| [[.:​objects:​CreditCardData|CreditCardData]] | This object contains credit card specific information for a transaction. ​  |  
-| [[developer:​soap:​objects:​CurrencyConversion|CurrencyConversion]] | Contains the results of a currency conversion. ​  |  +| [[.:​objects:​CurrencyConversion|CurrencyConversion]] | Contains the results of a currency conversion. ​  |  
-| [[developer:​soap:​objects:​CurrencyObject|CurrencyObject]] | Describes a currency supported by the merchant'​s account. ​  |  +| [[.:​objects:​CurrencyObject|CurrencyObject]] | Describes a currency supported by the merchant'​s account. ​  |  
-| [[developer:​soap:​objects:​CustomerObject|CustomerObject]] | Contains customer data.   |  +| [[.:​objects:​CustomerObject|CustomerObject]] | Contains customer data.   |  
-| [[developer:​soap:​objects:​CustomerSearchResult|CustomerSearchResult]] | Contains customer search data.   |  +| [[.:​objects:​CustomerSearchResult|CustomerSearchResult]] | Contains customer search data.   |  
-| [[developer:​soap:​objects:​FieldValue|FieldValue]] | Generalized Field-Value Pair   |  +| [[.:​objects:​FieldValue|FieldValue]] | Generalized Field-Value Pair   |  
-| [[developer:​soap:​objects:​MerchantApplicationObject|MerchantApplicationObject]] | Contains information for a new merchant application. ​  |  +| [[.:​objects:​MerchantApplicationObject|MerchantApplicationObject]] | Contains information for a new merchant application. ​  |  
-| [[developer:​soap:​objects:​MerchantObject|MerchantObject]] | Contains contact information for an active merchant. ​  |  +| [[.:​objects:​MerchantObject|MerchantObject]] | Contains contact information for an active merchant. ​  |  
-| [[developer:​soap:​objects:​MerchantSearchResult|MerchantSearchResult]] | Contains the results of a merchant search. ​  |  +| [[.:​objects:​MerchantSearchResult|MerchantSearchResult]] | Contains the results of a merchant search. ​  |  
-| [[developer:​soap:​objects:​MerchantSummaryObject|MerchantSummaryObject]] | Summary of merchant activity over a given time period. ​  |  +| [[.:​objects:​MerchantSummaryObject|MerchantSummaryObject]] | Summary of merchant activity over a given time period. ​  |  
-| [[developer:​soap:​objects:​PaymentMethod|PaymentMethod]] | Describes a customer payment method. ​  |  +| [[.:​objects:​PaymentMethod|PaymentMethod]] | Describes a customer payment method. ​  |  
-| [[developer:​soap:​objects:​RecurringBilling|RecurringBilling]] | This object stores information relating to specific recurring billing cycles. ​  |  +| [[.:​objects:​RecurringBilling|RecurringBilling]] | This object stores information relating to specific recurring billing cycles. ​  |  
-| [[developer:​soap:​objects:​SearchParam|SearchParam]] | Used to create a unique search parameter. ​  |  +| [[.:​objects:​SearchParam|SearchParam]] | Used to create a unique search parameter. ​  |  
-| [[developer:​soap:​objects:​TransactionDetail|TransactionDetail]] | Contains transaction specific data.   |  +| [[.:​objects:​TransactionDetail|TransactionDetail]] | Contains transaction specific data.   |  
-| [[developer:​soap:​objects:​TransactionObject|TransactionObject]] | Contains all transaction data.   |  +| [[.:​objects:​TransactionObject|TransactionObject]] | Contains all transaction data.   |  
-| [[developer:​soap:​objects:​TransactionRequestObject|TransactionRequestObject]] | Used to run a new transaction. ​  |  +| [[.:​objects:​TransactionRequestObject|TransactionRequestObject]] | Used to run a new transaction. ​  |  
-| [[developer:​soap:​objects:​TransactionResponse|TransactionResponse]] | Contains details on the result of a processed transaction. ​  |  +| [[.:​objects:​TransactionResponse|TransactionResponse]] | Contains details on the result of a processed transaction. ​  |  
-| [[developer:​soap:​objects:​TransactionSearchResult|TransactionSearchResult]] | Contains results of a transaction search. ​  |  +| [[.:​objects:​TransactionSearchResult|TransactionSearchResult]] | Contains results of a transaction search. ​  |  
-| [[developer:​soap:​objects:​ueHash|ueHash]] | Defines the properties of the hash used to validate a source key.   | +| [[.:​objects:​ueHash|ueHash]] | Defines the properties of the hash used to validate a source key.   |
 | [[.:​objects:​ueSecurityToken|ueSecurityToken]] | Defines a source key used to identify a merchant or reseller. ​  |  | [[.:​objects:​ueSecurityToken|ueSecurityToken]] | Defines a source key used to identify a merchant or reseller. ​  |
  
  
developer/soap-1.1/support.txt · Last modified: 2009/07/02 09:17 by tem

Page Tools