Skip to content

Ramp: Fetch a transaction — response body

Fetch a transaction: response body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Fetch a transaction — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_categoriesarrayOptional[Deprecated - use accounting_field_selections instead] Accounting categories related to the transaction.
Read only: true
accounting_categories[]ModelEach itemExpand Fetch a transaction — response body — accounting categories item
accounting_dateJSONRequired within parent
accounting_date (anyOf 1)stringAlternativeThe date for the transaction for accounting purposes, in ISO8601 format. Based on the cleared date, transaction date, or a manually overridden date, depending on your accounting preferences in Ramp.
Format: date-time
Read only: true
accounting_date (anyOf 2)nullAlternative
accounting_field_selectionsarrayOptionalList of accounting fields selected to code the transaction.
accounting_field_selections[]ModelEach itemExpand Fetch a transaction — response body — accounting field selections item
all_requirements_met_and_approvedbooleanRequired within parentWhether the transaction is fully approved and all cardholder requirements are met, including receipts, memos, and tracking categories.
Read only: true
amountJSONOptional
amount (anyOf 1)numberAlternativeDeprecated. Use `entity_amount`.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
attendeesarrayOptionalList of attendees for the transaction
attendees[]ModelEach itemExpand Fetch a transaction — response body — attendees item
card_holderModelOptionalExpand Fetch a transaction — response body — card holder
Information about the card holder.
card_idstringOptionalIdentifier of the physical or virtual card associated with the transaction.
Format: uuid
card_presentbooleanRequired within parentWhether the transaction was processed using a card present terminal.
currency_codestringOptionalDeprecated. Use `entity_amount.currency`.
decline_detailsModelOptionalExpand Fetch a transaction — response body — decline details
Details about a transaction decline.
disputesarrayOptionalA list of disputes sorted in descending order by their creation time.
Read only: true
disputes[]ModelEach itemExpand Fetch a transaction — response body — disputes item
entity_amountJSONRequired within parent
entity_amount (anyOf 1)ModelAlternativeExpand Fetch a transaction — response body — entity amount currency, value
The amount that settled to the entity, in the entity’s settlement currency. The value is in the smallest denomination of the currency (e.g. cents for USD) and is signed: refunds and credits can be negative. Null when the transaction has no valid settlement currency recorded.
Read only: true
entity_amount (anyOf 2)nullAlternative
entity_idJSONRequired within parent
entity_id (anyOf 1)stringAlternativeUnique identifier of business entity associated with the transaction.
Format: uuid
entity_id (anyOf 2)nullAlternative
fund_idstringOptionalUnique identifier of the fund associated with the transaction. Returns the same value as `limit_id`.
Format: uuid
Read only: true
idstringOptionalFormat: uuid
limit_idstringOptionalAlias of fund (`fund_id`). Unique identifier of the spend limit associated with the transaction. Returns the same value as `fund_id`.
Format: uuid
line_itemsarrayOptionalList of line items related to the transaction.
line_items[]ModelEach itemExpand Fetch a transaction — response body — line items item
memoJSONOptional
memo (anyOf 1)stringAlternative
memo (anyOf 2)nullAlternative
merchant_amountJSONRequired within parent
merchant_amount (anyOf 1)ModelAlternativeExpand Fetch a transaction — response body — entity amount currency, value
The original amount charged by the merchant, in the currency the merchant charged. The value is in the smallest denomination of that currency (e.g. cents) and is signed: refunds and credits can be negative. Equal to `entity_amount` when no currency conversion occurred. Null when the original amount data is unavailable or invalid.
Read only: true
merchant_amount (anyOf 2)nullAlternative
merchant_category_codestringOptionalMerchant category code is a four-digit number in ISP 18245 used to classify a business by the types of goods and services it provides.
merchant_category_code_descriptionstringOptionalDescription about the merchant category code.
merchant_dataModelOptionalExpand Fetch a transaction — response body — merchant data
Purchase data associated related to a transaction provided by the merchant
merchant_descriptorstringOptionalA merchant descriptor is the name that appears on a customer’s bank statement when they make a purchase from that merchant.
merchant_idJSONRequired within parent
merchant_id (anyOf 1)stringAlternativeFormat: uuid
merchant_id (anyOf 2)nullAlternative
merchant_locationJSONRequired within parent
merchant_location (anyOf 1)ModelAlternativeExpand Fetch a transaction — response body — merchant location city, country, postal code, state
Card acceptor data such as country, city, state, and postal code if available.
merchant_location (anyOf 2)nullAlternative
merchant_nameJSONOptional
merchant_name (anyOf 1)stringAlternativeRead only: true
merchant_name (anyOf 2)nullAlternative
minor_unit_conversion_rateJSONRequired within parent
minor_unit_conversion_rate (anyOf 1)JSONAlternative
minor_unit_conversion_rate (anyOf 1) (anyOf 1)integerAlternativeThe conversion factor to convert from the integer amount to the actual currency value. Divide amount by this value to get the real currency amount. For USD, this is 100 (e.g., 12034 / 100 = 120.34 USD).
Read only: true
minor_unit_conversion_rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minor_unit_conversion_rate (anyOf 2)nullAlternative
network_merchant_idJSONRequired within parent
network_merchant_id (anyOf 1)stringAlternativeNetwork merchant identifier from the card acceptor.
Read only: true
network_merchant_id (anyOf 2)nullAlternative
original_transaction_amountJSONRequired within parent
original_transaction_amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
the original transaction amount before the currency conversion.
original_transaction_amount (anyOf 2)nullAlternative
original_transaction_idJSONRequired within parent
original_transaction_id (anyOf 1)stringAlternativeOriginal transaction id for refund transactions.
Read only: true
original_transaction_id (anyOf 2)nullAlternative
policy_violationsarrayOptionalA list of policy violations sorted in descending order by their creation time.
Read only: true
policy_violations[]ModelEach itemExpand Fetch a transaction — response body — policy violations item
receipt_affidavitJSONOptional
receipt_affidavit (anyOf 1)stringAlternativeRead only: true
receipt_affidavit (anyOf 2)nullAlternative
receiptsarrayOptionalReceipts listed in ascending order by their creation time, related to the transaction.
Read only: true
receipts[]stringEach itemFormat: uuid
requires_accounting_vendor_creation_to_syncbooleanOptionalWhether the integrator must create an accounting vendor and code it to this transaction before syncing. True when the connection has transaction_accounting_vendor_creation_on_sync_enabled=true and the transaction has no vendor accounting field selection. Omitted when transaction_accounting_vendor_creation_on_sync_enabled=false.
Read only: true
settlement_datestringOptionalTime when funds were moved for a transaction, in ISO8601 format.
Format: date-time
sk_category_idJSONRequired within parent
sk_category_id (anyOf 1)JSONAlternative
sk_category_id (anyOf 1) (anyOf 1)integerAlternativeRamp category code.
Known values: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9
Read only: true
sk_category_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sk_category_id (anyOf 2)nullAlternative
sk_category_nameJSONRequired within parent
sk_category_name (anyOf 1)stringAlternativeRamp category name.
Read only: true
sk_category_name (anyOf 2)nullAlternative
spend_program_idstringOptionalUnique identifier of the spend program from which this limit was issued.
Format: uuid
statestringOptionaltransaction state.
Known values: ALL, CLEARED, COMPLETION, DECLINED, ERROR, PENDING, PENDING_INITIATION
statement_idstringOptionalStatement ID associated with the transaction if one is available.
Format: uuid
sync_statusstringRequired within parentKnown values: NOT_SYNC_READY, SYNCED, SYNC_READY
Read only: true
synced_atJSONRequired within parent
synced_at (anyOf 1)stringAlternativeTime when transaction has been synced, in ISO8601 format. Will be None if the transaction is not synced.
Format: date-time
synced_at (anyOf 2)nullAlternative
trip_idJSONRequired within parent
trip_id (anyOf 1)stringAlternativeTrip ID associated with the transaction if one is available.
Format: uuid
trip_id (anyOf 2)nullAlternative
trip_nameJSONRequired within parent
trip_name (anyOf 1)stringAlternativeTrip name associated with the transaction if one is available.
trip_name (anyOf 2)nullAlternative
updated_atJSONRequired within parent
updated_at (anyOf 1)stringAlternativeApproximate transaction updated timestamp used by the `updated_after` filter. Computed as the latest of user transaction time, settlement time, and transaction interaction state update time.
Format: date-time
Read only: true
updated_at (anyOf 2)nullAlternative
user_transaction_timestringOptionalTime when the transaction was created by the user, in ISO8601 format.
Format: date-time

Referenced models: Fetch a transaction — response body — accounting categories item, Fetch a transaction — response body — merchant location city, country, postal code, state, Fetch a transaction — response body — attendees item, Fetch a transaction — response body — card holder, Fetch a transaction — response body — disputes item, Fetch a transaction — response body — policy violations item, Fetch a transaction — response body — entity amount currency, value, Fetch a transaction — response body — accounting field selections item, Fetch a transaction — response body — decline details, Fetch a transaction — response body — line items item, Fetch a transaction — response body — merchant data, Hold Bill — response body — amount

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.