The Transaction object 

Attributes

• idstring

  Unique identifier for the object.

• amountinteger

  The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit.

• authorizationnullable stringExpandable

  The Authorization object that led to this transaction.

• cardstringExpandable

  The card used to make this transaction.

• cardholdernullable stringExpandable

  The cardholder to whom this transaction belongs.

• currencyenum

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• metadataobject

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• typeenum

  The nature of the transaction.

  Possible enum values

  capture Funds were captured by the acquirer. amount will be negative because funds are moving out of your balance. Not all captures will be linked to an authorization, as acquirers can force capture in some cases.

  refund An acquirer initiated a refund. This transaction might not be linked to an original capture, for example credits are original transactions. amount will be positive for refunds and negative for refund reversals (very rare).

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• amount_detailsnullable object

  Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.

  Hide child attributes

  • amount_details.atm_feenullable integer

    The fee charged by the ATM for the cash withdrawal.

  • amount_details.cashback_amountnullable integer

    The amount of cash requested by the cardholder.

• balance_transactionnullable stringExpandable

  ID of the balance transaction associated with this transaction.

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• disputenullable stringExpandable

  If you’ve disputed the transaction, the ID of the dispute.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• merchant_amountinteger

  The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency.

• merchant_currencyenum

  The currency with which the merchant is taking payment.

• merchant_dataobject

  Details about the seller (grocery store, e-commerce website, etc.) involved in this transaction.

  Hide child attributes

  • merchant_data.categorystring

    A categorization of the seller’s type of business. See our merchant categories guide for a list of possible values.

  • merchant_data.category_codestring

    The merchant category code for the seller’s business

  • merchant_data.citynullable string

    City where the seller is located

  • merchant_data.countrynullable string

    Country where the seller is located

  • merchant_data.namenullable string

    Name of the seller

  • merchant_data.network_idstring

    Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.

  • merchant_data.postal_codenullable string

    Postal code where the seller is located

  • merchant_data.statenullable string

    State where the seller is located

  • merchant_data.tax_idnullable string

    The seller’s tax identification number. Currently populated for French merchants only.

  • merchant_data.terminal_idnullable string

    An ID assigned by the seller to the location of the sale.

  • merchant_data.urlnullable string

    URL provided by the merchant on a 3DS request

• network_datanullable object

  Details about the transaction, such as processing dates, set by the card network.

  Hide child attributes

  • network_data.authorization_codenullable string

    A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter “S”, followed by a six-digit number. For example, “S498162”. Please note that the code is not guaranteed to be unique across authorizations.

  • network_data.processing_datenullable string

    The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.

  • network_data.transaction_idnullable string

    Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.

• purchase_detailsnullable objectExpandable

  Additional purchase information that is optionally provided by the merchant.

  Hide child attributes

  • purchase_details.fleetnullable object

    Fleet-specific information for transactions using Fleet cards.

    Hide child attributes

    • purchase_details.fleet.cardholder_prompt_datanullable object

      Answers to prompts presented to cardholder at point of sale.

      Hide child attributes

      • purchase_details.fleet.cardholder_prompt_data.driver_idnullable string

        Driver ID.

      • purchase_details.fleet.cardholder_prompt_data.odometernullable integer

        Odometer reading.

      • purchase_details.fleet.cardholder_prompt_data.unspecified_idnullable string

        An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.

      • purchase_details.fleet.cardholder_prompt_data.user_idnullable string

        User ID.

      • purchase_details.fleet.cardholder_prompt_data.vehicle_numbernullable string

        Vehicle number.

    • purchase_details.fleet.purchase_typenullable string

      The type of purchase. One of fuel_purchase, non_fuel_purchase, or fuel_and_non_fuel_purchase.

    • purchase_details.fleet.reported_breakdownnullable object

      More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.

      Hide child attributes

      • purchase_details.fleet.reported_breakdown.fuelnullable object

        Breakdown of fuel portion of the purchase.

        Hide child attributes

        • purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimalnullable decimal string

          Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.

      • purchase_details.fleet.reported_breakdown.non_fuelnullable object

        Breakdown of non-fuel portion of the purchase.

        Hide child attributes

        • purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimalnullable decimal string

          Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.

      • purchase_details.fleet.reported_breakdown.taxnullable object

        Information about tax included in this transaction.

        Hide child attributes

        • purchase_details.fleet.reported_breakdown.tax.local_amount_decimalnullable decimal string

          Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.

        • purchase_details.fleet.reported_breakdown.tax.national_amount_decimalnullable decimal string

          Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.

    • purchase_details.fleet.service_typenullable string

      The type of fuel service. One of non_fuel_transaction, full_service, or self_service.

  • purchase_details.flightnullable object

    Information about the flight that was purchased with this transaction.

    Hide child attributes

    • purchase_details.flight.departure_atnullable integer

      The time that the flight departed.

    • purchase_details.flight.passenger_namenullable string

      The name of the passenger.

    • purchase_details.flight.refundablenullable boolean

      Whether the ticket is refundable.

    • purchase_details.flight.segmentsnullable array of objects

      The legs of the trip.

      Hide child attributes

      • purchase_details.flight.segments.arrival_airport_codenullable string

        The three-letter IATA airport code of the flight’s destination.

      • purchase_details.flight.segments.carriernullable string

        The airline carrier code.

      • purchase_details.flight.segments.departure_airport_codenullable string

        The three-letter IATA airport code that the flight departed from.

      • purchase_details.flight.segments.flight_numbernullable string

        The flight number.

      • purchase_details.flight.segments.service_classnullable string

        The flight’s service class.

      • purchase_details.flight.segments.stopover_allowednullable boolean

        Whether a stopover is allowed on this flight.

    • purchase_details.flight.travel_agencynullable string

      The travel agency that issued the ticket.

  • purchase_details.fuelnullable object

    Information about fuel that was purchased with this transaction.

    Hide child attributes

    • purchase_details.fuel.industry_product_codenullable string

      Conexxus Payment System Product Code identifying the primary fuel product purchased.

    • purchase_details.fuel.quantity_decimalnullable decimal string

      The quantity of units of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.

    • purchase_details.fuel.typestring

      The type of fuel that was purchased. One of diesel, unleaded_plus, unleaded_regular, unleaded_super, or other.

    • purchase_details.fuel.unitstring

      The units for quantity_decimal. One of charging_minute, imperial_gallon, kilogram, kilowatt_hour, liter, pound, us_gallon, or other.

    • purchase_details.fuel.unit_cost_decimaldecimal string

      The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.

  • purchase_details.lodgingnullable object

    Information about lodging that was purchased with this transaction.

    Hide child attributes

    • purchase_details.lodging.check_in_atnullable integer

      The time of checking into the lodging.

    • purchase_details.lodging.nightsnullable integer

      The number of nights stayed at the lodging.

  • purchase_details.receiptnullable array of objects

    The line items in the purchase.

    Hide child attributes

    • purchase_details.receipt.descriptionnullable string

      The description of the item. The maximum length of this field is 26 characters.

    • purchase_details.receipt.quantitynullable float

      The quantity of the item.

    • purchase_details.receipt.totalnullable integer

      The total for this line item in cents.

    • purchase_details.receipt.unit_costnullable integer

      The unit cost of the item in cents.

  • purchase_details.referencenullable string

    A merchant-specific order number.

• tokennullable stringPreview featureExpandable

  Token object used for this transaction. If a network token was not used for this transaction, this field will be null.

• walletnullable enum

  The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay.