Settlement

Retrieve transaction

Changed on

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 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.
get/transactions/{transactionId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/transactions/{transactionId}
  • Auth
    HTTP bearer

Path parameters

transactionIdinteger required

Unique identifier of the transaction.

Response

Successful request. Returns the requested transaction.

transactionIdinteger 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.
datestring date

Date of the transaction. The format of this value is YYYY-MM-DD.

amountinteger

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.

createdDatestring date

Date that we received the transaction. The format of this value is YYYY-MM-DD.

lastModifiedDatestring 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.
cashbackAmountinteger

Cashback amount. We return the value in the currency's lowest denomination, for example, cents.

currencystring

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id retrieveTransaction removed and replaced with settlement_retrieveTransaction