Bankcard Retail
This sandbox has methods and samples tailored for a card-present environment (eg, in-store).
API Health
Method
Description
Method
Description
Used to retrieve basic server/environment information about the front-end API.
Used to retrieve basic server/environment information about the front- and back-end APIs.
Charges
Method
Description
Method
Description
Used to query charges by various criteria including amount, date, order number, type, etc. Results include both summarized information and itemized detail.
Used to process a charge. Charges are 'Sale', 'Auth', or 'Force' transactions. Sale transactions include the authorization and capture steps in a single request, while Auth transactions must be manually captured in a subsequent request. Force transactions are used in rare situations where the authorization code is being explicitly set.
Used to retrieve detailed information about a specific charge.
Used to "capture" an Auth transaction. This is an opportunity to finalize the payment amount.
Used to "void", or cancel, a charge. Only unsettled transactions can be voided; settled transactions should be credited instead.
Used to retrieve any line item detail associated with a transaction.
Used to add line item details, such as the specific items that are being purchased, to a transaction. This is rarely used outside of Level III processing.
Used to remove any line item details that have been associated with a transaction.
Credits
Method
Description
Method
Description
Used to query credits by various criteria including amount, date, order number, type, etc. Results include both summarized information and itemized detail.
Used to process a credit. Credit transactions refund an amount to a card.
Used to retrieve detailed information about a specific credit.
Used to process a credit. Referencing a previous transaction allows you to issue a refund without knowing the card number and expiration date.
Used to "void", or cancel, a credit. Only unsettled transactions can be voided.
Reporting on Transactions
Method
Description
Method
Description
Used to query transactions by various criteria including amount, date, order number, type, etc. Results include both summarized information and itemized detail.
Used to retrieve detailed information about a specific transaction.
Settlements and Batches
Method
Description
Method
Description
Used to query settled batches by date. Results include itemized details, such as settlement date and reference number.
Used to retrieve itemized detail about the transactions in the current batch.
Used to settle the open transactions in the current batch. Settlement initiates the merchant funding process.
Used to retrieve summarized information, such as count and volume, about the transactions in the current batch.
Used to retrieve the total count and amount of all batches settled within a given timeframe.
Used to retrieve itemized detail about the transactions in a specific batch.