Create a test-mode force capture Test helper

Allows the user to capture an arbitrary amount, also known as a forced capture.

Parameters

• amountintegerRequired

  The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the smallest currency unit.

• cardstringRequired

  Card associated with this transaction.

• currencyenum

  The currency of the capture. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency.

More parameters

Collapse all

• merchant_dataobject

  Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.

  Hide child parameters

  • 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.citystring

    City where the seller is located

  • merchant_data.countrystring

    Country where the seller is located

  • merchant_data.namestring

    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_codestring

    Postal code where the seller is located

  • merchant_data.statestring

    State where the seller is located

  • merchant_data.terminal_idstring

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

  • merchant_data.urlstring

    URL provided by the merchant on a 3DS request

• purchase_detailsobject

  Additional purchase information that is optionally provided by the merchant.

  Hide child parameters

  • purchase_details.fleetobject

    Fleet-specific information for transactions using Fleet cards.

    Hide child parameters

    • purchase_details.fleet.cardholder_prompt_dataobject

      Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.

      Hide child parameters

      • purchase_details.fleet.cardholder_prompt_data.driver_idstring

        Driver ID.

      • purchase_details.fleet.cardholder_prompt_data.odometerinteger

        Odometer reading.

      • purchase_details.fleet.cardholder_prompt_data.unspecified_idstring

        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_idstring

        User ID.

      • purchase_details.fleet.cardholder_prompt_data.vehicle_numberstring

        Vehicle number.

    • purchase_details.fleet.purchase_typestring

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

    • purchase_details.fleet.reported_breakdownobject

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

      Hide child parameters

      • purchase_details.fleet.reported_breakdown.fuelobject

        Breakdown of fuel portion of the purchase.

        Hide child parameters

        • purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimalstring

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

      • purchase_details.fleet.reported_breakdown.non_fuelobject

        Breakdown of non-fuel portion of the purchase.

        Hide child parameters

        • purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimalstring

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

      • purchase_details.fleet.reported_breakdown.taxobject

        Information about tax included in this transaction.

        Hide child parameters

        • purchase_details.fleet.reported_breakdown.tax.local_amount_decimalstring

          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_decimalstring

          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_typestring

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

  • purchase_details.flightobject

    Information about the flight that was purchased with this transaction.

    Hide child parameters

    • purchase_details.flight.departure_attimestamp

      The time that the flight departed.

    • purchase_details.flight.passenger_namestring

      The name of the passenger.

    • purchase_details.flight.refundableboolean

      Whether the ticket is refundable.

    • purchase_details.flight.segmentsarray of objects

      The legs of the trip.

      Hide child parameters

      • purchase_details.flight.segments.arrival_airport_codestring

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

      • purchase_details.flight.segments.carrierstring

        The airline carrier code.

      • purchase_details.flight.segments.departure_airport_codestring

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

      • purchase_details.flight.segments.flight_numberstring

        The flight number.

      • purchase_details.flight.segments.service_classstring

        The flight’s service class.

      • purchase_details.flight.segments.stopover_allowedboolean

        Whether a stopover is allowed on this flight.

    • purchase_details.flight.travel_agencystring

      The travel agency that issued the ticket.

  • purchase_details.fuelobject

    Information about fuel that was purchased with this transaction.

    Hide child parameters

    • purchase_details.fuel.industry_product_codestring

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

    • purchase_details.fuel.quantity_decimalstring

      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_decimalstring

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

  • purchase_details.lodgingobject

    Information about lodging that was purchased with this transaction.

    Hide child parameters

    • purchase_details.lodging.check_in_attimestamp

      The time of checking into the lodging.

    • purchase_details.lodging.nightsinteger

      The number of nights stayed at the lodging.

  • purchase_details.receiptarray of objects

    The line items in the purchase.

  • purchase_details.referencestring

    A merchant-specific order number.