Visit our Web Services section at:
The Authentication object contains the ApiLoginID and SecureTransactionKey used to identify and authenticate the requestor. Both fields may be maintained in the Virtual Terminal’s "Gateway Settings" section.
This object is used to represent the information for a given client. Most fields are alphanumeric in nature. The only validation rules are (1) that the record must have either First and Last name or a company name and (2) the Status must be one of the enumerated values: ACTIVE, SUSPENDED or DELETED. Note that transactions for suspended clients will always fail. (M)anditory, (O)ptional, (C)onditional, (R)eturned
Back to Top
This object is used to represent payment method data. The ClientID may be omitted if it is for use without a Client record. Only the AcctHolderName, CcExpirationDate, CcProcurementCard, Note, and IsDefault fields may be updated. Other changes represent a new payment method and will have to be put into a new PaymentMethod record. CcCardNumber and EcAccountNumber fields are masked in response messages. Each record may hold either credit card or electronic check information but never both. (M)anditory, (O)ptional, (C)onditional, (R)eturned
This object holds the credit card, billing and shipping info for an order.
After the transaction has been submitted, this object holds the response.