SOAP Object Dictionary
A dictionary of the objects in some of the requests and responses of the SOAP API
Last updated
Was this helpful?
A dictionary of the objects in some of the requests and responses of the SOAP API
Last updated
Was this helpful?
Objects describing the user.
ID int
Unique user ID.
Example: 2547
AcctID int
Example: 205
APILocationID int
Example: 2210
ExpirationDate datetime
Example: 2019-09-11T16:12:00-04:00
DateCreated datetime
Example: 2019-03-11T12:32:00-04:00
DateModified datetime
Example: 2019-03-11T12:32:00-04:00
CreatedBy string
Example: ADMIN : vidya Venkatraman
IsExpired boolean
Example: false
IsLockedOut boolean
Indicates if the account got locked out due to too many attempts.
Alias string
Example: vidya_Venkatraman
Description string
Example: EP DEV ACCT
TokenDescription string
Example: EP DEV ACCT
Objects describing the account.
ID int
Unique account ID.
AccountName string
AutoSettle boolean
A setting which decides if transactions should automatically be settled for this account.
AutoSchedule boolean
AutoSettleHour int
The hour of the day to automatically settle transactions when AutoSettle is set to true.
AutoSettleMinute int
The minute of the hour to automatically settle transactions when AutoSettle is set to true.
BatchReport bool
Indicates whether a batch report should be generated each night after the settlement process runs.
TransReport bool
DateCreated datetime
DateModified datetime
IndustryCode string
TimeZone string
Example: Dateline Standard Time
Objects describing ACH transactions.
ID int
Unique ID of the ACH transaction.
UniqueID string
TXstamp string
The date when the transaction occurred, in MMDDYY format.
TXN_DATETIME datetime
The date and time when the transaction occurred,.
AuthID string
Example: 69017501
ValMsg string
Example: Success
AcctType string
Type of account associated with the transaction.
Values: - "PersonalChecking" - "PersonalSavings" - "BusinessChecking" - "BusinessSavings"
AcctHolderID int
Account holder unique ID.
EndCustID int
End customer unique ID.
Credits decimal
The $ amount of credits applied to the transaction.
Amt decimal
The total $ amount of the transaction.
MerchID int
The unique identifier for the merchant associated with the transaction.
ResolvedOn datetime
SettledOn datetime
BatchNO int
The batch number to which this transaction belongs.
BatchStatus string
The status of the batch.
Values: - "N" (Not settled yet) - "A" (Approved) - "S" (Locked for resettlement)
BatchLogID int
The identifier for the batch log associated with the transaction.
AcctLast4 string
ReturnReason string
CustName string
FirstName string
LastName string
Objects describing batch transactions.
ID int
Unique batch ID.
BatchNO int
Number of the batch.
BatchAmt decimal
Example: 110.0
BatchRecs int
The number of transactions that were processed in the batch.
Example: 3
TxLOCK string
A unique value which represents the lock imposed on transactions prior to settlement. If the batch fails, the transaction will remain locked to prevent it from being merged with other settlements. In this situation, someone at Number will investigate and resettle the batch in its original grouping.
Example: 7A639CD720CE4B14
CreatedOn datetime
The date the record was created.
FinishedOn datetime
CreatedBy string
The username or identifier of the person who created the record.
MerchID int
Unique ID of the merchant associated with the batch.
SettleResp string
Example: APPROVAL Batch:512:Recs:3:$110.00
BatchOpen string
The timestamp indicating when the batch was opened, formatted as a string.
Example: 0720191352
BatchClose string
The timestamp indicating when the batch was closed, formatted as a string.
Example: 0720191352
Released int
Objects describing credit card information.
AccountNumber string
The account number on the card.
ExpMonth int
The expiration month on the card.
ExpYear int
The full expiration year on the card or the last 2 digits.
CSV string
The CSV code from the back on the card used to prevent credit card fraud.
Objects describing people and locations.
Address1 string
Address2 string
City string
State string
ZIP string
County string
Objects describing transactions in general.
TotalAmt decimal
SalesTax decimal
Surcharge decimal
Tip decimal
CashBack decimal
ClinicAmount decimal
VisionAmount decimal
PrescriptionAmount decimal
DentalAmount decimal
TotalMedicalAmount decimal
Objects describing sales related to lodging.
FirstName string
LastName string
AuthAmount decimal
Folio string
ArrivalDate datetime
The date of arrival.
Duration int
The duration of stay in days.
CustomerData string
ServiceDescription string
Service description.
Objects describing annual consent.
ID int
AcctHolderID int
CustID int
AcctHolderLastName string
AcctHolderFirstName string
IsEnabled bool
StartDate date
Start date for the consent.
EndDate date
End date for the consent.
LimitLifeTime decimal
Total $ limit for the lifetime of the consent.
AuthTxID int
CreatedOn date
CreatedBy date
AcctNo string
AccountCode string
The AccountCode is a unique key which represents a Number account. This code will never change throughout the life of your account. Each AccountCode is 2 letters and 7 numbers. You can also use this code when communicating with Number support team.
Example: EP911XXXX
AccountCode string
The AccountCode is a unique key which represents a Number account. This code will never change throughout the life of your account. Each AccountCode is 2 letters and 7 numbers. You can also use this code when communicating with Number support team.
Example: EP911XXXX
Origin string
The type of service that was used to create the record.
Values: - "API" (REST / SOAP API) - "WID" (Widget) - "VT" (Virtual Terminal) - "MOBL" (Mobile SDK) - "SDK" (Verifone) - "AUTO" (Automatically scheduled from a payment plan)
TxStatus string
Represents the current status of the transaction.
Values: - OPEN: The transaction is open and has not been processed. - AUTHOK: The transaction has been authorized. - AUTHFAILED: The transaction authorization failed. - SETTLED: The transaction has been settled. - FAILED: The transaction failed. - LOCKED: The transaction is locked. - VOID: The transaction has been voided. - HOST: The transaction is being processed by the host.
ConsentID int
This is the the ID number that is returned after you save a card on file.
RefTxID int
The identifier for a related transaction, if applicable. As an example, when you credit a transaction, that will create a relationship.
CreatedBy string
The username or identifier of the person who created the record.
CreatedOn datetime
The date the record was created.
ChangedBy string
The username or identifier of the person who last modified the record.
ChangedOn datetime
The date the record was last modified.
RPGUID string
A custom, user-defined reference ID or value.
Example: adf98580-b4ab-42fc-bb99-01c89964afe9
RPGUID string
A custom, user-defined reference ID or value.
Example: adf98580-b4ab-42fc-bb99-01c89964afe9
RPGUID string
A custom, user-defined reference ID or value.
Example: adf98580-b4ab-42fc-bb99-01c89964afe9
RPGUID string
A custom, user-defined reference ID or value.
Example: adf98580-b4ab-42fc-bb99-01c89964afe9
RPGUID string
A custom, user-defined reference ID or value.
Example: adf98580-b4ab-42fc-bb99-01c89964afe9
REF_ID string
A custom, user-defined reference ID or value.
Example: A97689#
TxType string
Specifies the type of transaction.
Values: - "CCAUTHONLY" - "CCSALE" - "CCFORCE" - "CCVOICE" - "CCADJUST" - "CCCREDIT"
UserID int
The unique identifier for the user associated with the transaction. This ID can be used to track which user initiated or is responsible for the transaction.
Example: 2547
Code string
A code representing the status of the batch.
Values: - A: Approved - The batch has been successfully processed. - F: Failed - The batch has failed processing or has been rejected.
ExtraChargeCode string
The type of the included extra charge.
Values: - 0 (ecNone) - 2 (ecRestaurant) - 3 (ecGiftShop) - 4 (ecMiniBar) - 5 (ecTelephone) - 6 (ecOther) - 7 (ecLaundry)
ClientRefID string
A reference ID provided by the client for tracking purposes.
Example: 12456AA
ClientRefID string
A reference ID provided by the client for tracking purposes.
Example: 12456AA
CustomerRefID
A reference ID for the customer.
Example: A1523644
CustomerRefID
A reference ID for the customer.
Example: A1523644
CustomerRefID
A reference ID for the customer.
Example: A1523644
ServiceDescrip string
Service description.
ServiceDescrip string
Service description.
ServiceDescrip string
Service description.
ServiceDescrip string
Service description.
MerchID int
The ID of the merchant for the operation. If you do not have multiple accounts, set to 1.
MerchID int
The ID of the merchant for the operation. If you do not have multiple accounts, set to 1.
PurchType PurchaseType (enum)
The type of purchase.
Values: - notSet = 0 - CPSwipe = 1 - ManKey = 2 - CPSwipeFBTrack1 = 3 - CPSwipeFBTrack2 = 4 - EMVchip = 5
Track string
The data on the magnetic strip of the credit card on card present transactions.
EmvTags string
CardInfo (object)
The details on the card used for the transaction.
Fields: AccountNumber, ExpMonth, ExpYear, CSV
EMVRecTags (object)
EMV record tags associated with the transaction.
Fields: AID, TSI, TVR, AC, ARC
IsAuthOnly boolean
NumDays int
Number of days since the start date before the consent expires.
LimitPerCharge decimal
The $ limit for a single charge on the consent.
NumDays int
Number of days since the start date before the consent expires.
LimitPerCharge decimal
The $ limit for a single charge on the consent.
NumDays int
Number of days since the start date before the consent expires.
LimitPerCharge decimal
The $ limit for a single charge on the consent.