Skip to content

Ramp: Transaction schemas

26 Ramp schemas with complete fields and constraints.

← Transaction operations · All schemas

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

Fetch a transaction — response body — accounting categories item

FieldTypePresenceDescription and constraints
$objectRoot
category_idstringOptionalUser-selected category id for transaction.
category_namestringOptionalUser-selected category name for transaction.
tracking_category_remote_idstringOptional
tracking_category_remote_namestringOptional
tracking_category_remote_typestringOptional

Fetch a transaction — response body — accounting field selections item

FieldTypePresenceDescription and constraints
$objectRoot
category_infoModelOptionalExpand Fetch a transaction — response body — accounting field selections item category info
Information about the accounting category (or accounting field).
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeCustomer-set display name for the accounting field option in Ramp. When the customer renames an option inside Ramp, this returns the new label while `name` continues to return the ERP-source name. May be null if no Ramp-side override is set.
display_name (anyOf 2)nullAlternative
external_codestringOptionalExternal code of accounting field option; Code field displayed on the ERP.
external_idstringOptionalExternal ID of accounting field option; It should uniquely identify an accounting field option on the ERP.
idstringOptionalID that uniquely identifies an accounting field option within Ramp
Format: uuid
namestringOptionalName of accounting field option
provider_namestringRequired within parentName of accounting field provider
Read only: true
sourceModelOptionalExpand Fetch a transaction — response body — accounting field selections item source
Describes the source of the accounting coding selection.
typestringOptionalAccounting field type
Known values: AMORTIZATION_TEMPLATE, BILLABLE, COST_CENTER, CUSTOMERS_JOBS, DEFERRAL_CODE, EXPENSE_ENTITY, GL_ACCOUNT, INVENTORY_ITEM, JOURNAL, MERCHANT, NON_ERP, OTHER, PAYROLL_PROVIDER, PROJECT, REPORTING_TAG, SALES_TAX_CODE, SUBSIDIARY, TAX_CODE, UNIT_OF_MEASURE

Referenced models: Fetch a transaction — response body — accounting field selections item source, Fetch a transaction — response body — accounting field selections item category info

Fetch a transaction — response body — accounting field selections item category info

FieldTypePresenceDescription and constraints
$objectRoot
external_idstringOptionalExternal ID of accounting field; It should uniquely identify an accounting field on the ERP.
idstringOptionalID that uniquely identifies an accounting field within Ramp
Format: uuid
namestringOptionalName of accounting field
typestringOptionalAccounting field type
Known values: AMORTIZATION_TEMPLATE, BILLABLE, COST_CENTER, CUSTOMERS_JOBS, DEFERRAL_CODE, EXPENSE_ENTITY, GL_ACCOUNT, INVENTORY_ITEM, JOURNAL, MERCHANT, NON_ERP, OTHER, PAYROLL_PROVIDER, PROJECT, REPORTING_TAG, SALES_TAX_CODE, SUBSIDIARY, TAX_CODE, UNIT_OF_MEASURE

Fetch a transaction — response body — accounting field selections item source

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalDescribes the type of source that added this selection.

Fetch a transaction — response body — attendees item

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentFull name of the attendee
user_idJSONRequired within parent
user_id (anyOf 1)stringAlternativeUser ID of the attendee, if linked to a Ramp user. Missing if the attendee is not a Ramp user
Format: uuid
user_id (anyOf 2)nullAlternative

Fetch a transaction — response body — card holder

FieldTypePresenceDescription and constraints
$objectRoot
department_idstringOptionalID of the card holder's department.
Format: uuid
department_namestringOptionalName of the card holder's deparment.
employee_idstringOptionalUser-defined employee ID of the card holder.
first_namestringOptionalCard holder's first name.
last_namestringOptionalCard holder's last name.
location_idstringOptionalID of the card holder's location.
Format: uuid
location_namestringOptionalName of the card holder's location.
user_idstringOptionalCard holder's ID.
Format: uuid

Fetch a transaction — response body — decline details

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONOptional
amount (anyOf 1)numberAlternativeDeclined amount, denominated in the transaction's settlement currency (the transaction's `currency_code`).
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
declined_amountJSONRequired within parent
declined_amount (anyOf 1)ModelAlternativeExpand Fetch a transaction — response body — entity amount currency, value
Declined amount with its currency. The currency is the transaction's settlement currency (matches the transaction's `currency_code`). The value is signed: declined refunds/credits can be negative. Null when the transaction has no valid settlement currency recorded; the bare `amount` field always carries the raw value.
declined_amount (anyOf 2)nullAlternative
reasonstringOptionalKnown values: AUTHORIZER, AUTHORIZER_AP_CARD_VELOCITY_LIMIT, AUTHORIZER_BUSINESS_LIMIT, AUTHORIZER_BUSINESS_SUSPENDED, AUTHORIZER_BUSINESS_VENDOR_BLACKLIST, AUTHORIZER_CARD_AUTO_LOCK_DATE, AUTHORIZER_CARD_CATEGORY_BLACKLIST, AUTHORIZER_CARD_CATEGORY_WHITELIST, AUTHORIZER_CARD_LIMIT, AUTHORIZER_CARD_MCC_BLACKLIST, AUTHORIZER_CARD_MISSING_POLICY_ITEMS, AUTHORIZER_CARD_NOT_ACTIVATED, AUTHORIZER_CARD_NOT_FOUND, AUTHORIZER_CARD_PARTIALLY_ACTIVATED, AUTHORIZER_CARD_START_DATE, AUTHORIZER_CARD_SUSPENDED, AUTHORIZER_CARD_TASK_SANCTION, AUTHORIZER_CARD_TOTAL_ACTIVATION_REQUIRED, AUTHORIZER_CARD_VENDOR_BLACKLIST, AUTHORIZER_CARD_VENDOR_WHITELIST, AUTHORIZER_COMMANDO_MODE, AUTHORIZER_FRAUD, AUTHORIZER_FREEZE_TRANSACTIONS_RISK, AUTHORIZER_GLOBAL_MCC_BLACKLIST, AUTHORIZER_MEMBER_LIMIT, AUTHORIZER_NON_AP_CARD_VELOCITY_LIMIT, AUTHORIZER_OOB_BLOCKED_MERCHANT, AUTHORIZER_OOB_DAILY_BUSINESS_BALANCE, AUTHORIZER_OOB_DAILY_CARD_SPEND, AUTHORIZER_RAMP_AUTHORIZATION_METHODS, AUTHORIZER_RAMP_TRANSACTION_AMOUNT_LIMIT, AUTHORIZER_RAMP_VENDOR_RESTRICTIONS, AUTHORIZER_SPEND_ALLOCATION_ARCHIVED_FUNDS, AUTHORIZER_SPEND_ALLOCATION_MEMBER_SUSPENDED, AUTHORIZER_SPEND_ALLOCATION_SUSPENDED, AUTHORIZER_TRANSACTION_AMOUNT_LIMIT, AUTHORIZER_UNAUTHORIZED_USER, AUTHORIZER_UNDER_TRANSACTION_AMOUNT_LIMIT, AUTHORIZER_USER_LIMIT, AUTHORIZER_USER_SUSPENDED, BLOCKED_COUNTRY, CARD_EXPIRED, CARD_LOST_OR_STOLEN, CARD_TERMINATED, CHIP_FAILURE, FORBIDDEN_CATEGORY, INSECURE_AUTHORIZATION_METHOD, INSUFFICIENT_FUNDS, INVALID_PIN, MISSING_CVV, MISSING_EXPIRATION, MOBILE_WALLET_FAILURE, MOBILE_WALLET_TOKEN_NOT_FOUND, MOBILE_WALLET_TOKEN_TERMINATED, NETWORK_DECLINE_ACCOUNT_VERIFICATION, NETWORK_DECLINE_ADVICE, NETWORK_DECLINE_ADVICE_ACQUIRER_ISSUE, NETWORK_DECLINE_ADVICE_ADDITIONAL_AUTHENTICATION_REQUIRED, NETWORK_DECLINE_ADVICE_FORCED_STIP_BY_ISSUER, NETWORK_DECLINE_ADVICE_ISSUER_LOGGED_OFF, NETWORK_DECLINE_ADVICE_ISSUER_TIMEOUT, NETWORK_DECLINE_ADVICE_ISSUER_UNAVAILABLE, NETWORK_DECLINE_ADVICE_PIN_ERROR, NETWORK_DECLINE_ADVICE_RECURRING_PAYMENT, NETWORK_DECLINE_ADVICE_SELECTIVE_ACCEPTANCE_SERVICE, NETWORK_DECLINE_ADVICE_SUSPECTED_FRAUD_TRANSACTION, NETWORK_DECLINE_ADVICE_TOKEN_PROVISIONING_SERVICE, NETWORK_DECLINE_ADVICE_VISA_PAYMENT_CONTROLS_RULE, NOT_ACTIVE, NOT_ALLOWED, NO_AUTO_ROUTED_LIMITS_AVAILABLE, NO_LINKED_SPEND_ALLOCATION, OFAC_VERIFICATION_NEEDED, OPEN_TO_BUY_LIMIT, OTHER, PIN_BLOCKED, PIN_TRY_LIMIT_EXCEEDED, PROCESSOR_CAP, QUASI_CASH, ROUTED_TO_TERMINATED_SPEND_ALLOCATION, STRIPE_WEBHOOK_TIMEOUT, SUSPECTED_BIN_ATTACK, SUSPECTED_FRAUD, THREE_D_SECURE_REQUIRED, USER_BLOCKED, USER_TERMINATED, WRONG_ADDRESS, WRONG_CVV, WRONG_EXPIRATION, WRONG_POSTAL_CODE

Referenced models: Fetch a transaction — response body — entity amount currency, value

Fetch a transaction — response body — disputes item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalTime at which the dispute is created, presented in ISO8601 format.
Format: date-time
idstringOptionalUniquely identifies a transaction dispute.
Format: uuid
memostringOptionalFree form text regarding the dispute.
typestringOptionalThe dispute type; It could be one of the following values: RESOLVED_BY_RAMP, CANCELLED_BY_CUSTOMER, CANCELLED_BY_RAMP, CREATED_MERCHANT_ERROR and CREATED_UNRECOGNIZED_CHARGE.

Fetch a transaction — response body — entity amount currency, value

FieldTypePresenceDescription and constraints
$objectRoot
currencystringRequired within parentThe currency of the amount in ISO 4217 format (e.g. USD).
Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL
valueJSONRequired within parent
value (anyOf 1)integerAlternativeThe amount in the smallest denomination of the currency (e.g. cents for USD). May be negative for refunds or credits.
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch a transaction — response body — line items item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalList of accounting field options selected to code the line item.
accounting_field_selections[]ModelEach itemExpand Fetch a transaction — response body — accounting field selections item
amountJSONRequired within parent
amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Amount of the line item, denominated in the currency that the transaction was settled in.
amount (anyOf 2)nullAlternative
converted_amountJSONRequired within parent
converted_amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Amount of the split line item, converted to the currency of the card on which the transaction occurred.
converted_amount (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternativeStable Ramp identifier for a persisted split line. Null for generated lines.
Format: uuid
id (anyOf 2)nullAlternative
memostringOptionalMemo associated with the line item.

Referenced models: Fetch a transaction — response body — accounting field selections item, Hold Bill — response body — amount

Fetch a transaction — response body — merchant data

FieldTypePresenceDescription and constraints
$objectRoot
auto_rentalJSONRequired within parent
auto_rental (anyOf 1)ModelAlternativeExpand Fetch a transaction — response body — merchant data auto rental check out, days
Auto rental purchase data provided by the merchant
auto_rental (anyOf 2)nullAlternative
flightJSONRequired within parent
flight (anyOf 1)ModelAlternativeExpand Fetch a transaction — response body — merchant data flight departure date, passenger name, segments
Flight purchase data provided by the merchant
flight (anyOf 2)nullAlternative
lodgingJSONRequired within parent
lodging (anyOf 1)ModelAlternativeExpand Fetch a transaction — response body — merchant data lodging check in, nights
Lodging purchase data provided by the merchant
lodging (anyOf 2)nullAlternative
receiptJSONRequired within parent
receipt (anyOf 1)ModelAlternativeExpand Fetch a transaction — response body — merchant data receipt items
Receipt purchase data provided by the merchant
receipt (anyOf 2)nullAlternative
referenceJSONRequired within parent
reference (anyOf 1)stringAlternativePurchase data reference ID provided by the merchant
reference (anyOf 2)nullAlternative

Referenced models: Fetch a transaction — response body — merchant data flight departure date, passenger name, segments, Fetch a transaction — response body — merchant data auto rental check out, days, Fetch a transaction — response body — merchant data lodging check in, nights, Fetch a transaction — response body — merchant data receipt items

Fetch a transaction — response body — merchant data auto rental check out, days

FieldTypePresenceDescription and constraints
$objectRoot
check_outstringOptional
daysJSONOptional
days (anyOf 1)integerAlternative
days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch a transaction — response body — merchant data flight departure date, passenger name, segments

FieldTypePresenceDescription and constraints
$objectRoot
departure_dateJSONRequired within parent
departure_date (anyOf 1)stringAlternative
departure_date (anyOf 2)nullAlternative
passenger_namestringOptional
segmentsJSONRequired within parent
segments (anyOf 1)arrayAlternative
segments (anyOf 1)[]ModelEach itemExpand Fetch a transaction — response body — merchant data flight departure date, passenger name, segments segments array item
segments (anyOf 2)nullAlternative

Referenced models: Fetch a transaction — response body — merchant data flight departure date, passenger name, segments segments array item

Fetch a transaction — response body — merchant data flight departure date, passenger name, segments segments array item

FieldTypePresenceDescription and constraints
$objectRoot
arrival_airport_codestringOptional
carrierstringOptional
departure_airport_codestringOptional
flight_numberstringOptional
service_classstringOptional
stopover_allowedbooleanOptional

Fetch a transaction — response body — merchant data lodging check in, nights

FieldTypePresenceDescription and constraints
$objectRoot
check_instringOptional
nightsJSONRequired within parent
nights (anyOf 1)JSONAlternative
nights (anyOf 1) (anyOf 1)integerAlternative
nights (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
nights (anyOf 2)nullAlternative

Fetch a transaction — response body — merchant data receipt items

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayOptional
items[]ModelEach itemExpand Fetch a transaction — response body — merchant data receipt items items item

Referenced models: Fetch a transaction — response body — merchant data receipt items items item

Fetch a transaction — response body — merchant data receipt items items item

FieldTypePresenceDescription and constraints
$objectRoot
commodity_codeJSONRequired within parent
commodity_code (anyOf 1)stringAlternative
commodity_code (anyOf 2)nullAlternative
descriptionstringOptional
discountJSONRequired within parent
discount (anyOf 1)JSONAlternative
discount (anyOf 1) (anyOf 1)numberAlternative
discount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
discount (anyOf 2)nullAlternative
quantityJSONOptional
quantity (anyOf 1)numberAlternative
quantity (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
taxJSONRequired within parent
tax (anyOf 1)JSONAlternative
tax (anyOf 1) (anyOf 1)numberAlternative
tax (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)numberAlternative
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit_costJSONOptional
unit_cost (anyOf 1)numberAlternative
unit_cost (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch a transaction — response body — merchant location city, country, postal code, state

FieldTypePresenceDescription and constraints
$objectRoot
cityJSONRequired within parent
city (anyOf 1)stringAlternative
city (anyOf 2)nullAlternative
countryJSONRequired within parent
country (anyOf 1)stringAlternative
country (anyOf 2)nullAlternative
postal_codeJSONRequired within parent
postal_code (anyOf 1)stringAlternative
postal_code (anyOf 2)nullAlternative
stateJSONRequired within parent
state (anyOf 1)stringAlternative
state (anyOf 2)nullAlternative

Fetch a transaction — response body — policy violations item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalTime at which the policy violation is created, presented in ISO8601 format.
Format: date-time
idstringOptionalUniquely identifies a policy violation.
Format: uuid
memostringOptionalFree form text regarding the policy violation.
typestringOptionalType of the policy violation.

List transactions — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List transactions — response body — data item
pageModelRequired within parentExpand List transactions — response body — page
Pagination details for this response.

Referenced models: List transactions — response body — page, List transactions — response body — data item

List transactions — response body — data item

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
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

List transactions — response body — page

FieldTypePresenceDescription and constraints
$objectRootPagination details for a Developer API response, with an optional total count.
nextJSONRequired within parent
next (anyOf 1)stringAlternativethe query to get to the next page; it is in the format of <BASE_URL>?<new_params>
next (anyOf 2)nullAlternative
total_countJSONRequired within parent
total_count (anyOf 1)JSONAlternative
total_count (anyOf 1) (anyOf 1)integerAlternativeTotal number of results matching the query, at most 10,000. Null when include_count is not set, or when the count could not be computed in time.
total_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_count (anyOf 2)nullAlternative
total_count_cappedJSONRequired within parent
total_count_capped (anyOf 1)booleanAlternativeWhether more than 10,000 results match, in which case total_count is 10,000. Null whenever total_count is null.
total_count_capped (anyOf 2)nullAlternative

Split a transaction into line items, or update an existing split — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
fund_idstringOptionalFor non-agent API clients only; not supported by CLI/MCP split calls. Move a refund back to the fund of its original purchase. Only a refund linked to its original purchase can change funds, and this must be that purchase's fund. Cannot be combined with line_items. Omit to leave the fund unchanged.
Format: uuid
line_itemsJSONOptional
line_items (anyOf 1)arrayAlternativeList of line items for the split. Send an empty array to unsplit (remove all line items). Omit to leave splits unchanged.
line_items (anyOf 1)[]ModelEach itemExpand Split a transaction into line items, or update an existing split — request body — body line items array item
line_items (anyOf 2)nullAlternative

Referenced models: Split a transaction into line items, or update an existing split — request body — body line items array item

Split a transaction into line items, or update an existing split — request body — body line items array item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalAccounting field selections for this line item. Each field and option may be identified by Ramp ID or by ERP remote ID.
accounting_field_selections[]ModelEach itemExpand Split a transaction into line items, or update an existing split — request body — body line items array item accounting field selections item
amountintegerRequired within parentAmount in minor units (e.g. 5000 = $50.00).
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo for this line item (e.g. a case ID).
Default: null
memo (anyOf 2)nullAlternative

Referenced models: Split a transaction into line items, or update an existing split — request body — body line items array item accounting field selections item

Split a transaction into line items, or update an existing split — request body — body line items array item accounting field selections item

FieldTypePresenceDescription and constraints
$objectRoot
field_external_idJSONOptional
field_external_id (anyOf 1)stringAlternativeRemote ID of the accounting field in the ERP system. Provide exactly one of field_id or field_external_id.
Default: null
field_external_id (anyOf 2)nullAlternative
field_idJSONOptional
field_id (anyOf 1)stringAlternativeUUID of the accounting field. Provide exactly one of field_id or field_external_id.
Default: null
Format: uuid
field_id (anyOf 2)nullAlternative
field_option_external_idJSONOptional
field_option_external_id (anyOf 1)stringAlternativeRemote ID of the accounting field option in the ERP system. Provide exactly one of field_option_id, field_option_external_id, or free_form_text.
Default: null
field_option_external_id (anyOf 2)nullAlternative
field_option_idJSONOptional
field_option_id (anyOf 1)stringAlternativeUUID of the accounting field option. Provide exactly one of field_option_id, field_option_external_id, or free_form_text.
Default: null
Format: uuid
field_option_id (anyOf 2)nullAlternative
free_form_textJSONOptional
free_form_text (anyOf 1)stringAlternativeFree form text for the accounting field selection. For DATE-type fields, use ISO format (YYYY-MM-DD). Provide exactly one of field_option_id, field_option_external_id, or free_form_text.
Default: null
Minimum length: 1
free_form_text (anyOf 2)nullAlternative

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.