Loading...
To retrieve the details of a transaction, send a DetailedTransactionLookup request to the Reporting endpoint.
A DetailedTransactionLookup request must include a Token or a MerchantTransactionId to identify the transaction you want to view.
MerchantCredentials
| Parameter | Description | Type | Size | Optional? |
|---|---|---|---|---|
| MerchantName | Name of the merchant or their business. | String | 1-160 | Required |
| MerchantSiteId | Identifier for the merchant's store or location. | String | 1-160 | Required |
| MerchantKey | Authentication key for the merchant's account. | String | 1-160 | Required |
Request
| Parameter | Description | Type | Size | Optional? |
|---|---|---|---|---|
| Token | Unique identifier that our gateway assigned to the transaction. Note: If you provide a Token in the request, do not provide a MerchantTransactionId. | String | 0-100 | Optional |
| MerchantTransactionId | Unique identifier that the merchant assigned to the transaction. Note: If you provide a MerchantTransactionId in the request, do not provide a Token. | String | 0-100 | Optional |
DetailedTransactionLookupResult
| Parameter | Description | Type |
|---|---|---|
| ApprovalCode | Approval code the processor returned for the transaction. | String |
| ApprovalStatus | Response from the processor that indicates the status of the transaction. | String |
| AuthorizationAmount | Dollar amount the processor authorized for the transaction. | String |
| AvsResponse | Result of an Address Verification Service (AVS) review. The merchant uses this to verify the address of the cardholder. For a list of possible values, see AVS Response Codes. | String |
| BatchNumber | Number of the batch that contains the transaction. | String |
| Cardholder | Name of the cardholder. Note: We return this value only for card transactions. | String |
| CashbackAmount | Dollar amount that the cardholder requested as cashback in the transaction. Cashback allows the cardholder to add a dollar amount to their purchase that they receive as cash. | String |
| CardNumber | Permanent account number (PAN) on the cardholder's payment card. We return a truncated card number for security reasons. Note: If the transaction is a check transaction, this value is the number of the customer's bank account. | String |
| PaymentType | Card type used in the transaction. For a list of possible values, see PaymentType. | Integer |
| ConvenienceAmount | Dollar amount that the merchant charged the cardholder for performing the transaction. | String |
| CustomerId | Unique identifier that the merchant assigned to the cardholder. | String |
| CvvResponse | A Card Verification Value (CVV). This is also known as the following: • Card Security Code (CSC) • Card Verification Data (CVD) • Card Verification Number (CVN) • Card Verification Code (CVC) For a list of possible values, see CVV Response Codes. | String |
| DiscountAmount | Dollar amount of discount the merchant gave to the cardholder. | String |
| ErrorMessage | If the transaction could not be processed, this message explains the reason for the error. | String |
| ExpirationDate | Date that the payment card expires in MMYY format. | String |
| HostReference | Unique identifier that the processor issued when it received the transaction. | String |
| InvoiceNumber | Invoice number for the transaction, which was created by the merchant. | String |
| IsTransactionAdjusted | Indicates if the transaction was adjusted from its original amount. The value is one of the following: • True - Transaction has been adjusted. • False - Transaction has not been adjusted. | Boolean |
| IsTransactionCaptured | If the transaction is an authorization, this indicates if the merchant captured the transaction. The value is one of the following: • True - Merchant captured the transaction. • False - Merchant did not capture the transaction. Note: If the transaction is not an authorization, we return a value of False. | Boolean |
| IsTransactionVoided | Indicates if the transaction was voided. The value is one of the following: • True - Transaction voided. • False - Transaction was not voided. | Boolean |
| IsTransactionSettled | Indicates if the transaction was settled. The value is one of the following: • True - Transaction settled. • False - Transaction not settled. | Boolean |
| MerchantTransactionId | Unique identifier that the merchant assigned to the transaction. | String |
| OriginalToken | Identifies the original transaction that was referenced by the current transaction. For example, the token for the original authorization that the merchant then captured. | String |
| PostalCode | ZIP code of the cardholder's address. | String |
| PurchaseOrderNumber | Purchase order number for the transaction, which was created by the cardholder. | String |
| RegisterNumber | Identifies the POS that processed the transaction. | String |
| StreetAddress | First line of the cardholder's address. | String |
| SupportedActions | Object that indicates the actions allowed for a transaction. See the SupportedActions data structure. | Object |
| SurchargeAmount | Dollar amount that the merchant charges the cardholder as a surcharge for paying using a credit card. Note: Your merchant account must be enabled for surcharging and it's available only for U.S. issued credit cards. | String |
| TaxAmount | Dollar amount of the transaction that was tax. | String |
| TipAmount | Dollar amount of the transaction that was tip. Note: Only certain merchant types can accept tips. Contact your processor for more information. | String |
| Token | Unique identifier for the transaction in our gateway. | String |
| TotalAmount | Total dollar amount of the transaction. | String |
| TransactionDate | Date in UTC that the merchant ran the transaction. The format is YYYY-MM-DDTHH:MM:SS, for example, 2020-02-01T09:00:00. | DateTime |
| TransactionType | Type of transaction. For a list of possible values, see TransactionType. | Integer |
| UserName | Username of the merchant that ran the transaction. | String |
| HealthCareAmounts | Object that contains the dollar amounts the cardholder spent on different types of healthcare. See the HealthCareAmounts data structure. | Object |
| Emv | Object that contains information about an EMV transaction. See the EMV data structure. Note: We return this object only if the transaction is an EMV transaction. | Object |
| EntryMode | Source of the transaction. For a list of possible values, see EntryMode. | String |
| FsaCard | Indicates if the cardholder used a Flexible Spending Account (FSA) card. The value is one of the following: • True - Cardholder used an FSA card. • False - Cardholder did not use an FSA card. | Boolean |
| FraudScoring | Object that contains the fraud-scoring details about the transaction. See the FraudScoring data structure. Note: We return this object only if the merchant has subscribed to this service. | Object |
| EbtBasisType | Indicates the type of EBT that the cardholder used to pay for the transaction. The value is one of the following: • 0 - The value is reserved. • 1 - Cardholder used EBT food benefits. • 2 - Cardholder used EBT cash or a cash equivalent. Note: We return this only for EBT transactions. | Integer |
| Rfmiq | Frequency-Frequency-Monetary IQ (RFMIQ) is an anonymized identifier representing the payment card used in the transaction. Note: We return this value only if the merchant has subscribed to this service. | String |
| Invoice | Object that contains the transaction's tax amounts and line-item details. See the Invoice data structure. | Object |
| CustomerEmailAddress | Cardholder's email address. | String |
| MultipleClearing | Object that contains information about multiple shipments. See the MultipleClearing data structure. | Object |
| VaultToken | Represents a cardholder's payment details that the merchant saved in the vault. | String |
| CardBin | Bank identification number (BIN) of the payment card, which is the first six digits printed on the front of the card. Our gateway returns the BIN only if the merchant is set up for this feature and the card number is valid. A card number is valid if it has the following: • Minimum of 15 digits • Numeric characters only | String |
| MerchantVaultTokenReference | Reference that the merchant tagged to a cardholder's account. The merchant can add the reference to multiple accounts to allow them to group transactions. | String |
| CheckData | Object that contains information about the check transaction. See the CheckData data structure. Note: We return this only for check transactions. | Object |
| CheckImages | Object that indicates if the merchant sent check images in the transaction. See the CheckImages data structure. Note: We return this only for check transactions. | Object |
| RecurringCheck | Indicates if the check transaction is recurring. The value is one of the following: • True - Transaction is recurring. • False - Transaction is not recurring. Note: We return this only for check transactions. | String |
| CheckStatus | Response from the processor that describes the status of the check transaction. Note: We return this only for check transactions. | String |
| FundingStatus | Response from the processor that describes the funding status of the check transaction. Note: We return this only for check transactions. | String |
| DepositDate | Date in UTC of the deposit of the check or checking account transaction. The format is YYYY-MM-DDTHH:MM:SS, for example, 2020-02-01T09:00:00. Note: We return this only for check transactions. | DateTime |
| AchChangeLog | Object that contains processing information about the check transaction. See the AchChangeLog data structure. Note: We return this only for check transactions. | Object |
To retrieve a list of transactions in a date range, send a TransactionsByDate request to the Reporting endpoint.
A TransactionsByDate request must include a StartDate and an EndDate. You can filter the transactions by providing at least one of the following parameters in the request:
MerchantCredentials
| Parameter | Description | Type | Size | Optional? |
|---|---|---|---|---|
| MerchantName | Name of the merchant or their business. | String | 1-160 | Required |
| MerchantSiteId | Identifier for the merchant's store or location. | String | 8-160 | Required |
| MerchantKey | Authentication key for the merchant's account. | String | 1-160 | Required |
Request
| Parameter | Description | Type | Size | Optional? |
|---|---|---|---|---|
| StartDate | Start date in UTC of your report.The format is YYYY-MM-DDTHH:MM:SS, for example, 2020-02-01T09:00:00. | DateTime | 6-60 | Required |
| EndDate | End date in UTC of your report.The format is YYYY-MM-DDTHH:MM:SS, for example, 2020-03-01T09:00:00. | DateTime | 6-60 | Required |
| InvoiceNumber | Invoice number for the transaction, which was created by the merchant. | String | 0-100 | Optional |
| AuthorizationCode | Authorization code the processor returned for the transaction. | String | 0-100 | Optional |
| RegisterNumber | Identifies the POS that processed the transaction. | String | 0-10 | Optional |
| VaultToken | Represents a cardholder's payment details that the merchant saved in the vault. | String | 0-20 | Optional |
TransactionReference
| Parameter | Description | Type |
|---|---|---|
| Amount | Dollar amount of the transaction. | String |
| ApprovalStatus | Response from the processor that indicates the status of the transaction. | String |
| AuthorizationCode | Authorization code the processor returned for the transaction. | String |
| Cardholder | Name of the cardholder. Note: We return this value only for card transactions. | String |
| CardNumber | Permanent account number (PAN) on the cardholder's payment card. We return a truncated card number for security reasons. Note: If the transaction is a check transaction, this value is the number of the customer's bank account. | String |
| PaymentType | Card type used in the transaction. For a list of possible values, see PaymentType. | Integer |
| ErrorMessage | If the transaction could not be processed, this message explains the reason for the error. | String |
| InvoiceNumber | Invoice number for the transaction, which was created by the merchant. | String |
| MerchantTransactionId | Unique identifier that the merchant assigned to the transaction. | String |
| Token | Unique identifier for the transaction in our gateway. | String |
| TransactionDate | Date in UTC that the merchant ran the transaction. The format is YYYY-MM-DDTHH:MM:SS, for example, 2020-02-01T09:31:22. | DateTime |
| TransactionType | Type of transaction. For a list of possible values, see TransactionType. | Integer |
| BatchNumber | Number of the batch that contains the transaction. | String |
| EbtBasisType | Indicates the type of EBT that the cardholder used to pay for the transaction. The value is one of the following: • 0 - The value is reserved. • 1 - Cardholder used EBT food benefits. • 2 - Cardholder used EBT cash or a cash equivalent. Note: We return this only for EBT transactions. |
To retrieve a list of check transactions in a date range, send an AchReturnSearch request to the Reporting endpoint.
An AchReturnSearch request must include a StartDate and an EndDate. If the merchant has run any check transactions during the specified date range, we return the details of the check transactions.
Check transactions can take a few days to deposit into the merchant's account. The merchant can run this report to indicate if a check transaction has been processed or if a check has been returned by the Automated Clearing House (ACH).
MerchantCredentials
| Parameter | Description | Type | Size | Optional? |
|---|---|---|---|---|
| MerchantName | Name of the merchant or their business. | String | 1-160 | Required |
| MerchantSiteId | Identifier for the merchant's store or location. | String | 8-160 | Required |
| MerchantKey | Authentication key for the merchant's account. | String | 1-160 | Required |
Request
| Parameter | Description | Type | Size | Optional? |
|---|---|---|---|---|
| StartDate | Start date in UTC of your report. The format is YYYY-MM-DDTHH:MM:SS, for example, 2020-01-01T09:00:00. | DateTime | 6-60 | Required |
| EndDate | End date in UTC of your report. The format is YYYY-MM-DDTHH:MM:SS, for example, 2020-02-01T09:00:00. | DateTime | 6-60 | Required |
AchReturn
| Parameter | Description | Type |
|---|---|---|
| ApprovalCode | Approval code the processor returned for the transaction. | String |
| ApprovalStatus | Response from the processor that indicates the status of the transaction. | String |
| ErrorMessage | If the transaction could not be processed, this message explains the reason for the error. | String |
| Token | Unique identifier for the transaction in our gateway. | String |
| OriginalToken | Identifies the original transaction that was referenced by the current transaction. For example, the token for the original authorization that the merchant then captured. | String |
| RegisterNumber | Identifies the POS that processed the transaction. | String |
| MerchantTransactionId | Unique identifier that the merchant assigned to the transaction. | String |
| InvoiceNumber | Invoice number for the transaction, which was created by the merchant. | String |
| CustomerCode | Unique identifier that the merchant assigned to the cardholder. | String |
| PurchaseOrderNumber | Purchase order number for the transaction, which was created by the cardholder. | String |
| EntryMode | Source of the transaction. For a list of possible values, see EntryMode. | String |
| TransactionDate | Date in UTC that the merchant ran the check transaction. The format is YYYY-MM-DDTHH:MM:SS, for example, 2020-02-01T09:23:44. | DateTime |
| TransactionType | Type of transaction. For a list of possible values, see TransactionType. | Integer |
| UserName | Username of the merchant that ran the transaction. | String |
| VaultToken | Represents a cardholder's payment details that the merchant saved in the vault. | String |
| MerchantVaultTokenReference | Reference that the merchant tagged to a cardholder's account. The merchant can add the reference to multiple accounts to allow them to group transactions. | String |
| CheckData | Object that contains information about the check transaction. See the data structure. |
| Integer |
| OriginalToken | Identifies the original transaction that was referenced by the current transaction. For example, the token for the original authorization that the merchant then captured. | String |
| VaultToken | Represents a cardholder's payment details that the merchant saved in the vault. | String |
| MerchantVaultTokenReference | Reference that the merchant tagged to a cardholder's account. The merchant can add the reference to multiple accounts to allow them to group transactions. | String |
| NameOnCheck | Name of the customer as it appears on the check or checking account. Note: We return this only for check transactions. | String |
| TransitNumber | Routing number of the check or checking account. Note: We return this only for check transactions. | String |
| AccountNumber | Account number of the checking account. Note: We return this only for check transactions. | String |
| CheckNumber | Unique number of the check. Note: We return this only for check transactions. | String |
| CheckStatus | Response from the processor that describes the status of the check transaction. Note: We return this only for check transactions. | String |
| FundingStatus | Response from the processor that described the funding status of the check transaction. Note: We return this only for check transactions. | String |
| DepositDate | Date in UTC of the deposit of the check or checking account transaction. The format is YYYY-MM-DDTHH:MM:SS, for example, 2020-02-10T10:47:19. | DateTime |
| SurchargeAmount | Dollar amount that the merchant charges the cardholder as a surcharge for paying using a credit card. Note: Your merchant account must be enabled for surcharging and it's available only for U.S. issued credit cards. | String |
| Object |
| RecurringCheck | Indicates if the check transaction is recurring. The value is one of the following: • True - Transaction is recurring. • False - Transaction is not recurring. | String |
| CheckStatus | Response from the processor that describes the status of the check transaction. | String |
| FundingStatus | Response from the processor that describes the funding status of the check transaction. | String |
| DepositDate | Date in UTC of the deposit of the check or checking account transaction. The format is YYYY-MM-DDTHH:MM:SS, for example, 2020-01-21T13:21:43. | DateTime |
| AchChangeLog | Object that contains processing information about the check transaction. See the AchChangeLog data structure. | Object |