# Retrieves payment session details by ID

GET {{baseURL}}/pay-int-api/payment-sessions/{{paymentSessionId}}
This endpoint retrieves the details of the specified payment session.
See Also:
To create a payment session, see POST /pay-int-api/payment-sessions.
To cancel a payment session, see POST /pay-int-api/payment-sessions/{paymentSessionId}/cancel.

Endpoint: GET /pay-int-api/payment-sessions/{paymentSessionId}
Version: V1
Security: Bearer

## Security:

  - `Bearer` (unknown)
    http bearer JWT

## Path parameters:

  - `paymentSessionId` (string, required)
    Specifies the identifier of the payment session to get the status and details.

## Header parameters:

  - `x-api-version` (string)
    Specifies the API version to use for the request.

Example: 1.0

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `statusId` (integer)
    Indicates the payment session status.
Possible values:
| Value | Status | Description |
|  --- | --- | --- |
| 1 | Created | Payment session was initialized but not yet processed. |
| 2 | Cancelled | Payment session was cancelled before completion. |
| 3 | Completed | Payment session was completed. Check transaction details to verify if the payment was approved or not. |
| 4 | Failed | Payment was attempted but did not succeed. A new session must be created for a new payment attempt. |
| 5 | Expired | Payment session expired before being completed. |

Example: 3
    Example: 3

  - `status` (string)
    Indicates the payment session status.
Possible values:
| Status | Value | Description |
|  --- | --- | --- |
| Created | 1 | Payment session was initialized but not yet processed. |
| Cancelled | 2 | Payment session was cancelled before completion. |
| Completed | 3 | Payment session was completed. Check transaction details to verify if the payment was approved or not. |
| Failed | 4 | Payment was attempted but did not succeed. A new session must be created for a new payment attempt. |
| Expired | 5 | Payment session expired before being completed. |

Example: Completed
    Example: Completed

  - `customerId` (string)
    Indicates the customer identifier.
This was used when saving the payment method.
If this value was provided, the payment method was saved to the specified customer.
If this value was not provided, a new customer record was created.
Example: fd9198a4-eb6f-4620-9603-4f4638289de5
    Example: fd9198a4-eb6f-4620-9603-4f4638289de5

  - `mode` (integer)
    Specifies the intent of the session.
Defaults to Payment if omitted.
| Value | Name | Description |
|  --- | --- | --- |
| 1 | Payment | Standard payment session. |
| 2 | SaveMethod | Vault-only session to store a payment method. |
| 3 | PaymentAndSave | Charge the payment and save the method. |

Example: 2
    Example: 2

  - `skipAddressVerification` (boolean)
    Indicates to bypass the AVS (address verification service) in the payment gateway.
This value is applicable only to `Payment` and `PaymentAndSave` from `mode`.
If `true`, bypasses AVS in the payment gateway.
If `false`, does not bypass AVS in the payment gateway.
Example: true
    Example: true

  - `referenceId` (string)
    Specifies an external transaction identifier for client-side tracking.

Also used in duplicate control validation.
A unique value allows similar transactions to process as distinct, bypassing duplicate blocking when needed.

Example: 10001
    Example: 10001

  - `vaultedPaymentMethodId` (string)
    Indicates the identifier of the vaulted payment method when the session involves saving or using a stored payment method.

Example: 990a65f4-519c-44f9-a615-fc9c7781190c
    Example: 990a65f4-519c-44f9-a615-fc9c7781190c

  - `transactionDetails` (object)
    Contains information about the processed transaction.

  - `transactionDetails.transactionReceiptUrl` (string)
    Indicates the direct link URL to the transaction receipt.

  - `transactionDetails.transactionReceiptShortUrl` (string)
    Indicates the shortened URL to access the transaction receipt.

  - `transactionDetails.source` (object)
    Indicates the source of the transaction.

  - `transactionDetails.source.typeId` (integer)
    Indicates the identifier of the source type.

Example: 1
    Example: 1

  - `transactionDetails.source.type` (string)
    Indicates the name of the source type.

Example: Api
    Example: Api

  - `transactionDetails.source.id` (string)
    Indicates the identifier of the source.

Example: 5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e81
    Example: 5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e81

  - `transactionDetails.source.name` (string)
    Indicates the name of the source.

Example: Terminal 12
    Example: Terminal 12

  - `transactionDetails.source.version` (string)
    Indicates the version of the source.

Example: 2.1.0
    Example: 2.1.0

  - `transactionDetails.transactionReceipt` (object)
    Indicates an object describing the transaction receipt.
The transaction receipt will be null or empty before the transaction is completed.
After the completed transaction, it will be filled out.

  - `transactionDetails.transactionReceipt.transactionId` (string)
    Identifies the transaction identifier.

Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
    Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7

  - `transactionDetails.transactionReceipt.transactionDateTime` (string)
    Identifies the date-time (in an ISO 8601 date-time UTC format) of the transaction execution.

Examples: 2026-02-19T20:24:52.934Z
    Example: 2026-02-19T20:24:52.934Z

  - `transactionDetails.transactionReceipt.amount` (object)
    Indicates an object detailing the amount.

  - `transactionDetails.transactionReceipt.amount.baseAmount` (number)
    Identifies the original amount (in USD) of a transaction before adjustments are applied.
Example: 129.99 (for $129.99)
    Example: 129.99

  - `transactionDetails.transactionReceipt.amount.percentageOffAmount` (number)
    Identifies the discount amount (in USD) taken off.
This discount was calculated using the preset percentage from `percentageOffRate`.
Example: 12.50 (for $12.50)
    Example: 12.5

  - `transactionDetails.transactionReceipt.amount.percentageOffRate` (number)
    Identifies the discount percentage.
This value is percentage rate for the discount.
This discount percentage calculates the discount amount for `percentageOffAmount`.
Example: 3.5 (as 3.5%)
    Example: 3.5

  - `transactionDetails.transactionReceipt.amount.cashDiscountAmount` (number)
    Identifies the discount amount (in USD) when a cash (or cash-equivalent) discount is applied.
This discount was calculated using the preset percentage from `cashDiscountRate`.
Example: 10.55 (for $10.55)
    Example: 10.55

  - `transactionDetails.transactionReceipt.amount.cashDiscountRate` (number)
    Identifies the discount percentage for a cash (or cash-equivalent) discount.
This value is percentage rate for the discount.
This discount percentage calculates the discount amount for `cashDiscountAmount`.
Example: 1.5 (as 1.5%)
    Example: 1.5

  - `transactionDetails.transactionReceipt.amount.surchargeAmount` (number)
    Identifies the amount (in USD) when a surcharge is applicable.
This is a surcharge on the base amount.
This surcharge was calculated using the preset percentage from `surchargeRate`.
Example: 6.45 (for $6.45)
    Example: 6.45

  - `transactionDetails.transactionReceipt.amount.surchargeRate` (number)
    Identifies the surcharge percentage.
This is a surcharge on the base amount.
This value is surcharge percentage rate.
This surcharge percentage calculates the surcharge amount for `surchargeAmount`.
Example: 1.5 (as 1.5%)
    Example: 1.5

  - `transactionDetails.transactionReceipt.amount.tipAmount` (number)
    Specifies the absolute amount (in USD) of the tip to be added.
This amount adds to the base amount of the original transaction.
That transaction must be authorized first.

Values for `tipAmount` and `tipRate` are mutually exclusive.
Care must be taken to include one or the other but not both.
If neither value is provided, no tip is added.
Example: 14.50 (for $14.50)
    Example: 14.5

  - `transactionDetails.transactionReceipt.amount.tipRate` (number)
    Specifies the tip rate as a percentage of the base amount to be added.
This amount adds to the base amount of the original transaction.
That transaction must be authorized first.

Values for `tipAmount` and `tipRate` are mutually exclusive.
Care must be taken to include one or the other but not both.
If neither value is provided, no tip is added.
Example: 15 (as 15%)
    Example: 15

  - `transactionDetails.transactionReceipt.amount.totalAmount` (number)
    Specifies the transaction's total amount.

This includes the base amount, tips, taxes, shipping, discounts, and other charges.

Example: 3219.45
    Example: 3219.45

  - `transactionDetails.transactionReceipt.currencyId` (integer)
    Indicates the Flute currency identifier.
Always set to *1*.
Example: 1
    Example: 1

  - `transactionDetails.transactionReceipt.currency` (string)
    Indicates the currency code (in ISO 4217 currency code).

Example: USD
    Example: USD

  - `transactionDetails.transactionReceipt.processorId` (string)
    Indicates the processor identifier.

Example: ef08c4d5-6e7f-4a8b-9c0d-1e2f3a4b5c81
    Example: ef08c4d5-6e7f-4a8b-9c0d-1e2f3a4b5c81

  - `transactionDetails.transactionReceipt.processor` (string)
    Indicates the payment processor.
This is the system or company that handles the actual movement and authorization of payment transactions.
Examples:
TSYS
Fiserv
    Example: TSYS

  - `transactionDetails.transactionReceipt.operationTypeId` (integer)
    Indicates the operation type value.
Possible values:
| Id | Operation Type |
|  --- | --- |
| 1 | PayNow |
| 2 | Subscription |

example: 1
    Example: 1

  - `transactionDetails.transactionReceipt.operationType` (string)
    Indicates the operation type.
Possible values:
| Operation Type | Id |
|  --- | --- |
| PayNow | 1 |
| Subscription | 2 |

Example: PayNow
    Example: PayNow

  - `transactionDetails.transactionReceipt.paymentMethodTypeId` (integer)
    Indicates the payment method type identifier.
Value values:
| Id | Name |
|  --- | --- |
| 1 | Card (for credit card) |
| 2 | ElectronicCheck |

Example: 2
    Example: 2

  - `transactionDetails.transactionReceipt.paymentMethodType` (string)
    Indicates the payment method type name.
Value values:
| Name | Id | Notes |
|  --- | --- | --- |
| Card | 1 | For credit or debit card |
| ElectronicCheck | 2 |  |

Example: Card
    Example: Card

  - `transactionDetails.transactionReceipt.transactionTypeId` (integer)
    Indicates the transaction type identifier.
Possible values:
| Type | Value |
|  --- | --- |
| Authorization | 1 |
| Sale | 2 |
| Capture | 3 |
| Void | 4 |
| Refund | 5 |
| Verify | 6 |

Example: 5
    Example: 5

  - `transactionDetails.transactionReceipt.transactionType` (string)
    Indicates the transaction type name.
Possible values:
| Value | Type |
|  --- | --- |
| Authorization | 1 |
| Sale | 2 |
| Capture | 3 |
| Void | 4 |
| Refund | 5 |
| Verify | 6 |

Example: Refund
    Example: Refund

  - `transactionDetails.transactionReceipt.customerId` (string)
    Specifies the customer identifier.
This is used when saving the payment method.
If this value is provided, the payment method is saved to the specified customer.
If this value is not provided, a new customer record is created.
Example: fd9198a4-eb6f-4620-9603-4f4638289de5
    Example: fd9198a4-eb6f-4620-9603-4f4638289de5

  - `transactionDetails.transactionReceipt.customerPan` (string)
    Indicates customer’s PAN (primary account number).
This is the payment card number.
The value is masked except for a few numbers for additional security.
Example: ************4512
    Example: ************4512

  - `transactionDetails.transactionReceipt.cardTokenType` (integer)
    Identifies the card token type.
Possible values:
| Id | Type | Description |
|  --- | --- | --- |
| 1 | Local | Regular |
| 2 | Network | Network |

Example: 2
    Example: 2

  - `transactionDetails.transactionReceipt.statusId` (integer)
    Indicates the Flute transaction status code.
Example: 2
    Example: 2

  - `transactionDetails.transactionReceipt.status` (string)
    Indicates the Flute transaction status type.
Example: Captured
    Example: Captured

  - `transactionDetails.transactionReceipt.merchantName` (string)
    Indicates the merchant's name.

Example: Peppared Street Cafe
    Example: Peppared Street Cafe

  - `transactionDetails.transactionReceipt.merchantAddress` (string)
    Indicates the merchant's address.

Example: 123 Main St, Springfield, IL 62701
    Example: 123 Main St, Springfield, IL 62701

  - `transactionDetails.transactionReceipt.merchantPhoneNumber` (string)
    Indicates the merchant's phone number.
Example: +14155552309
    Example: +14155552309

  - `transactionDetails.transactionReceipt.merchantEmailAddress` (string)
    Indicates the merchant's email address.
Example: peppared@example.com
    Example: peppared@example.com

  - `transactionDetails.transactionReceipt.merchantWebsite` (string)
    Indicates the merchant's website.

Example: https://www.peppared.example.com
    Example: https://www.peppared.example.com

  - `transactionDetails.transactionReceipt.authCode` (string)
    Indicates the authorization code returned by the card processor.

Example: 003772
    Example: 003772

  - `transactionDetails.transactionReceipt.source` (object)
    Indicates the source of the transaction.

  - `transactionDetails.transactionReceipt.source.typeId` (integer)
    Indicates the identifier of the source type.

Example: 1
    Example: 1

  - `transactionDetails.transactionReceipt.source.type` (string)
    Indicates the name of the source type.

Example: Api
    Example: Api

  - `transactionDetails.transactionReceipt.source.id` (string)
    Indicates the identifier of the source.

Example: 5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e81
    Example: 5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e81

  - `transactionDetails.transactionReceipt.source.name` (string)
    Indicates the name of the source.

Example: Terminal 12
    Example: Terminal 12

  - `transactionDetails.transactionReceipt.cardholderAuthenticationMethodId` (integer)
    Possible values:
| Value | Name |
|  --- | --- |
| 0 | NotAuthenticated |
| 1 | PIN |
| 2 | ElectronicSignatureAnalysis |
| 3 | ManualSignature |
| 4 | ManualOther |
| 5 | Unknown |
| 6 | SystematicOther |
| 7 | ETicketEnvAmex |
| 8 | OfflinePin |

Example: 0
    Example: 0

  - `transactionDetails.transactionReceipt.cardholderAuthenticationMethod` (string)
    Indicates the name of the cardholder authentication method used for the transaction.

Example: PIN
    Example: PIN

  - `transactionDetails.transactionReceipt.cvmResultMsg` (string)
    Indicates the CVM (cardholder verification method) result message returned by the card processor.

Example: Approved
    Example: Approved

  - `transactionDetails.transactionReceipt.cardDataSourceId` (integer)
    Specifies the card data source.
Possible values:
| Value | Name | Description |
|  --- | --- | --- |
| 1 | Internet | Virtual Terminal, ISV API |
| 2 | Swipe | Track1, Track2 |
| 3 | NFC | EMV Tags, Track2 |
| 4 | EMV | EMV Tags |
| 5 | EMVContactless | EMV Tags |
| 6 | FallbackSwipe | Track 2 |
| 7 | Manual | Card present keyed transaction |

Example: 2
    Example: 2

  - `transactionDetails.transactionReceipt.cardDataSource` (string)
    Indicates the name of the card data source used for the transaction.

Example: Swipe
    Example: Swipe

  - `transactionDetails.transactionReceipt.responseCode` (string)
    Indicates a response code regarding the transaction.

Example: 000
    Example: 000

  - `transactionDetails.transactionReceipt.responseDescription` (string)
    Indicates a free-formed description regarding the transaction.

Example: Command Successful. Approved.
    Example: Command Successful. Approved.

  - `transactionDetails.transactionReceipt.cardProcessingDetails` (object)
    Indicates the card processing details for the transaction.

  - `transactionDetails.transactionReceipt.cardProcessingDetails.authCode` (string)
    Indicates the authorization code returned by the card processor.

Example: 003772
    Example: 003772

  - `transactionDetails.transactionReceipt.cardProcessingDetails.mid` (string)
    Indicates the MID (merchant identifier) assigned to this transaction.

Example: 43252511
    Example: 43252511

  - `transactionDetails.transactionReceipt.cardProcessingDetails.tid` (string)
    Indicates the TID (terminal identifier) assigned to this transaction.

Example: 8820432549239101
    Example: 8820432549239101

  - `transactionDetails.transactionReceipt.cardProcessingDetails.cardCreditDebitTypeId` (integer)
    Indicates the identifier of whether the card is credit or debit.
Possible values:
| Value | Name |
|  --- | --- |
| 1 | Credit |
| 2 | Debit |
| 3 | Unknown |

Example: 1
    Example: 1

  - `transactionDetails.transactionReceipt.cardProcessingDetails.cardCreditDebitType` (string)
    Indicates the name of whether the card is credit or debit.

Example: Credit
    Example: Credit

  - `transactionDetails.transactionReceipt.cardProcessingDetails.processCreditDebitTypeId` (integer)
    Indicates the identifier of whether the transaction was processed as credit or debit.
Possible values:
| Value | Name |
|  --- | --- |
| 1 | Credit |
| 2 | Debit |
| 3 | Unknown |

Example: 1
    Example: 1

  - `transactionDetails.transactionReceipt.cardProcessingDetails.processCreditDebitType` (string)
    Indicates the name of whether the transaction was processed as credit or debit.

Example: Credit
    Example: Credit

  - `transactionDetails.transactionReceipt.cardProcessingDetails.rrn` (string)
    Indicates the RRN (retrieval reference number).

This is a transaction tracking identifier used to specify and trace a transaction across systems.

Example: 10628361287F
    Example: 10628361287F

  - `transactionDetails.transactionReceipt.cardProcessingDetails.cardTypeId` (integer)
    Indicates the Flute credit card type identifier code.
Example: 1
    Example: 1

  - `transactionDetails.transactionReceipt.cardProcessingDetails.cardType` (string)
    Indicates the name of the credit card.
Example: Visa
    Example: Visa

  - `transactionDetails.transactionReceipt.achProcessingDetails` (object)
    Indicates the ACH (automated clearing house) processing details for the transaction.

  - `transactionDetails.transactionReceipt.achProcessingDetails.customerAccountNumber` (string)
    Indicates the customer's bank account number.

Example: 5413591081013511
    Example: 5413591081013511

  - `transactionDetails.transactionReceipt.achProcessingDetails.customerRoutingNumber` (string)
    Indicates the customer's bank routing number.

Example: 026009593
    Example: 026009593

  - `transactionDetails.transactionReceipt.achProcessingDetails.accountHolderType` (string)
    Indicates the name of the account holder type.

Example: Business
    Example: Business

  - `transactionDetails.transactionReceipt.achProcessingDetails.accountHolderTypeId` (integer)
    Indicates the account holder type identifier.
Possible values:
| Type ID | Account Type | Description |
|  --- | --- | --- |
| 1 | Business | Business |
| 2 | Personal | Personal |

Example: 1
    Example: 1

  - `transactionDetails.transactionReceipt.achProcessingDetails.accountType` (string)
    Indicates the name of the account type.

Example: Checking
    Example: Checking

  - `transactionDetails.transactionReceipt.achProcessingDetails.accountTypeId` (integer)
    Indicates the account type identifier.
Possible values:
| Type ID | Account Type | Description |
|  --- | --- | --- |
| 1 | Checking | Checking |
| 2 | Savings | Savings |

Example: 1
    Example: 1

  - `transactionDetails.transactionReceipt.achProcessingDetails.taxId` (string)
    Specifies the customer's TIN (tax identifier number).

Example: 98-7654321
    Example: 98-7654321

  - `transactionDetails.transactionReceipt.availableOperations` (array)
    Available operations that can be performed on the transaction.

  - `transactionDetails.transactionReceipt.availableOperations.typeId` (integer)
    Possible values:
| Id | Type | Description |
|  --- | --- | --- |
| 1 | Authorization |  |
| 2 | Sale |  |
| 3 | Capture |  |
| 4 | Void |  |
| 5 | Refund |  |
| 6 | CardAuthentication |  |
| 7 | RefundWORef | Refund without reference.As a warning, these are considered high-risk transaction types, as funds are debited directly from the merchant's account even if the original sale was not processed through Flute. |
| 8 | TipAdjustment |  |
| 11 | AchDebit |  |
| 12 | AchRefund |  |
| 13 | AchHold |  |
| 14 | AchUnHold |  |
| 15 | AchCancel |  |
| 16 | AchCredit |  |

  - `transactionDetails.transactionReceipt.availableOperations.type` (string)
    Indicates the name of the transaction operation.

Example: Refund
    Example: Refund

  - `transactionDetails.transactionReceipt.availableOperations.availableAmount` (number)
    Indicates the amount (in USD) available for this operation.
Example: 129.99 (for $129.99)
    Example: 129.99

  - `transactionDetails.transactionReceipt.availableOperations.suggestedTips` (array)
    Suggested tip amounts for this operation.

  - `transactionDetails.transactionReceipt.availableOperations.suggestedTips.tipAmount` (number)
    Specifies the absolute amount (in USD) of the tip to be added.
This amount adds to the base amount of the original transaction.
That transaction must be authorized first.

Values for `tipAmount` and `tipRate` are mutually exclusive.
Care must be taken to include one or the other but not both.
Example: 14.50 (for $14.50)
    Example: 14.5

  - `transactionDetails.transactionReceipt.availableOperations.suggestedTips.tipPercent` (number)
    Specifies the tip rate as a percentage of the base amount to be added.
This amount adds to the base amount of the original transaction.
That transaction must be authorized first.

Values for `tipAmount` and `tipRate` are mutually exclusive.
Care must be taken to include one or the other but not both.
Example: 15 (as 15%)
    Example: 15

  - `transactionDetails.transactionReceipt.avsResponse` (object)
    Indicates the Address Verification Service (AVS) response.

  - `transactionDetails.transactionReceipt.avsResponse.actionId` (integer)
    Possible values:
| Value | Name |
|  --- | --- |
| 1 | Allow |
| 2 | Deny |

Example: 1
    Example: 1

  - `transactionDetails.transactionReceipt.avsResponse.action` (string)
    Indicates the AVS action.
Valid values are:
| Value | Description |
|  --- | --- |
| Allow | The transaction is allowed to proceed. |
| Deny | The transaction is denied because of the AVS result. |

Example: Allow
    Example: Allow

  - `transactionDetails.transactionReceipt.avsResponse.responseCode` (string)
    Indicates the AVS response code.

This is a processor-specific code describing the AVS match result.

Example: 0
    Example: 0

  - `transactionDetails.transactionReceipt.avsResponse.groupId` (integer)
    Possible values:
| Value | Name |
|  --- | --- |
| 1 | NoMatch |
| 2 | PartialMatch |
| 3 | Incompatible |
| 4 | Unavailable |
| 5 | ValidGroup |

Example: 5
    Example: 5

  - `transactionDetails.transactionReceipt.avsResponse.group` (string)
    Indicates the AVS code group.
Valid values are:
| Value | Description |
|  --- | --- |
| NoMatch | None of the address data matched. |
| PartialMatch | Some of the address data matched. |
| Incompatible | The address data could not be compared due to a format mismatch. |
| Unavailable | AVS is not available for this transaction or card type. |
| ValidGroup | All of the address data matched. |

Example: ValidGroup
    Example: ValidGroup

  - `transactionDetails.transactionReceipt.avsResponse.resultId` (integer)
    Possible values:
| Value | Name |
|  --- | --- |
| 1 | Passed |
| 2 | Failed |

Example: 1
    Example: 1

  - `transactionDetails.transactionReceipt.avsResponse.result` (string)
    Indicates the AVS response result.
Valid values are:
| Value | Description |
|  --- | --- |
| Passed | All address data is correct. |
| Failed | Some address data is incorrect. |

Example: Passed
    Example: Passed

  - `transactionDetails.transactionReceipt.avsResponse.codeDescription` (string)
    Indicates the AVS response code description.

Example: Street Address and ZIP Code Match the information on file.
    Example: Street Address and ZIP Code Match the information on file.

  - `transactionDetails.transactionReceipt.emvTags` (object)
    Indicates the EMV (Europay, Mastercard, and Visa) tag data for the transaction.

  - `transactionDetails.transactionReceipt.emvTags.ac` (string)
    Indicates the EMV (Europay, Mastercard, and Visa) AC (application cryptogram).

Example: 4A2B6C8D0E1F2A3B
    Example: 4A2B6C8D0E1F2A3B

  - `transactionDetails.transactionReceipt.emvTags.tvr` (string)
    Indicates the EMV (Europay, Mastercard, and Visa) TVR (terminal verification results).

Example: 0000008000
    Example: 0000008000

  - `transactionDetails.transactionReceipt.emvTags.tsi` (string)
    Indicates the EMV (Europay, Mastercard, and Visa) TSI (transaction status information).

Example: 6800
    Example: 6800

  - `transactionDetails.transactionReceipt.emvTags.aid` (string)
    Indicates the EMV (Europay, Mastercard, and Visa) AID (application identifier).

Example: A0000000031010
    Example: A0000000031010

  - `transactionDetails.transactionReceipt.emvTags.applicationLabel` (string)
    Indicates the cardholder-visible EMV (Europay, Mastercard, and Visa) application label.

Example: VISA CREDIT
    Example: VISA CREDIT

  - `transactionDetails.transactionReceipt.emvTags.rawTags` (array)
    Raw EMV (Europay, Mastercard, and Visa) tag data, as key-value pairs.

  - `transactionDetails.transactionReceipt.emvTags.rawTags.key` (string)
    Indicates the key of the key-value pair.

Example: 9F26
    Example: 9F26

  - `transactionDetails.transactionReceipt.emvTags.rawTags.value` (string)
    Indicates the value of the key-value pair.

Example: 4A2B6C8D0E1F2A3B
    Example: 4A2B6C8D0E1F2A3B

  - `transactionDetails.transactionReceipt.orderNumber` (string)
    Indicates the order number associated with the transaction.

Example: ORD-10293
    Example: ORD-10293

  - `transactionDetails.id` (string)
    Indicates the transaction identifier.

Example: 0e0034bd-028f-4809-b185-f4cca086eb33
    Example: 0e0034bd-028f-4809-b185-f4cca086eb33

  - `transactionDetails.paymentProcessorId` (string)
    Specifies the payment processor identifier.

Example: 2059fcc1-5507-42be-8e4c-f4fcce245027
    Example: 2059fcc1-5507-42be-8e4c-f4fcce245027

  - `transactionDetails.date` (string)
    Indicates the date of the transaction (in an ISO 8601 date-time UTC format).

Examples: 2025-01-27T12:05:54.322587Z
    Example: 2025-01-27T12:05:54.322587Z

  - `transactionDetails.amount` (object)
    Indicates the amounts for the transaction.

  - `transactionDetails.amount.baseAmount` (number)
    Identifies the original amount (in USD) of a transaction before adjustments are applied.
Example: 129.99 (for $129.99)
    Example: 129.99

  - `transactionDetails.amount.percentageOffAmount` (number)
    Identifies the discount amount (in USD) taken off.
This discount was calculated using the preset percentage from `percentageOffRate`.
Example: 12.50 (for $12.50)
    Example: 12.5

  - `transactionDetails.amount.percentageOffRate` (number)
    Identifies the discount percentage.
This value is percentage rate for the discount.
This discount percentage calculates the discount amount for `percentageOffAmount`.
Example: 3.5 (as 3.5%)
    Example: 3.5

  - `transactionDetails.amount.cashDiscountAmount` (number)
    Identifies the discount amount (in USD) when a cash (or cash-equivalent) discount is applied.
This discount was calculated using the preset percentage from `cashDiscountRate`.
Example: 10.55 (for $10.55)
    Example: 10.55

  - `transactionDetails.amount.cashDiscountRate` (number)
    Identifies the discount percentage for a cash (or cash-equivalent) discount.
This value is percentage rate for the discount.
This discount percentage calculates the discount amount for `cashDiscountAmount`.
Example: 1.5 (as 1.5%)
    Example: 1.5

  - `transactionDetails.amount.cashDiscountPercentage` (number)
    Identifies the discount percentage for a cash (or cash-equivalent) discount.
This value is percentage rate for the discount.
This discount percentage calculates the discount amount for `cashDiscountAmount`.
Example: 1.5 (as 1.5%)
    Example: 1.5

  - `transactionDetails.amount.surchargeAmount` (number)
    Identifies the amount (in USD) when a surcharge is applicable.
This is a surcharge on the base amount.
This surcharge was calculated using the preset percentage from `surchargeRate`.
Example: 6.45 (for $6.45)
    Example: 6.45

  - `transactionDetails.amount.surchargeRate` (number)
    Identifies the surcharge percentage.
This is a surcharge on the base amount.
This value is surcharge percentage rate.
This surcharge percentage calculates the surcharge amount for `surchargeAmount`.
Example: 1.5 (as 1.5%)
    Example: 1.5

  - `transactionDetails.amount.tipAmount` (number)
    Specifies the absolute amount (in USD) of the tip to be added.
This amount adds to the base amount of the original transaction.
That transaction must be authorized first.

Values for `tipAmount` and `tipRate` are mutually exclusive.
Care must be taken to include one or the other but not both.
Example: 14.50 (for $14.50)
    Example: 14.5

  - `transactionDetails.amount.tipRate` (number)
    Specifies the tip rate as a percentage of the base amount to be added.
This amount adds to the base amount of the original transaction.
That transaction must be authorized first.

Values for `tipAmount` and `tipRate` are mutually exclusive.
Care must be taken to include one or the other but not both.
Example: 15 (as 15%)
    Example: 15

  - `transactionDetails.amount.taxAmount` (number)
    Identifies the tax amount (in USD).
Example: 273.65 (for $273.65)
    Example: 273.65

  - `transactionDetails.amount.taxRate` (number)
    Identifies the tax percentage.
Example: 8.50 (as 8.50%)
    Example: 8.5

  - `transactionDetails.amount.totalAmount` (number)
    Specifies the transaction's total amount.

This includes the base amount, tips, taxes, shipping, discounts, and other charges.

Example: 3219.45
    Example: 3219.45

  - `transactionDetails.currencyId` (integer)
    Indicates the currency identifier (in Flute currency code).
This value is set to *1*.
Example: 1
    Example: 1

  - `transactionDetails.currencyCode` (string)
    Indicates the currency (in ISO 4217 alpha-3 currency code format).

Example: USD
    Example: USD

  - `transactionDetails.createdBy` (string)
    Indicates the creator of the transaction.

  - `transactionDetails.merchant` (string)
    Indicates the merchant creating the transaction.

  - `transactionDetails.merchantId` (string)
    Indicates the merchant identifier of the transaction.

Example: fae7620d-ab02-4375-bc20-6ff326b917fd
    Example: fae7620d-ab02-4375-bc20-6ff326b917fd

  - `transactionDetails.processorId` (string)
    Indicates the processor identifier.

Example: 5e9018ff-dbbb-4ff4-8cde-b10579a3fcd9
    Example: 5e9018ff-dbbb-4ff4-8cde-b10579a3fcd9

  - `transactionDetails.processor` (string)
    Indicates the payment processor.
This is the system or company that handles the actual movement and authorization of payment transactions.
Examples:
TSYS
Fiserv
    Example: TSYS

  - `transactionDetails.operationMode` (string)
    Indicates the operation mode.
Possible values:
| OperationMode | Id |
|  --- | --- |
| PayNow | 1 |
| Subscription | 2 |

  - `transactionDetails.paymentMethodTypeId` (integer)
    Indicates the payment method type identifier.
Value values:
| Id | Name |
|  --- | --- |
| 1 | Card (for credit card) |
| 2 | ElectronicCheck |

Example: 2
    Example: 2

  - `transactionDetails.paymentMethodType` (string)
    Indicates the payment method type name.
Value values:
| Name | Id | Notes |
|  --- | --- | --- |
| Card | 1 | For credit or debit card |
| ElectronicCheck | 2 |  |

Example: Card
    Example: Card

  - `transactionDetails.paymentMethodName` (string)
    Indicates the name of the payment method.

This is a free-formed name that is convenient for the merchant to recognize.

Example: Cafe Peppared
    Example: Cafe Peppared

  - `transactionDetails.customerId` (string)
    Specifies the customer identifier.
This is used when saving the payment method.
If this value is provided, the payment method is saved to the specified customer.
If this value is not provided, a new customer record is created.
Example: fd9198a4-eb6f-4620-9603-4f4638289de5
    Example: fd9198a4-eb6f-4620-9603-4f4638289de5

  - `transactionDetails.customerName` (string)
    Indicates the customer's name.

Example: Jane Doe
    Example: Jane Doe

  - `transactionDetails.customerCompany` (string)
    Indicates the customer's company name.

Example: Peppared Street Cafe
    Example: Peppared Street Cafe

  - `transactionDetails.customerPan` (string)
    Indicates customer’s PAN (primary account number).
This is the payment card number.
The value is masked except for a few numbers for additional security.
Example: ************3655
    Example: ************3655

  - `transactionDetails.customerEmail` (string)
    Indicates the customer's email.
Example: peppared@example.com
    Example: peppared@example.com

  - `transactionDetails.customerPhone` (string)
    Indicates the customer's phone number.
Example: +14155552309
    Example: +14155552309

  - `transactionDetails.status` (string)
    Indicates the session status.

Example: Processing
    Example: Processing

  - `transactionDetails.statusId` (integer)
    Indicates the session status identifier.

Example: 1
    Example: 1

  - `transactionDetails.responseCode` (string)
    Indicates a response code regarding the transaction.

Example: 000
    Example: 000

  - `transactionDetails.responseMessage` (string)
    Indicates the message for the response code regarding the transaction.

  - `transactionDetails.responseDescription` (string)
    Indicates a free-formed description regarding the transaction.

Example: Command Successful. Approved.
    Example: Command Successful. Approved.

  - `transactionDetails.avsResponseCode` (string)
    Indicates the AVS (address verification service) response code returned by the card processor.

Example: Y
    Example: Y

  - `transactionDetails.availableStates` (array)
    Available states that the transaction can transition to.

  - `transactionDetails.refunded` (boolean)
    Indicates the transaction was refunded.
If `true`, transaction was refunded.
If `false`, transaction was not refunded.
Example: true
    Example: true

  - `transactionDetails.cardType` (string)
    Indicates the name of the credit card.
Example: Visa
    Example: Visa

  - `transactionDetails.typeId` (integer)
    Indicates the payment method type identifier.
Value values:
| Id | Name |
|  --- | --- |
| 1 | Card (for credit card) |
| 2 | ElectronicCheck |

Example: 1
    Example: 1

  - `transactionDetails.type` (string)
    Indicates the payment method type name.
Value values:
| Name | Id | Notes |
|  --- | --- | --- |
| Card | 1 | For credit or debit card |
| ElectronicCheck | 2 |  |

Example: Card
    Example: Card

  - `transactionDetails.creditDebitTypeId` (integer)
    Indicates the credit or debit type identifier.
Possible values:
| Int | Value |
|  --- | --- |
| 1 | Credit |
| 2 | Debit |
| 3 | Unknown |

  - `transactionDetails.creditDebitTypeType` (string)
    Indicates the credit or debit type.
Possible values:
| Value | Int |
|  --- | --- |
| Credit | 1 |
| Debit | 2 |
| Unknown | 3 |

  - `transactionDetails.authCode` (string)
    Indicates the authorization code returned by the card processor.

Example: 003772
    Example: 003772

  - `transactionDetails.mid` (string)
    Indicates the MID (merchant identifier) assigned to this transaction.

Example: 43252511
    Example: 43252511

  - `transactionDetails.tid` (string)
    Indicates the TID (terminal identifier) assigned to this transaction.

Example: 8820432549239101
    Example: 8820432549239101

  - `transactionDetails.referenceId` (string)
    Indicates the reference identifier for the transaction.

Example: REF-10293
    Example: REF-10293

  - `transactionDetails.availableOperations` (array)
    Available operations that can be performed on the transaction.

  - `transactionDetails.histories` (array)
    History of the transaction.

  - `transactionDetails.histories.id` (string)
    Indicates the transaction identifier.

Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
    Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7

  - `transactionDetails.histories.transactionDateTime` (string)
    Indicates the date-time (in an ISO 8601 date-time UTC format) of the invoice transaction.

Examples: 2026-02-19T20:24:52.934Z
    Example: 2026-02-19T20:24:52.934Z

  - `transactionDetails.histories.transactionAmount` (number)
    Indicates the amount of the transaction.

Example: 25.00
    Example: 25

  - `transactionDetails.histories.transactionTypeId` (integer)
    Indicates the transaction type identifier.
Possible values:
| Type | Value |
|  --- | --- |
| Authorization | 1 |
| Sale | 2 |
| Capture | 3 |
| Void | 4 |
| Refund | 5 |
| Verify | 6 |

Example: 5
    Example: 5

  - `transactionDetails.histories.transactionType` (string)
    Indicates the transaction type name.
Possible values:
| Value | Type |
|  --- | --- |
| Authorization | 1 |
| Sale | 2 |
| Capture | 3 |
| Void | 4 |
| Refund | 5 |
| Verify | 6 |

Example: Refund
    Example: Refund

  - `transactionDetails.histories.transactionStatusId` (integer)
    Indicates the Flute transaction status code.
Example: 2
    Example: 2

  - `transactionDetails.histories.transactionStatus` (string)
    Indicates the Flute transaction status type.
Example: Captured
    Example: Captured

## Response 404:

  - `404` (unknown)
    Resource not found

## Response 404 fields (application/json):

  - `details` (string)
    Indicates details about the error.

Example: Entity with ID 'aa6cfcd0-0295-4a4c-b074-8c901f114fef' was not found.
    Example: Entity with ID 'aa6cfcd0-0295-4a4c-b074-8c901f114fef' was not found.

  - `statusCode` (integer)
    Specifies the HTTP response status code.
This is the HTTP status code returned by the attempted delivery.
The following is a list of HTTP response status codes that include but are not limited to:
| HTTP Status | Meaning |
|  --- | --- |
| 200 | Delivery succeeded |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Endpoint not found |
| 429 | Rate limited |

Example: 401
    Example: 401

  - `source` (string)
    Indicates the source of the error.

Example: FluteOpsDeveloper.MSG322
    Example: FluteOpsDeveloper.MSG322

  - `exceptionType` (string)
    Indicates the error's exception type.

Example: System.Collections.Generic.KeyNotFoundException
    Example: System.Collections.Generic.KeyNotFoundException

  - `correlationId` (string)
    Indicates the correlation identifier.

Example: aa6cfcd0-0295-4a4c-b074-8c901f114fef
    Example: aa6cfcd0-0295-4a4c-b074-8c901f114fef

  - `entityId` (string)
    Indicates the entity identifier.
Example:
null

  - `errorCode` (string)
    Indicates the error code.
Example:
null

## Response 500:

  - `500` (unknown)
    Internal Error

## Response 500 fields (application/json):

  - `details` (string)
    Indicates details about the error.

Example: An unexpected error occurred while processing the request.
    Example: An unexpected error occurred while processing the request.

  - `statusCode` (integer)
    Specifies the HTTP response status code.
This is the HTTP status code returned by the attempted delivery.
The following is a list of HTTP response status codes that include but are not limited to:
| HTTP Status | Meaning |
|  --- | --- |
| 200 | Delivery succeeded |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Endpoint not found |
| 429 | Rate limited |

Example: 401
    Example: 401

  - `source` (string)
    Indicates the source of the error.
Example: <Service>
    Example: (Service)

  - `exceptionType` (string)
    Indicates the error's exception type.

Example: System.Exception
    Example: System.Exception

  - `correlationId` (string)
    Indicates the correlation identifier.

Example: aa6cfcd0-0295-4a4c-b074-8c901f114fef
    Example: aa6cfcd0-0295-4a4c-b074-8c901f114fef

  - `entityId` (string)
    Indicates the entity identifier.
Example:
null

  - `errorCode` (string)
    Indicates the error code.
Example:
null

