---
title: "Retrieve transaction"
method: GET
path: "/transactions/{transactionId}"
tags: ["Settlement"]
---

# Retrieve transaction

`GET /transactions/{transactionId}`

Use this method to retrieve information about a transaction.  

**Note:** To retrieve a transaction, you need its transactionId. If you don't have the transactionId, use our [List Transactions](https://docs.payroc.com/api/schema/reporting/settlement/list-transactions) method to search for the transaction.  

Our gateway returns the following information about the transaction:  

-	Merchant and processing account that ran the transaction.  
-	Transaction type, date, amount, and the payment method that the customer used.  
-	Batch that contains the transaction, and authorization details for the transaction.   
-	Processor that settled the transaction and the ACH deposit containing the transaction.

## Path parameters

- `transactionId` integer, required

## Headers

- `Authorization` string, required

## Response `200`

Successful request. Returns the requested transaction.

- Transaction — Object that contains information about the transaction.
  - `transactionId` integer, nullable — Unique identifier that we assigned to the transaction.
  - `type` 'capture' | 'return' — Indicates the type of transaction. The value is one of the following: - `capture` - Transaction is a sale. - `return` - Transaction is a refund.
  - `date` string, date — Date of the transaction. The format of this value is **YYYY-MM-DD**.
  - `amount` integer — Transaction amount. We return the value in the currency's lowest denomination, for example, cents.
  - `entryMethod` 'barcodeRead' | 'smartChipRead' | 'swipedOriginUnknown' | 'contactlessChip' | 'ecommerce' | 'manuallyEntered' | 'manuallyEnteredFallback' | 'swiped' | 'swipedFallback' | 'swipedError' | 'scannedCheckReader' | 'credentialOnFile' | 'unknown' — Indicates how the merchant received the payment details.
  - `createdDate` string, date — Date that we received the transaction. The format of this value is **YYYY-MM-DD**.
  - `lastModifiedDate` string, date — Date that the transaction was last changed. The format of this value is **YYYY-MM-DD**.
  - `status` 'fullSuspense' | 'heldAudited' | 'heldReleasedAudited' | 'holdForSettlement30Days' | 'holdForSettlementDuplicate' | 'holdLongTerm' | 'paid' | 'paidByThirdParty' | 'partialRelease' | 'pull' | 'release' | 'new' | 'held' | 'unknown' — Indicates the status of the transaction. The value is one of the following: - `fullSuspense` – Merchant ran the transaction while their account was in full suspense. - `heldAudited` – We have moved a transaction from fullSuspense and placed it on hold. - `heldReleasedAudited` – We audited and released the transaction that we had previously held. - `holdForSettlement30Days` - We are holding the transaction for a maximum of 30 days. - `holdForSettlementDuplicate` - We held the transaction because the transaction may be a duplicate. - `holdLongTerm` - We are holding the transaction for an extended period. - `paid` – We have paid the transaction funds to the merchant. - `paidByThirdParty` - A third party has paid the transaction funds to the merchant. - `partialRelease` – We partially released the transaction funds. - `pull` - We pulled the transaction, and the merchant does not receive funds for the transaction. - `release` - We released the transaction that we previously held. - `new` – We have prepared the funds from the transaction to send to the merchant. - `held` – We held the transaction. - `unknown` – No transaction status available.
  - `cashbackAmount` integer — Cashback amount. We return the value in the currency's lowest denomination, for example, cents.
  - `interchange` TransactionInterchange — Object that contains information about the interchange fees for the transaction.
    - `basisPoint` integer — Interchange basis points that we apply to the transaction.
    - `transactionFee` integer — Interchange fee for the transaction. We return the value in the currency's lowest denomination, for example, cents.
  - `currency` string — Currency of the transaction. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.
  - `merchant` MerchantSummary — Object that contains information about the merchant.
    - `merchantId` string — Unique identifier that the processor assigned to the merchant.
    - `doingBusinessAs` string — Trading name of the business.
    - `processingAccountId` integer — Unique identifier that we assigned to the processing account.
    - `link` Link — Object that contains HATEOAS links for the resource.
      - `rel` string, required — Indicates the relationship between the current resource and the target resource.
      - `method` string, required — HTTP method that you need to use with the target resource.
      - `href` string, required — URL of the target resource.
  - `settled` SettledSummary — Object that contains information about the settlement.
    - `settledBy` string — Processor that settled the transaction.
    - `achDate` string, date — Date that the processor settled the transaction. The format of this value is **YYYY-MM-DD**.
    - `achDepositId` integer — Unique identifier of the ACH deposit.
    - `link` Link — Object that contains HATEOAS links for the resource.
      - `rel` string, required — Indicates the relationship between the current resource and the target resource.
      - `method` string, required — HTTP method that you need to use with the target resource.
      - `href` string, required — URL of the target resource.
  - `batch` BatchSummary — Object that contains information about the batch. If we can't match a dispute to a batch, we don't return 'batch' object.
    - `batchId` integer — Unique identifier of the batch.
    - `date` string, date — Date that the merchant submitted the batch.
    - `cycle` string — Indicates the cycle that contains the batch.
    - `link` Link — Object that contains HATEOAS links for the resource.
      - `rel` string, required — Indicates the relationship between the current resource and the target resource.
      - `method` string, required — HTTP method that you need to use with the target resource.
      - `href` string, required — URL of the target resource.
  - `card` CardSummary — Object that contains information about the card.
    - `cardNumber` string — Masked card number. Our gateway shows only the first six digits and the last four digits of the card number, for example, `500165******0000`.
    - `type` 'visa' | 'masterCard' | 'discover' | 'debit' | 'ebt' | 'wrightExpress' | 'voyager' | 'amex' | 'privateLabel' | 'storedValue' | 'discoverRetained' | 'jcbNonSettled' | 'dinersClub' | 'amexOptBlue' | 'fuelman' | 'unknown' — Card type, for example, Visa. **Note:** If we can’t match a dispute to a transaction, we don’t return a type object.
    - `cvvPresenceIndicator` boolean — Indicates whether the cardholder provided the Card Verification Value (CVV).
    - `avsRequest` boolean — Indicates whether the merchant used the Address Verification Service (AVS) to verify the cardholder's address.
    - `avsResponse` string — Response from the Address Verification Service (AVS).
  - `authorization` AuthorizationSummary — Object that contains information about the authorization.
    - `authorizationId` integer — Unique identifier of the authorization.
    - `code` string — Authorization code. **Note:** For returns, the card brands may not provide an authorization code.
    - `amount` integer — Authorization amount. We return the value in the currency's lowest denomination, for example, cents.
    - `avsResponseCode` string — Response code that indicates if the address matches the address registered to the customer.
    - `link` Link — Object that contains HATEOAS links for the resource.
      - `rel` string, required — Indicates the relationship between the current resource and the target resource.
      - `method` string, required — HTTP method that you need to use with the target resource.
      - `href` string, required — URL of the target resource.

## Other responses

- `400` — Validation error
- `401` — Identity could not be verified
- `403` — Do not have permissions to perform this action
- `404` — Resource not found
- `406` — Not acceptable
- `500` — An error has occured

---

[API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)
