Ramp: Transaction schemas
26 Ramp schemas with complete fields and constraints.
← Transaction operations · All schemas
Fetch a transaction — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_categories | array | Optional | [Deprecated - use accounting_field_selections instead] Accounting categories related to the transaction. Read only: true |
accounting_categories[] | Model | Each item | Expand Fetch a transaction — response body — accounting categories item |
accounting_date | JSON | Required within parent | |
accounting_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
accounting_field_selections | array | Optional | List of accounting fields selected to code the transaction. |
accounting_field_selections[] | Model | Each item | Expand Fetch a transaction — response body — accounting field selections item |
all_requirements_met_and_approved | boolean | Required within parent | Whether the transaction is fully approved and all cardholder requirements are met, including receipts, memos, and tracking categories. Read only: true |
amount | JSON | Optional | |
amount (anyOf 1) | number | Alternative | Deprecated. Use `entity_amount`. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
attendees | array | Optional | List of attendees for the transaction |
attendees[] | Model | Each item | Expand Fetch a transaction — response body — attendees item |
card_holder | Model | Optional | Expand Fetch a transaction — response body — card holder Information about the card holder. |
card_id | string | Optional | Identifier of the physical or virtual card associated with the transaction. Format: uuid |
card_present | boolean | Required within parent | Whether the transaction was processed using a card present terminal. |
currency_code | string | Optional | Deprecated. Use `entity_amount.currency`. |
decline_details | Model | Optional | Expand Fetch a transaction — response body — decline details Details about a transaction decline. |
disputes | array | Optional | A list of disputes sorted in descending order by their creation time. Read only: true |
disputes[] | Model | Each item | Expand Fetch a transaction — response body — disputes item |
entity_amount | JSON | Required within parent | |
entity_amount (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | Unique identifier of business entity associated with the transaction. Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
fund_id | string | Optional | Unique identifier of the fund associated with the transaction. Returns the same value as `limit_id`. Format: uuid Read only: true |
id | string | Optional | Format: uuid |
limit_id | string | Optional | Alias of fund (`fund_id`). Unique identifier of the spend limit associated with the transaction. Returns the same value as `fund_id`. Format: uuid |
line_items | array | Optional | List of line items related to the transaction. |
line_items[] | Model | Each item | Expand Fetch a transaction — response body — line items item |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | |
memo (anyOf 2) | null | Alternative | |
merchant_amount | JSON | Required within parent | |
merchant_amount (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
merchant_category_code | string | Optional | Merchant 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_description | string | Optional | Description about the merchant category code. |
merchant_data | Model | Optional | Expand Fetch a transaction — response body — merchant data Purchase data associated related to a transaction provided by the merchant |
merchant_descriptor | string | Optional | A merchant descriptor is the name that appears on a customer's bank statement when they make a purchase from that merchant. |
merchant_id | JSON | Required within parent | |
merchant_id (anyOf 1) | string | Alternative | Format: uuid |
merchant_id (anyOf 2) | null | Alternative | |
merchant_location | JSON | Required within parent | |
merchant_location (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
merchant_name | JSON | Optional | |
merchant_name (anyOf 1) | string | Alternative | Read only: true |
merchant_name (anyOf 2) | null | Alternative | |
minor_unit_conversion_rate | JSON | Required within parent | |
minor_unit_conversion_rate (anyOf 1) | JSON | Alternative | |
minor_unit_conversion_rate (anyOf 1) (anyOf 1) | integer | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minor_unit_conversion_rate (anyOf 2) | null | Alternative | |
network_merchant_id | JSON | Required within parent | |
network_merchant_id (anyOf 1) | string | Alternative | Network merchant identifier from the card acceptor. Read only: true |
network_merchant_id (anyOf 2) | null | Alternative | |
original_transaction_amount | JSON | Required within parent | |
original_transaction_amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount the original transaction amount before the currency conversion. |
original_transaction_amount (anyOf 2) | null | Alternative | |
original_transaction_id | JSON | Required within parent | |
original_transaction_id (anyOf 1) | string | Alternative | Original transaction id for refund transactions. Read only: true |
original_transaction_id (anyOf 2) | null | Alternative | |
policy_violations | array | Optional | A list of policy violations sorted in descending order by their creation time. Read only: true |
policy_violations[] | Model | Each item | Expand Fetch a transaction — response body — policy violations item |
receipt_affidavit | JSON | Optional | |
receipt_affidavit (anyOf 1) | string | Alternative | Read only: true |
receipt_affidavit (anyOf 2) | null | Alternative | |
receipts | array | Optional | Receipts listed in ascending order by their creation time, related to the transaction. Read only: true |
receipts[] | string | Each item | Format: uuid |
requires_accounting_vendor_creation_to_sync | boolean | Optional | Whether 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_date | string | Optional | Time when funds were moved for a transaction, in ISO8601 format. Format: date-time |
sk_category_id | JSON | Required within parent | |
sk_category_id (anyOf 1) | JSON | Alternative | |
sk_category_id (anyOf 1) (anyOf 1) | integer | Alternative | Ramp 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sk_category_id (anyOf 2) | null | Alternative | |
sk_category_name | JSON | Required within parent | |
sk_category_name (anyOf 1) | string | Alternative | Ramp category name. Read only: true |
sk_category_name (anyOf 2) | null | Alternative | |
spend_program_id | string | Optional | Unique identifier of the spend program from which this limit was issued. Format: uuid |
state | string | Optional | transaction state. Known values: ALL, CLEARED, COMPLETION, DECLINED, ERROR, PENDING, PENDING_INITIATION |
statement_id | string | Optional | Statement ID associated with the transaction if one is available. Format: uuid |
sync_status | string | Required within parent | Known values: NOT_SYNC_READY, SYNCED, SYNC_READY Read only: true |
synced_at | JSON | Required within parent | |
synced_at (anyOf 1) | string | Alternative | Time when transaction has been synced, in ISO8601 format. Will be None if the transaction is not synced. Format: date-time |
synced_at (anyOf 2) | null | Alternative | |
trip_id | JSON | Required within parent | |
trip_id (anyOf 1) | string | Alternative | Trip ID associated with the transaction if one is available. Format: uuid |
trip_id (anyOf 2) | null | Alternative | |
trip_name | JSON | Required within parent | |
trip_name (anyOf 1) | string | Alternative | Trip name associated with the transaction if one is available. |
trip_name (anyOf 2) | null | Alternative | |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Approximate 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) | null | Alternative | |
user_transaction_time | string | Optional | Time 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category_id | string | Optional | User-selected category id for transaction. |
category_name | string | Optional | User-selected category name for transaction. |
tracking_category_remote_id | string | Optional | |
tracking_category_remote_name | string | Optional | |
tracking_category_remote_type | string | Optional |
Fetch a transaction — response body — accounting field selections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category_info | Model | Optional | Expand Fetch a transaction — response body — accounting field selections item category info Information about the accounting category (or accounting field). |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Customer-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) | null | Alternative | |
external_code | string | Optional | External code of accounting field option; Code field displayed on the ERP. |
external_id | string | Optional | External ID of accounting field option; It should uniquely identify an accounting field option on the ERP. |
id | string | Optional | ID that uniquely identifies an accounting field option within Ramp Format: uuid |
name | string | Optional | Name of accounting field option |
provider_name | string | Required within parent | Name of accounting field provider Read only: true |
source | Model | Optional | Expand Fetch a transaction — response body — accounting field selections item source Describes the source of the accounting coding selection. |
type | string | Optional | Accounting 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | string | Optional | External ID of accounting field; It should uniquely identify an accounting field on the ERP. |
id | string | Optional | ID that uniquely identifies an accounting field within Ramp Format: uuid |
name | string | Optional | Name of accounting field |
type | string | Optional | Accounting 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Describes the type of source that added this selection. |
Fetch a transaction — response body — attendees item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | Full name of the attendee |
user_id | JSON | Required within parent | |
user_id (anyOf 1) | string | Alternative | User 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) | null | Alternative |
Fetch a transaction — response body — card holder
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department_id | string | Optional | ID of the card holder's department. Format: uuid |
department_name | string | Optional | Name of the card holder's deparment. |
employee_id | string | Optional | User-defined employee ID of the card holder. |
first_name | string | Optional | Card holder's first name. |
last_name | string | Optional | Card holder's last name. |
location_id | string | Optional | ID of the card holder's location. Format: uuid |
location_name | string | Optional | Name of the card holder's location. |
user_id | string | Optional | Card holder's ID. Format: uuid |
Fetch a transaction — response body — decline details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | number | Alternative | Declined amount, denominated in the transaction's settlement currency (the transaction's `currency_code`). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
declined_amount | JSON | Required within parent | |
declined_amount (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
reason | string | Optional | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Time at which the dispute is created, presented in ISO8601 format. Format: date-time |
id | string | Optional | Uniquely identifies a transaction dispute. Format: uuid |
memo | string | Optional | Free form text regarding the dispute. |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Required within parent | The 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 |
value | JSON | Required within parent | |
value (anyOf 1) | integer | Alternative | The amount in the smallest denomination of the currency (e.g. cents for USD). May be negative for refunds or credits. |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Fetch a transaction — response body — line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | List of accounting field options selected to code the line item. |
accounting_field_selections[] | Model | Each item | Expand Fetch a transaction — response body — accounting field selections item |
amount | JSON | Required within parent | |
amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Amount of the line item, denominated in the currency that the transaction was settled in. |
amount (anyOf 2) | null | Alternative | |
converted_amount | JSON | Required within parent | |
converted_amount (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Stable Ramp identifier for a persisted split line. Null for generated lines. Format: uuid |
id (anyOf 2) | null | Alternative | |
memo | string | Optional | Memo 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
auto_rental | JSON | Required within parent | |
auto_rental (anyOf 1) | Model | Alternative | Expand Fetch a transaction — response body — merchant data auto rental check out, days Auto rental purchase data provided by the merchant |
auto_rental (anyOf 2) | null | Alternative | |
flight | JSON | Required within parent | |
flight (anyOf 1) | Model | Alternative | Expand Fetch a transaction — response body — merchant data flight departure date, passenger name, segments Flight purchase data provided by the merchant |
flight (anyOf 2) | null | Alternative | |
lodging | JSON | Required within parent | |
lodging (anyOf 1) | Model | Alternative | Expand Fetch a transaction — response body — merchant data lodging check in, nights Lodging purchase data provided by the merchant |
lodging (anyOf 2) | null | Alternative | |
receipt | JSON | Required within parent | |
receipt (anyOf 1) | Model | Alternative | Expand Fetch a transaction — response body — merchant data receipt items Receipt purchase data provided by the merchant |
receipt (anyOf 2) | null | Alternative | |
reference | JSON | Required within parent | |
reference (anyOf 1) | string | Alternative | Purchase data reference ID provided by the merchant |
reference (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
check_out | string | Optional | |
days | JSON | Optional | |
days (anyOf 1) | integer | Alternative | |
days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Fetch a transaction — response body — merchant data flight departure date, passenger name, segments
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
departure_date | JSON | Required within parent | |
departure_date (anyOf 1) | string | Alternative | |
departure_date (anyOf 2) | null | Alternative | |
passenger_name | string | Optional | |
segments | JSON | Required within parent | |
segments (anyOf 1) | array | Alternative | |
segments (anyOf 1)[] | Model | Each item | Expand Fetch a transaction — response body — merchant data flight departure date, passenger name, segments segments array item |
segments (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
arrival_airport_code | string | Optional | |
carrier | string | Optional | |
departure_airport_code | string | Optional | |
flight_number | string | Optional | |
service_class | string | Optional | |
stopover_allowed | boolean | Optional |
Fetch a transaction — response body — merchant data lodging check in, nights
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
check_in | string | Optional | |
nights | JSON | Required within parent | |
nights (anyOf 1) | JSON | Alternative | |
nights (anyOf 1) (anyOf 1) | integer | Alternative | |
nights (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
nights (anyOf 2) | null | Alternative |
Fetch a transaction — response body — merchant data receipt items
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Optional | |
items[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
commodity_code | JSON | Required within parent | |
commodity_code (anyOf 1) | string | Alternative | |
commodity_code (anyOf 2) | null | Alternative | |
description | string | Optional | |
discount | JSON | Required within parent | |
discount (anyOf 1) | JSON | Alternative | |
discount (anyOf 1) (anyOf 1) | number | Alternative | |
discount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
discount (anyOf 2) | null | Alternative | |
quantity | JSON | Optional | |
quantity (anyOf 1) | number | Alternative | |
quantity (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tax | JSON | Required within parent | |
tax (anyOf 1) | JSON | Alternative | |
tax (anyOf 1) (anyOf 1) | number | Alternative | |
tax (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tax (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | number | Alternative | |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit_cost | JSON | Optional | |
unit_cost (anyOf 1) | number | Alternative | |
unit_cost (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Fetch a transaction — response body — merchant location city, country, postal code, state
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | |
city (anyOf 2) | null | Alternative | |
country | JSON | Required within parent | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
postal_code | JSON | Required within parent | |
postal_code (anyOf 1) | string | Alternative | |
postal_code (anyOf 2) | null | Alternative | |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | |
state (anyOf 2) | null | Alternative |
Fetch a transaction — response body — policy violations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Time at which the policy violation is created, presented in ISO8601 format. Format: date-time |
id | string | Optional | Uniquely identifies a policy violation. Format: uuid |
memo | string | Optional | Free form text regarding the policy violation. |
type | string | Optional | Type of the policy violation. |
List transactions — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand List transactions — response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_categories | array | Optional | [Deprecated - use accounting_field_selections instead] Accounting categories related to the transaction. Read only: true |
accounting_categories[] | Model | Each item | Expand Fetch a transaction — response body — accounting categories item |
accounting_date | JSON | Required within parent | |
accounting_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
accounting_field_selections | array | Optional | List of accounting fields selected to code the transaction. |
accounting_field_selections[] | Model | Each item | Expand Fetch a transaction — response body — accounting field selections item |
all_requirements_met_and_approved | boolean | Required within parent | Whether the transaction is fully approved and all cardholder requirements are met, including receipts, memos, and tracking categories. Read only: true |
amount | JSON | Optional | |
amount (anyOf 1) | number | Alternative | Deprecated. Use `entity_amount`. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
attendees | array | Optional | List of attendees for the transaction |
attendees[] | Model | Each item | Expand Fetch a transaction — response body — attendees item |
card_holder | Model | Optional | Expand Fetch a transaction — response body — card holder Information about the card holder. |
card_id | string | Optional | Identifier of the physical or virtual card associated with the transaction. Format: uuid |
card_present | boolean | Required within parent | Whether the transaction was processed using a card present terminal. |
currency_code | string | Optional | Deprecated. Use `entity_amount.currency`. |
decline_details | Model | Optional | Expand Fetch a transaction — response body — decline details Details about a transaction decline. |
disputes | array | Optional | A list of disputes sorted in descending order by their creation time. Read only: true |
disputes[] | Model | Each item | Expand Fetch a transaction — response body — disputes item |
entity_amount | JSON | Required within parent | |
entity_amount (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | Unique identifier of business entity associated with the transaction. Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
fund_id | string | Optional | Unique identifier of the fund associated with the transaction. Returns the same value as `limit_id`. Format: uuid Read only: true |
id | string | Optional | Format: uuid |
limit_id | string | Optional | Alias of fund (`fund_id`). Unique identifier of the spend limit associated with the transaction. Returns the same value as `fund_id`. Format: uuid |
line_items | array | Optional | List of line items related to the transaction. |
line_items[] | Model | Each item | Expand Fetch a transaction — response body — line items item |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | |
memo (anyOf 2) | null | Alternative | |
merchant_amount | JSON | Required within parent | |
merchant_amount (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
merchant_category_code | string | Optional | Merchant 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_description | string | Optional | Description about the merchant category code. |
merchant_data | Model | Optional | Expand Fetch a transaction — response body — merchant data Purchase data associated related to a transaction provided by the merchant |
merchant_descriptor | string | Optional | A merchant descriptor is the name that appears on a customer's bank statement when they make a purchase from that merchant. |
merchant_id | JSON | Required within parent | |
merchant_id (anyOf 1) | string | Alternative | Format: uuid |
merchant_id (anyOf 2) | null | Alternative | |
merchant_location | JSON | Required within parent | |
merchant_location (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
merchant_name | JSON | Optional | |
merchant_name (anyOf 1) | string | Alternative | Read only: true |
merchant_name (anyOf 2) | null | Alternative | |
minor_unit_conversion_rate | JSON | Required within parent | |
minor_unit_conversion_rate (anyOf 1) | JSON | Alternative | |
minor_unit_conversion_rate (anyOf 1) (anyOf 1) | integer | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minor_unit_conversion_rate (anyOf 2) | null | Alternative | |
network_merchant_id | JSON | Required within parent | |
network_merchant_id (anyOf 1) | string | Alternative | Network merchant identifier from the card acceptor. Read only: true |
network_merchant_id (anyOf 2) | null | Alternative | |
original_transaction_amount | JSON | Required within parent | |
original_transaction_amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount the original transaction amount before the currency conversion. |
original_transaction_amount (anyOf 2) | null | Alternative | |
original_transaction_id | JSON | Required within parent | |
original_transaction_id (anyOf 1) | string | Alternative | Original transaction id for refund transactions. Read only: true |
original_transaction_id (anyOf 2) | null | Alternative | |
policy_violations | array | Optional | A list of policy violations sorted in descending order by their creation time. Read only: true |
policy_violations[] | Model | Each item | Expand Fetch a transaction — response body — policy violations item |
receipts | array | Optional | Receipts listed in ascending order by their creation time, related to the transaction. Read only: true |
receipts[] | string | Each item | Format: uuid |
requires_accounting_vendor_creation_to_sync | boolean | Optional | Whether 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_date | string | Optional | Time when funds were moved for a transaction, in ISO8601 format. Format: date-time |
sk_category_id | JSON | Required within parent | |
sk_category_id (anyOf 1) | JSON | Alternative | |
sk_category_id (anyOf 1) (anyOf 1) | integer | Alternative | Ramp 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sk_category_id (anyOf 2) | null | Alternative | |
sk_category_name | JSON | Required within parent | |
sk_category_name (anyOf 1) | string | Alternative | Ramp category name. Read only: true |
sk_category_name (anyOf 2) | null | Alternative | |
spend_program_id | string | Optional | Unique identifier of the spend program from which this limit was issued. Format: uuid |
state | string | Optional | transaction state. Known values: ALL, CLEARED, COMPLETION, DECLINED, ERROR, PENDING, PENDING_INITIATION |
statement_id | string | Optional | Statement ID associated with the transaction if one is available. Format: uuid |
sync_status | string | Required within parent | Known values: NOT_SYNC_READY, SYNCED, SYNC_READY Read only: true |
synced_at | JSON | Required within parent | |
synced_at (anyOf 1) | string | Alternative | Time when transaction has been synced, in ISO8601 format. Will be None if the transaction is not synced. Format: date-time |
synced_at (anyOf 2) | null | Alternative | |
trip_id | JSON | Required within parent | |
trip_id (anyOf 1) | string | Alternative | Trip ID associated with the transaction if one is available. Format: uuid |
trip_id (anyOf 2) | null | Alternative | |
trip_name | JSON | Required within parent | |
trip_name (anyOf 1) | string | Alternative | Trip name associated with the transaction if one is available. |
trip_name (anyOf 2) | null | Alternative | |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Approximate 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) | null | Alternative | |
user_transaction_time | string | Optional | Time 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination details for a Developer API response, with an optional total count. |
next | JSON | Required within parent | |
next (anyOf 1) | string | Alternative | the query to get to the next page; it is in the format of <BASE_URL>?<new_params> |
next (anyOf 2) | null | Alternative | |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | JSON | Alternative | |
total_count (anyOf 1) (anyOf 1) | integer | Alternative | Total 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_count (anyOf 2) | null | Alternative | |
total_count_capped | JSON | Required within parent | |
total_count_capped (anyOf 1) | boolean | Alternative | Whether 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) | null | Alternative |
Split a transaction into line items, or update an existing split — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fund_id | string | Optional | For 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_items | JSON | Optional | |
line_items (anyOf 1) | array | Alternative | List 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)[] | Model | Each item | Expand Split a transaction into line items, or update an existing split — request body — body line items array item |
line_items (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | Accounting field selections for this line item. Each field and option may be identified by Ramp ID or by ERP remote ID. |
accounting_field_selections[] | Model | Each item | Expand Split a transaction into line items, or update an existing split — request body — body line items array item accounting field selections item |
amount | integer | Required within parent | Amount in minor units (e.g. 5000 = $50.00). |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Memo for this line item (e.g. a case ID). Default: null |
memo (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_external_id | JSON | Optional | |
field_external_id (anyOf 1) | string | Alternative | Remote 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) | null | Alternative | |
field_id | JSON | Optional | |
field_id (anyOf 1) | string | Alternative | UUID of the accounting field. Provide exactly one of field_id or field_external_id. Default: null Format: uuid |
field_id (anyOf 2) | null | Alternative | |
field_option_external_id | JSON | Optional | |
field_option_external_id (anyOf 1) | string | Alternative | Remote 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) | null | Alternative | |
field_option_id | JSON | Optional | |
field_option_id (anyOf 1) | string | Alternative | UUID 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) | null | Alternative | |
free_form_text | JSON | Optional | |
free_form_text (anyOf 1) | string | Alternative | Free 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) | null | Alternative |