Capture a PaymentIntent 

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about separate authorization and capture.

Parameters

• amount_to_captureinteger

  The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full amount_capturable if it’s not provided.

• 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

Collapse all

• amount_detailsobject

  Provides industry-specific information about the amount.

  Hide child parameters

  • amount_details.discount_amountinteger

    The total discount applied on the transaction represented in the smallest currency unit. An integer greater than 0.

    This field is mutually exclusive with the amount_details[line_items][#][discount_amount] field.

  • amount_details.line_itemsarray of objects

    A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.

    Hide child parameters

    • amount_details.line_items.product_namestringRequired

      The product name of the line item. Required for L3 rates. At most 1024 characters long.

      For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters.

    • amount_details.line_items.quantityintegerRequired

      The quantity of items. Required for L3 rates. An integer greater than 0.

    • amount_details.line_items.unit_costintegerRequired

      The unit cost of the line item represented in the smallest currency unit. Required for L3 rates. An integer greater than or equal to 0.

    • amount_details.line_items.discount_amountinteger

      The discount applied on this line item represented in the smallest currency unit. An integer greater than 0.

      This field is mutually exclusive with the amount_details[discount_amount] field.

    • amount_details.line_items.payment_method_optionsobject

      Payment method-specific information for line items.

      Hide child parameters

      • amount_details.line_items.payment_method_options.cardobject

        This sub-hash contains line item details that are specific to card payment method."

        Hide child parameters

        • amount_details.line_items.payment_method_options.card.commodity_codestring

          Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.

      • amount_details.line_items.payment_method_options.card_presentobject

        This sub-hash contains line item details that are specific to card_present payment method."

        Hide child parameters

        • amount_details.line_items.payment_method_options.card_present.commodity_codestring

          Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.

      • amount_details.line_items.payment_method_options.klarnaobject

        This sub-hash contains line item details that are specific to klarna payment method."

        Hide child parameters

        • amount_details.line_items.payment_method_options.klarna.image_urlstring

          URL to an image for the product. Max length, 4096 characters.

        • amount_details.line_items.payment_method_options.klarna.product_urlstring

          URL to the product page. Max length, 4096 characters.

        • amount_details.line_items.payment_method_options.klarna.referencestring

          Unique reference for this line item to correlate it with your system’s internal records. The field is displayed in the Klarna Consumer App if passed.

        • amount_details.line_items.payment_method_options.klarna.subscription_referencestring

          Reference for the subscription this line item is for.

      • amount_details.line_items.payment_method_options.paypalobject

        This sub-hash contains line item details that are specific to paypal payment method."

        Hide child parameters

        • amount_details.line_items.payment_method_options.paypal.categoryenum

          Type of the line item.

          Possible enum values

          digital_goods Goods that are stored, delivered, and used in their electronic format.

          donation A contribution or gift for which no good or service is exchanged, usually to a not for profit organization.

          physical_goods A tangible item that can be shipped with proof of delivery.

        • amount_details.line_items.payment_method_options.paypal.descriptionstring

          Description of the line item.

        • amount_details.line_items.payment_method_options.paypal.sold_bystring

          The Stripe account ID of the connected account that sells the item.

    • amount_details.line_items.product_codestring

      The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long.

    • amount_details.line_items.taxobject

      Contains information about the tax on the item.

      Hide child parameters

      • amount_details.line_items.tax.total_tax_amountintegerRequired

        The total amount of tax on a single line item represented in the smallest currency unit. Required for L3 rates. An integer greater than or equal to 0.

        This field is mutually exclusive with the amount_details[tax][total_tax_amount] field.

    • amount_details.line_items.unit_of_measurestring

      A unit of measure for the line item, such as gallons, feet, meters, etc.

  • amount_details.shippingobject

    Contains information about the shipping portion of the amount.

    Hide child parameters

    • amount_details.shipping.amountinteger

      If a physical good is being shipped, the cost of shipping represented in the smallest currency unit. An integer greater than or equal to 0.

    • amount_details.shipping.from_postal_codestring

      If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed.

    • amount_details.shipping.to_postal_codestring

      If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed.

  • amount_details.taxobject

    Contains information about the tax portion of the amount.

    Hide child parameters

    • amount_details.tax.total_tax_amountintegerRequired

      The total amount of tax on the transaction represented in the smallest currency unit. Required for L2 rates. An integer greater than or equal to 0.

      This field is mutually exclusive with the amount_details[line_items][#][tax][total_tax_amount] field.

• application_fee_amountintegerConnect only

  The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.

• final_captureboolean

  Defaults to true. When capturing a PaymentIntent, setting final_capture to false notifies Stripe to not release the remaining uncaptured funds to make sure that they’re captured in future requests. You can only use this setting when multicapture is available for PaymentIntents.

• hooksobject

  Automations to be run during the PaymentIntent lifecycle

  Hide child parameters

  • hooks.inputsobject

    Arguments passed in automations

    Hide child parameters

    • hooks.inputs.taxobject

      Tax arguments for automations

      Hide child parameters

      • hooks.inputs.tax.calculationstringRequired

        The TaxCalculation id

• payment_detailsobject

  Provides industry-specific information about the charge.

  Hide child parameters

  • payment_details.car_rental_dataarray of objectsPreview feature

    Car rental data for this PaymentIntent.

    Hide child parameters

    • payment_details.car_rental_data.drop_offobjectRequired

      Drop-off location details.

      Hide child parameters

      • payment_details.car_rental_data.drop_off.addressobjectRequired

        Address of the rental location.

        Hide child parameters

        • payment_details.car_rental_data.drop_off.address.citystringRequired

          City, district, suburb, town, or village.

        • payment_details.car_rental_data.drop_off.address.countrystringRequired

          Two-letter country code (ISO 3166-1 alpha-2).

        • payment_details.car_rental_data.drop_off.address.line1stringRequired

          Address line 1, such as the street, PO Box, or company name.

        • payment_details.car_rental_data.drop_off.address.postal_codestringRequired

          ZIP or postal code.

        • payment_details.car_rental_data.drop_off.address.line2string

          Address line 2, such as the apartment, suite, unit, or building.

        • payment_details.car_rental_data.drop_off.address.statestring

          State, county, province, or region.

      • payment_details.car_rental_data.drop_off.timetimestampRequired

        Timestamp for the location.

      • payment_details.car_rental_data.drop_off.location_namestring

        Location name.

    • payment_details.car_rental_data.pickupobjectRequired

      Pickup location details.

      Hide child parameters

      • payment_details.car_rental_data.pickup.addressobjectRequired

        Address of the rental location.

        Hide child parameters

        • payment_details.car_rental_data.pickup.address.citystringRequired

          City, district, suburb, town, or village.

        • payment_details.car_rental_data.pickup.address.countrystringRequired

          Two-letter country code (ISO 3166-1 alpha-2).

        • payment_details.car_rental_data.pickup.address.line1stringRequired

          Address line 1, such as the street, PO Box, or company name.

        • payment_details.car_rental_data.pickup.address.postal_codestringRequired

          ZIP or postal code.

        • payment_details.car_rental_data.pickup.address.line2string

          Address line 2, such as the apartment, suite, unit, or building.

        • payment_details.car_rental_data.pickup.address.statestring

          State, county, province, or region.

      • payment_details.car_rental_data.pickup.timetimestampRequired

        Timestamp for the location.

      • payment_details.car_rental_data.pickup.location_namestring

        Location name.

    • payment_details.car_rental_data.totalobjectRequired

      Total cost breakdown for the rental.

      Hide child parameters

      • payment_details.car_rental_data.total.amountintegerRequired

        Total amount in cents.

      • payment_details.car_rental_data.total.currencyenum

        Currency of the amount.

      • payment_details.car_rental_data.total.discountsobject

        Discount details for the rental.

        Hide child parameters

        • payment_details.car_rental_data.total.discounts.corporate_client_codestring

          Corporate client discount code.

        • payment_details.car_rental_data.total.discounts.couponstring

          Coupon code applied to the rental.

        • payment_details.car_rental_data.total.discounts.maximum_free_miles_or_kilometersinteger

          Maximum number of free miles or kilometers included.

      • payment_details.car_rental_data.total.extra_chargesarray of objects

        Additional charges for the rental.

        Hide child parameters

        • payment_details.car_rental_data.total.extra_charges.amountintegerRequired

          Amount of the extra charge in cents.

        • payment_details.car_rental_data.total.extra_charges.typeenumRequired

          Type of extra charge.

          Possible enum values

          extra_mileage Additional charges for exceeding the included mileage.

          gas Fuel charges.

          gps GPS navigation system rental fee.

          late_charge Fee for late return of the vehicle.

          one_way_drop_off Fee for dropping off the vehicle at a different location.

          other Other miscellaneous extra charges.

          parking Parking charges.

          phone Mobile phone or hands-free device rental fee.

          regular_mileage Standard mileage charges.

          towing Towing charges.

      • payment_details.car_rental_data.total.rate_per_unitinteger

        Rate per unit for the rental.

      • payment_details.car_rental_data.total.rate_unitenum

        Unit of measurement for the rate.

        Possible enum values

        days Rental rate charged per day.

        kilometers Rental rate charged per kilometer.

        miles Rental rate charged per mile.

        months Rental rate charged per month.

        weeks Rental rate charged per week.

      • payment_details.car_rental_data.total.taxobject

        Tax breakdown for the rental.

        Hide child parameters

        • payment_details.car_rental_data.total.tax.tax_exempt_indicatorboolean

          Indicates if the transaction is tax exempt.

        • payment_details.car_rental_data.total.tax.taxesarray of objects

          Array of tax details.

          Hide child parameters

          • payment_details.car_rental_data.total.tax.taxes.amountinteger

            Tax amount.

          • payment_details.car_rental_data.total.tax.taxes.rateinteger

            Tax rate applied.

          • payment_details.car_rental_data.total.tax.taxes.typestring

            Type of tax applied.

    • payment_details.car_rental_data.affiliateobject

      Affiliate (such as travel agency) details for the rental.

      Hide child parameters

      • payment_details.car_rental_data.affiliate.codestring

        Affiliate partner code.

      • payment_details.car_rental_data.affiliate.namestring

        Name of affiliate partner.

    • payment_details.car_rental_data.booking_numberstring

      Booking confirmation number for the car rental.

    • payment_details.car_rental_data.carrier_namestring

      Name of the car rental company.

    • payment_details.car_rental_data.customer_service_phone_numberstring

      Customer service phone number for the car rental company.

    • payment_details.car_rental_data.days_rentedinteger

      Number of days the car is being rented.

    • payment_details.car_rental_data.distanceobject

      Distance details for the rental.

      Hide child parameters

      • payment_details.car_rental_data.distance.amountintegerRequired

        Distance traveled.

      • payment_details.car_rental_data.distance.unitenumRequired

        Unit of measurement for the distance traveled. One of miles or kilometers.

    • payment_details.car_rental_data.driversarray of objects

      List of drivers for the rental.

      Hide child parameters

      • payment_details.car_rental_data.drivers.namestringRequired

        Driver’s full name.

      • payment_details.car_rental_data.drivers.date_of_birthobject

        Driver’s date of birth.

        Hide child parameters

        • payment_details.car_rental_data.drivers.date_of_birth.dayintegerRequired

          Day of birth (1-31).

        • payment_details.car_rental_data.drivers.date_of_birth.monthintegerRequired

          Month of birth (1-12).

        • payment_details.car_rental_data.drivers.date_of_birth.yearintegerRequired

          Year of birth (must be greater than 1900).

      • payment_details.car_rental_data.drivers.driver_identification_numberstring

        Driver’s identification number.

      • payment_details.car_rental_data.drivers.driver_tax_numberstring

        Driver’s tax number.

    • payment_details.car_rental_data.insurancesarray of objects

      Insurance details for the rental.

      Hide child parameters

      • payment_details.car_rental_data.insurances.amountintegerRequired

        Amount of the insurance coverage in cents.

      • payment_details.car_rental_data.insurances.insurance_typeenumRequired

        Type of insurance coverage.

        Possible enum values

        liability_supplement Supplemental liability insurance coverage.

        loss_damage_waiver Agreement waiving responsibility for loss or damage to the vehicle.

        other Other types of insurance coverage.

        partial_damage_waiver Agreement limiting responsibility for loss or damage to the vehicle.

        personal_accident Insurance covering personal accidents during the rental period.

        personal_effects Insurance covering personal belongings during the rental period.

      • payment_details.car_rental_data.insurances.currencyenum

        Currency of the insurance amount.

      • payment_details.car_rental_data.insurances.insurance_company_namestring

        Name of the insurance company.

    • payment_details.car_rental_data.no_show_indicatorboolean

      Indicates if the customer was a no-show.

    • payment_details.car_rental_data.renter_namestring

      Name of the person renting the vehicle.

    • payment_details.car_rental_data.vehicleobject

      Vehicle details for the rental.

      Hide child parameters

      • payment_details.car_rental_data.vehicle.makestring

        Make of the rental vehicle.

      • payment_details.car_rental_data.vehicle.modelstring

        Model of the rental vehicle.

      • payment_details.car_rental_data.vehicle.odometerinteger

        Odometer reading at the time of rental.

      • payment_details.car_rental_data.vehicle.typeenum

        Type of the rental vehicle.

        Possible enum values

        cargo_van Van designed for cargo transport.

        compact Compact car.

        economy Economy-class car.

        exotic Exotic or high-performance vehicle.

        exotic_suv Exotic or luxury sport utility vehicle.

        fifteen_passenger_van Van with capacity for fifteen passengers.

        four_wheel_drive Four-wheel-drive vehicle.

        full_size Full-sized car.

        intermediate Intermediate-sized car.

        large_suv Large sport utility vehicle.

        Show 24 more

      • payment_details.car_rental_data.vehicle.vehicle_classenum

        Class of the rental vehicle.

        Possible enum values

        business Business class vehicle.

        economy Economy class vehicle.

        first_class First class vehicle with premium amenities.

        premium_economy Premium economy class vehicle with enhanced features.

      • payment_details.car_rental_data.vehicle.vehicle_identification_numberstring

        Vehicle identification number (VIN).

  • payment_details.customer_referencestring

    A unique value to identify the customer. This field is available only for card payments.

    This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.

  • payment_details.flight_dataarray of objectsPreview feature

    Flight data for this PaymentIntent.

    Hide child parameters

    • payment_details.flight_data.segmentsarray of objectsRequired

      List of flight segments.

      Hide child parameters

      • payment_details.flight_data.segments.arrivalobjectRequired

        Arrival details.

        Hide child parameters

        • payment_details.flight_data.segments.arrival.airportstringRequired

          Arrival airport IATA code.

        • payment_details.flight_data.segments.arrival.arrives_attimestamp

          Arrival date/time.

        • payment_details.flight_data.segments.arrival.citystring

          Arrival city.

        • payment_details.flight_data.segments.arrival.countrystring

          Arrival country.

      • payment_details.flight_data.segments.carrier_codestringRequired

        Airline carrier code.

      • payment_details.flight_data.segments.departureobjectRequired

        Departure details.

        Hide child parameters

        • payment_details.flight_data.segments.departure.airportstringRequired

          Departure airport IATA code.

        • payment_details.flight_data.segments.departure.departs_attimestampRequired

          Departure date/time.

        • payment_details.flight_data.segments.departure.citystring

          Departure city.

        • payment_details.flight_data.segments.departure.countrystring

          Departure country.

      • payment_details.flight_data.segments.service_classenumRequired

        Class of service.

        Possible enum values

        business Business class seating.

        economy Economy class seating.

        first_class First class seating with premium amenities.

        premium_economy Premium economy class with enhanced seating and services.

      • payment_details.flight_data.segments.amountinteger

        Segment fare amount.

      • payment_details.flight_data.segments.carrier_namestring

        Carrier name.

      • payment_details.flight_data.segments.currencyenum

        Segment currency.

      • payment_details.flight_data.segments.exchange_ticket_numberstring

        Exchange ticket number.

      • payment_details.flight_data.segments.fare_basis_codestring

        Fare basis code.

      • payment_details.flight_data.segments.feesinteger

        Additional fees.

      • payment_details.flight_data.segments.flight_numberstring

        Flight number.

      • payment_details.flight_data.segments.is_stop_over_indicatorboolean

        Stopover indicator.

      • payment_details.flight_data.segments.refundableboolean

        Refundable ticket indicator.

      • payment_details.flight_data.segments.tax_amountinteger

        Tax amount for segment.

      • payment_details.flight_data.segments.ticket_numberstring

        Ticket number.

    • payment_details.flight_data.totalobjectRequired

      Total cost breakdown.

      Hide child parameters

      • payment_details.flight_data.total.amountintegerRequired

        Total flight amount.

      • payment_details.flight_data.total.credit_reasonenum

        Reason for credit.

        Possible enum values

        other Other credit reasons.

        partial_ticket_refund Partial refund of the ticket cost.

        passenger_transport_ancillary_cancellation Cancellation of passenger transport and ancillary services.

        ticket_and_ancillary_cancellation Cancellation of both ticket and ancillary services.

        ticket_cancellation Cancellation of the ticket only.

      • payment_details.flight_data.total.currencyenum

        Total currency.

      • payment_details.flight_data.total.discountsobject

        Discount details.

        Hide child parameters

        • payment_details.flight_data.total.discounts.corporate_client_codestring

          Corporate client discount code.

      • payment_details.flight_data.total.extra_chargesarray of objects

        Additional charges.

        Hide child parameters

        • payment_details.flight_data.total.extra_charges.amountinteger

          Amount of additional charges.

        • payment_details.flight_data.total.extra_charges.typeenum

          Type of additional charges.

          Possible enum values

          additional_fees Additional fees charged for the flight.

          ancillary_service_charges Charges for ancillary services such as baggage, seat selection, or meals.

          exchange_fee Fee charged for exchanging or changing the ticket.

      • payment_details.flight_data.total.taxobject

        Tax breakdown.

        Hide child parameters

        • payment_details.flight_data.total.tax.taxesarray of objects

          Array of tax details.

          Hide child parameters

          • payment_details.flight_data.total.tax.taxes.amountinteger

            Tax amount.

          • payment_details.flight_data.total.tax.taxes.rateinteger

            Tax rate.

          • payment_details.flight_data.total.tax.taxes.typestring

            Type of tax.

    • payment_details.flight_data.affiliateobject

      Affiliate details if applicable.

      Hide child parameters

      • payment_details.flight_data.affiliate.codestring

        Affiliate partner code.

      • payment_details.flight_data.affiliate.namestring

        Name of affiliate partner.

      • payment_details.flight_data.affiliate.travel_authorization_codestring

        Code provided by the company to a travel agent authorizing ticket issuance.

    • payment_details.flight_data.booking_numberstring

      Reservation reference.

    • payment_details.flight_data.computerized_reservation_systemstring

      Computerized reservation system used to make the reservation and purchase the ticket.

    • payment_details.flight_data.endorsements_and_restrictionsstring

      Ticket restrictions.

    • payment_details.flight_data.insurancesarray of objects

      List of insurances.

      Hide child parameters

      • payment_details.flight_data.insurances.amountintegerRequired

        Insurance cost.

      • payment_details.flight_data.insurances.insurance_typeenumRequired

        Type of insurance.

        Possible enum values

        baggage Insurance covering lost, damaged, or delayed baggage.

        bankruptcy Insurance covering losses due to airline bankruptcy.

        cancelation Insurance covering flight cancellation.

        emergency Insurance covering general emergency situations.

        medical Insurance covering medical emergencies during travel.

      • payment_details.flight_data.insurances.currencyenum

        Insurance currency.

      • payment_details.flight_data.insurances.insurance_company_namestring

        Insurance company name.

    • payment_details.flight_data.passengersarray of objects

      List of passengers.

      Hide child parameters

      • payment_details.flight_data.passengers.namestringRequired

        Passenger’s full name.

    • payment_details.flight_data.ticket_electronically_issued_indicatorboolean

      Electronic ticket indicator.

    • payment_details.flight_data.transaction_typeenum

      Type of flight transaction.

      Possible enum values

      exchange_ticket Exchange or modification of an existing ticket.

      miscellaneous Other miscellaneous flight-related transactions.

      refund Refund for a canceled or unused ticket.

      ticket_purchase Purchase of a new flight ticket.

  • payment_details.lodging_dataarray of objectsPreview feature

    Lodging data for this PaymentIntent.

    Hide child parameters

    • payment_details.lodging_data.checkin_attimestampRequired

      Check-in date.

    • payment_details.lodging_data.checkout_attimestampRequired

      Check-out date.

    • payment_details.lodging_data.totalobjectRequired

      Total details for the lodging.

      Hide child parameters

      • payment_details.lodging_data.total.amountintegerRequired

        Total price of the lodging reservation in cents.

      • payment_details.lodging_data.total.cash_advancesinteger

        Cash advances in cents.

      • payment_details.lodging_data.total.currencyenum

        Currency of the total amount.

      • payment_details.lodging_data.total.discountsobject

        Discount details for the lodging.

        Hide child parameters

        • payment_details.lodging_data.total.discounts.corporate_client_codestring

          Corporate client discount code.

        • payment_details.lodging_data.total.discounts.couponstring

          Coupon code.

      • payment_details.lodging_data.total.extra_chargesarray of objects

        Additional charges for the lodging.

        Hide child parameters

        • payment_details.lodging_data.total.extra_charges.amountinteger

          Amount of the extra charge in cents.

        • payment_details.lodging_data.total.extra_charges.typeenum

          Type of extra charge.

          Possible enum values

          gift_shop Charges for gift shop purchases.

          laundry Charges for laundry or cleaning services.

          mini_bar Charges for mini bar consumption.

          other Other miscellaneous charges.

          phone Charges for telephone services.

          restaurant Charges for dining or food services.

      • payment_details.lodging_data.total.prepaid_amountinteger

        Prepaid amount in cents.

      • payment_details.lodging_data.total.taxobject

        Tax breakdown for the lodging reservation.

        Hide child parameters

        • payment_details.lodging_data.total.tax.tax_exempt_indicatorboolean

          Indicates whether the transaction is tax exempt.

        • payment_details.lodging_data.total.tax.taxesarray of objects

          Tax details.

          Hide child parameters

          • payment_details.lodging_data.total.tax.taxes.amountinteger

            Tax amount in cents.

          • payment_details.lodging_data.total.tax.taxes.rateinteger

            Tax rate.

          • payment_details.lodging_data.total.tax.taxes.typestring

            Type of tax applied.

    • payment_details.lodging_data.accommodationobject

      Accommodation details for the lodging.

      Hide child parameters

      • payment_details.lodging_data.accommodation.accommodation_typeenum

        Type of accommodation.

        Possible enum values

        apartment A self-contained apartment unit.

        cabana A cabana or small cabin.

        house A standalone house.

        penthouse A penthouse or top-floor luxury accommodation.

        room A standard room.

        standard A standard accommodation type.

        suite A suite with multiple rooms or enhanced amenities.

        villa A villa or luxury residence.

      • payment_details.lodging_data.accommodation.bed_typestring

        Bed type.

      • payment_details.lodging_data.accommodation.daily_rate_amountinteger

        Daily accommodation rate in cents.

      • payment_details.lodging_data.accommodation.nightsinteger

        Number of nights.

      • payment_details.lodging_data.accommodation.number_of_roomsinteger

        Number of rooms, cabanas, apartments, and so on.

      • payment_details.lodging_data.accommodation.rate_typestring

        Rate type.

      • payment_details.lodging_data.accommodation.smoking_indicatorboolean

        Whether smoking is allowed.

    • payment_details.lodging_data.affiliateobject

      Affiliate details if applicable.

      Hide child parameters

      • payment_details.lodging_data.affiliate.codestring

        Affiliate partner code.

      • payment_details.lodging_data.affiliate.namestring

        Affiliate partner name.

    • payment_details.lodging_data.booking_numberstring

      Booking confirmation number for the lodging.

    • payment_details.lodging_data.customer_service_phone_numberstring

      Customer service phone number for the lodging company.

    • payment_details.lodging_data.fire_safety_act_compliance_indicatorboolean

      Whether the lodging is compliant with any hotel fire safety regulations.

    • payment_details.lodging_data.guestsarray of objects

      List of guests for the lodging.

      Hide child parameters

      • payment_details.lodging_data.guests.namestringRequired

        Guest’s full name.

    • payment_details.lodging_data.hostobject

      Host details for the lodging.

      Hide child parameters

      • payment_details.lodging_data.host.addressobject

        Address of the host.

        Hide child parameters

        • payment_details.lodging_data.host.address.citystringRequired

          City, district, suburb, town, or village.

        • payment_details.lodging_data.host.address.countrystringRequired

          Two-letter country code (ISO 3166-1 alpha-2).

        • payment_details.lodging_data.host.address.line1stringRequired

          Address line 1, such as the street, PO Box, or company name.

        • payment_details.lodging_data.host.address.postal_codestringRequired

          ZIP or postal code.

        • payment_details.lodging_data.host.address.line2string

          Address line 2, such as the apartment, suite, unit, or building.

        • payment_details.lodging_data.host.address.statestring

          State, county, province, or region.

      • payment_details.lodging_data.host.country_of_domicilestring

        Host’s country of domicile.

      • payment_details.lodging_data.host.host_referencestring

        Reference number for the host.

      • payment_details.lodging_data.host.host_typeenum

        Type of host.

        Possible enum values

        hostel A hostel or shared accommodation facility.

        hotel A hotel or hotel chain.

        owner The property owner directly managing the rental.

        rental_agency A rental agency managing the property.

      • payment_details.lodging_data.host.namestring

        Name of the lodging property or host.

      • payment_details.lodging_data.host.number_of_reservationsinteger

        Total number of reservations for the host.

      • payment_details.lodging_data.host.property_phone_numberstring

        Property phone number.

      • payment_details.lodging_data.host.registered_attimestamp

        Host’s registration date.

    • payment_details.lodging_data.insurancesarray of objects

      List of insurances for the lodging.

      Hide child parameters

      • payment_details.lodging_data.insurances.amountintegerRequired

        Price of the insurance coverage in cents.

      • payment_details.lodging_data.insurances.insurance_typeenumRequired

        Type of insurance coverage.

        Possible enum values

        bankruptcy Insurance covering losses due to provider bankruptcy.

        cancelation Insurance covering cancellation.

        emergency Insurance covering general emergency situations.

        medical Insurance covering medical emergencies during the stay.

      • payment_details.lodging_data.insurances.currencyenum

        Currency of the insurance amount.

      • payment_details.lodging_data.insurances.insurance_company_namestring

        Name of the insurance company.

    • payment_details.lodging_data.no_show_indicatorboolean

      Whether the renter is a no-show.

    • payment_details.lodging_data.renter_id_numberstring

      Renter ID number for the lodging.

    • payment_details.lodging_data.renter_namestring

      Renter name for the lodging.

  • payment_details.order_referencestring

    A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.

    Required when the Payment Method Types array contains card, including when automatic_payment_methods.enabled is set to true.

    For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.

• statement_descriptorstring

  Text that appears on the customer’s statement as the statement descriptor for a non-card charge. This value overrides the account’s default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

  Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

• statement_descriptor_suffixstring

  Provides information about a card charge. Concatenated to the account’s statement descriptor prefix to form the complete statement descriptor that appears on the customer’s statement.

• transfer_dataobjectConnect only

  The parameters that you can use to automatically create a transfer after the payment is captured. Learn more about the use case for connected accounts.

  Hide child parameters

  • transfer_data.amountinteger

    The amount that will be transferred automatically when a charge succeeds.