Skip to main content
GET
/
ecommerce
/
transactions
/
{id}
Get Transaction
curl --request GET \
  --url https://api.rootfi.dev/v4/ecommerce/transactions/{id} \
  --header 'api_key: <api-key>'
{
  "rootfi_id": 8001,
  "rootfi_deleted_at": null,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "pay_shopify_001",
  "type": "PAYMENT",
  "order_id": "ord_shopify_001",
  "contact_id": "cus_001",
  "currency_id": "USD",
  "amount": 97.19,
  "status": "PAID",
  "payment_method_type": "CARD",
  "gateway": "shopify_payments",
  "gateway_transaction_id": "gid://shopify/Transaction/12345",
  "original_transaction_id": null,
  "description": "Payment for order ORD-2024-001",
  "reason": null,
  "created_at": "2024-01-22T05:07:31.465Z",
  "updated_at": "2024-01-22T05:07:31.000Z"
}
Retrieve a specific transaction by its ID. Transactions represent all monetary movements including payments, refunds, chargebacks, and adjustments.

​
Path Parameters

ParameterTypeRequiredDescription
idstringYesThe rootfi_id or platform_id of the transaction to retrieve

Authorizations

​
api_key
string
header
required

Path Parameters

​
id
string
required

The rootfi_id or platform_id of the transaction

Response

V4 Transaction object - unified model for payments, refunds, and chargebacks

​
rootfi_id
number<double>
required

The unique ID we assign for that data's information

Example:

157

​
rootfi_created_at
string<date-time>
required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

​
rootfi_updated_at
string<date-time>
required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

​
rootfi_company_id
number<double>
required

The ID of the company in the accounting platform

Example:

1089

​
platform_id
string
required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

​
rootfi_deleted_at
string<date-time> | null

The date at which the data was deleted in the accounting platform

​
platform_unique_id
string | null

The ID of the data in the accounting platform.

​
raw_data
object

A JSON containing fields that you can directly get from the accounting platform.

​
data_hash
string | null

The hash of the data

​
type
enum<string> | null

Type of transaction (PAYMENT, REFUND, CREDIT_NOTE, etc.)

Available options:
PAYMENT,
REFUND,
CREDIT_NOTE,
FEE,
CHARGEBACK,
PAYOUT,
ADJUSTMENT
​
order_id
string | null

Reference to the associated Order

​
contact_id
string | null

Reference to the Contact

​
currency_id
string | null

ISO 4217 currency code (e.g., "USD", "EUR")

​
amount
number<double> | null

Transaction amount (always positive, use type to determine direction)

​
status
enum<string> | null

Current status of the transaction

Available options:
DRAFT,
REQUIRES_ACTION,
PENDING,
AUTHORIZED,
PAID,
FAILED,
CANCELED,
REFUNDED
​
payment_method_type
enum<string> | null

Payment method used for this transaction

Available options:
CARD,
BANK_TRANSFER,
WIRE_TRANSFER,
PAYPAL,
APPLE_PAY,
GOOGLE_PAY,
CHECK,
CASH,
CRYPTO,
OTHER,
UNKNOWN
​
gateway
string | null

Payment processor or gateway name (e.g., "shopify", "stripe")

​
gateway_transaction_id
string | null

Transaction ID from the payment gateway

​
original_transaction_id
string | null

For refunds, reference to the original payment transaction

​
description
string | null

Human-readable description of the transaction

​
reason
enum<string> | null

Standardized reason code for the transaction (primarily used for refunds, credit notes, and disputes)

Available options:
CUSTOMER_REQUEST,
DUPLICATE,
FRAUD,
QUALITY_ISSUE,
BILLING_ERROR,
LOYALTY_DISCOUNT,
PROMOTIONAL,
ADJUSTMENT,
OTHER
​
created_at
string | null

Original transaction timestamp from platform (ISO 8601)

​
updated_at
string | null

Last update timestamp from platform (ISO 8601)