Table of Contents

Search

  1. Preface
  2. Part 1: Cloud Operations
  3. Part 2: Parameter and Element Reference
  4. Appendix A: REST Call Example
  5. Appendix B: Geocode Countries
  6. Appendix C: Certified Mode Values

Developer Guide

Developer Guide

The getTransactionDetails Method

The getTransactionDetails Method

When you submit a request with the getTransactionDetails method, you provide your account name and password. No other input information is necessary.
The getTransactionDetails method returns the information as an array of properties. The method returns a set of properties for each type of transaction that you purchased for the account.
The getTransactionDetails method returns the following properties:

TransactionType

The type of transaction that a given set of properties describes. The type represents the processing mode in which you run the address jobs that consume the transactions. For example,
BATCH
.

PoolType

The transaction pool that a given set of properties describes. The transaction pool represents the project environment in which you run the address jobs that consume the transactions. For example,
PRODUCTION
.
The array that Address Verification returns for the getTransactionDetails method includes a set of properties for each combination of TransactionType and PoolType that exists in your account.
For example, let's say that you purchase a quantity of batch transactions and interactive transactions and you assign the transactions to a Test pool and a Production pool. The getTransactionDetails method returns a separate set of properties for BATCH: TEST, BATCH: PRODUCTION, INTERACTIVE: TEST, and INTERACTIVE: PRODUCTION.

PaymentModel

The method that your organization uses to pay for the transactions that the properties specify. For example,
Prepaid
.

TotalTransactions

The total number of transactions of the given transaction type and pool type that your organization purchased for your account.

UsedTransactions

The number of transactions of the given transaction type and pool type that your account has used to date.

RemainingTransactions

The number of transactions of the given transaction type and pool type that remain in your account.

ValidFrom

The date and time at which the given transactions became usable in your account.

ValidTo

The date and time at which the given transactions will expire in your account.

Region

The global region in which the transactions are valid.

0 COMMENTS

We’d like to hear from you!