Order With Payment

POST {{host_gateway}}/api/partner/orders/with-payment

This endpoint facilitates the creation of an order while simultaneously passing credit card data to charge the order being created. It is specifically designed for customers who prefer to submit all necessary information in a single call, streamlining the process.

Notes:

The order created through this endpoint does not transition to the 'approved' state until the payment processor successfully handles the payment.

Request Body

{"order"=>{"total"=>673.99, "quote_id"=>"quote-id", "currency_id"=>"USD", "sanction_search_id"=>0, "product_id"=>"12106ae7-05f3-4b57-8827-373f58242c6b", "start_at"=>"{{start_date}}", "end_at"=>"{{end_date}}", "deposit_at"=>"{{current_date}}", "details"=>[{"product_package_id"=>"trip_interruption", "type"=>"package"}, {"product_package_id"=>"trip_cancellation_package", "type"=>"package"}, {"product_package_id"=>"cancel_for_any_reason", "type"=>"package"}, {"product_package_id"=>"rental_vehicle_damage", "type"=>"package"}, {"product_package_id"=>"pet_travel_package", "type"=>"package"}, {"product_package_id"=>"travel_medical_package", "type"=>"package"}, {"product_package_id"=>"baggage_package", "type"=>"package"}, {"product_package_id"=>"delay_package", "type"=>"package"}, {"product_package_id"=>"vacation_rental_damage", "type"=>"package"}, {"product_package_id"=>"vacation_rental_damage", "type"=>"reservations", "amount"=>3}, {"product_package_id"=>"vacation_rental_damage", "type"=>"limit", "detail"=>"benefit_limit", "for"=>"vacation_rental_damage", "value"=>"1500"}, {"product_package_id"=>"accidental_death_and_dismemberment", "type"=>"package"}, {"product_package_id"=>"accidental_death_and_dismemberment", "type"=>"limit", "detail"=>"benefit_limit", "for"=>"non_flight_accidental_death_and_dismemberment", "value"=>"100000"}], "applicants"=>[{"first_name"=>"John", "middle_name"=>"Doe", "last_name"=>"Johnson", "email"=>"test@battleface.com", "dob"=>"1990-01-01", "age_at_travel"=>28, "contact_number"=>"1234567890", "address"=>"123 Tester Street", "city"=>"Columbus", "post_code"=>"43201", "country_code"=>"US", "state_code"=>"OH", "is_main"=>true, "trip_cost"=>10000}], "destinations"=>[{"country_code"=>"US"}]}, "payment"=>{"type"=>"charge", "detail"=>{"card_exp_month"=>"12", "card_exp_year"=>"2024", "card_number"=>"4242424242424242", "card_cvc"=>"1234"}}}

RESPONSES

status: Created

{&quot;data&quot;:{&quot;order&quot;:{&quot;schema_version&quot;:1,&quot;site_id&quot;:1,&quot;quote_id&quot;:&quot;quote-id&quot;,&quot;order_number&quot;:&quot;1-MAY93E2-A6DB1DB06780&quot;,&quot;client_referral_code&quot;:&quot;&quot;,&quot;client_id&quot;:48702,&quot;status&quot;:&quot;Pending&quot;,&quot;premium&quot;:673.99,&quot;total&quot;:673.99,&quot;currency_id&quot;:&quot;USD&quot;,&quot;status_updated_at&quot;:&quot;2024-05-06T12:10:58.039000Z&quot;,&quot;ordered_at&quot;:&quot;2024-05-06T12:10:57.571000Z&quot;,&quot;items&quot;:[{&quot;id&quot;:&quot;7b3e4c9f-5631-4706-a139-f3266cda3b03&quot;,&quot;product_id&quot;:1042,&quot;program_id&quot;:23,&quot;product_uuid&quot;:&quot;12106ae7-05f3-4b57-8827-373f58242c6b&quot;,&quot;product_name&quot;:&quot;Discovery&quot;,&quot;sanction_search_id&quot;:&quot;0&quot;,&quot;product_major_id&quot;:44,&quot;product_minor_id&quot;:1714,&quot;policy_file_id&quot;:null,&quot;policy_number&quot;:&quot;BFBF DIS0506240008&quot;,&quot;start_at&quot;:&quot;2024-05-21&quot;,&quot;end_at&quot;:&quot;2024-06-04&quot;,&quot;deposit_at&quot;:&quot;2024-05-06&quot;,&quot;details&quot;:[{&quot;id&quot;:&quot;45b5fd0b-c3f4-47e5-9e16-5282f380a504&quot;,&quot;type&quot;:&quot;package&quot;,&quot;detail&quot;:&quot;Trip Interruption&quot;,&quot;amount&quot;:23.67,&quot;product_package_id&quot;:14969},{&quot;id&quot;:&quot;9399c920-fcc9-4cdc-adb3-e5e1cf67dded&quot;,&quot;type&quot;:&quot;package&quot;,&quot;detail&quot;:&quot;Trip Cancellation&quot;,&quot;amount&quot;:87.82,&quot;product_package_id&quot;:14970},{&quot;id&quot;:&quot;f4006579-e86b-48ff-a3f8-ce71212dc7fc&quot;,&quot;type&quot;:&quot;package&quot;,&quot;detail&quot;:&quot;Cancel For Any Reason&quot;,&quot;amount&quot;:113.44,&quot;product_package_id&quot;:14971},{&quot;id&quot;:&quot;e20e2f5a-f325-449b-9e9d-33828e679692&quot;,&quot;type&quot;:&quot;package&quot;,&quot;detail&quot;:&quot;Rental Vehicle Damage&quot;,&quot;amount&quot;:180.6,&quot;product_package_id&quot;:14972},{&quot;id&quot;:&quot;59377abb-3df1-4a66-b08f-88dd8eed595d&quot;,&quot;type&quot;:&quot;package&quot;,&quot;detail&quot;:&quot;Pet Travel Package&quot;,&quot;amount&quot;:11.01,&quot;product_package_id&quot;:14974},{&quot;id&quot;:&quot;228dc629-2d95-487b-927f-c14d7b6725ba&quot;,&quot;type&quot;:&quot;package&quot;,&quot;detail&quot;:&quot;Travel Medical Package&quot;,&quot;amount&quot;:21.61,&quot;product_package_id&quot;:14975},{&quot;id&quot;:&quot;764d7990-2c70-45a4-a0ef-1659dae1a268&quot;,&quot;type&quot;:&quot;package&quot;,&quot;detail&quot;:&quot;Baggage Package&quot;,&quot;amount&quot;:18.05,&quot;product_package_id&quot;:14976},{&quot;id&quot;:&quot;2e0e43ea-94d8-4509-88b0-96b44fda7446&quot;,&quot;type&quot;:&quot;package&quot;,&quot;detail&quot;:&quot;Delay Package&quot;,&quot;amount&quot;:17.24,&quot;product_package_id&quot;:14977},{&quot;id&quot;:&quot;62e73da5-0c29-4540-81fc-47a8a3350744&quot;,&quot;type&quot;:&quot;package&quot;,&quot;detail&quot;:&quot;Vacation Rental Damage Package&quot;,&quot;amount&quot;:57.5,&quot;product_package_id&quot;:14973},{&quot;id&quot;:&quot;6d27bafb-ca05-48b3-a428-fa47ccdc8a9a&quot;,&quot;type&quot;:&quot;reservations&quot;,&quot;amount&quot;:3,&quot;product_package_id&quot;:14973},{&quot;id&quot;:&quot;e30febca-0a0c-45da-a29d-9f5def4b0958&quot;,&quot;type&quot;:&quot;limit&quot;,&quot;detail&quot;:&quot;benefit_limit&quot;,&quot;for&quot;:&quot;vacation_rental_damage&quot;,&quot;value&quot;:&quot;1500&quot;,&quot;product_package_id&quot;:14973},{&quot;id&quot;:&quot;ddb27bd1-2570-41c9-8a87-16db8d01dfa9&quot;,&quot;type&quot;:&quot;package&quot;,&quot;detail&quot;:&quot;Accidental Death and Dismemberment Package&quot;,&quot;amount&quot;:28.05,&quot;product_package_id&quot;:14978},{&quot;id&quot;:&quot;1ae4359d-2d10-42c1-8c6f-602bb141119b&quot;,&quot;type&quot;:&quot;limit&quot;,&quot;detail&quot;:&quot;benefit_limit&quot;,&quot;for&quot;:&quot;non_flight_accidental_death_and_dismemberment&quot;,&quot;value&quot;:&quot;100000&quot;,&quot;product_package_id&quot;:14978},{&quot;id&quot;:&quot;5fb1c6a7-e83f-4dc5-a16b-a3ffd50f4c23&quot;,&quot;type&quot;:&quot;trip_cost&quot;,&quot;amount&quot;:10000},{&quot;id&quot;:&quot;2e12fae8-7c77-480b-8922-bd849708c701&quot;,&quot;type&quot;:&quot;minimum&quot;,&quot;detail&quot;:&quot;package&quot;,&quot;for&quot;:&quot;package&quot;,&quot;amount&quot;:0,&quot;value&quot;:&quot;0&quot;,&quot;product_package_id&quot;:14978},{&quot;id&quot;:&quot;fff6cdc7-8d51-4c8a-b49c-544dcede65a9&quot;,&quot;type&quot;:&quot;premium&quot;,&quot;detail&quot;:&quot;Policy premium&quot;,&quot;amount&quot;:673.99},{&quot;id&quot;:&quot;d016b112-79a1-45d3-8f30-ff5d463fa2aa&quot;,&quot;type&quot;:&quot;total&quot;,&quot;detail&quot;:&quot;Policy total&quot;,&quot;amount&quot;:673.99}],&quot;insured&quot;:{&quot;first_name&quot;:&quot;John&quot;,&quot;middle_name&quot;:&quot;Doe&quot;,&quot;last_name&quot;:&quot;Johnson&quot;,&quot;dob&quot;:&quot;1990-01-01&quot;},&quot;is_main&quot;:true,&quot;order&quot;:{&quot;total&quot;:673.99,&quot;quote_id&quot;:&quot;quote-id&quot;,&quot;currency_id&quot;:&quot;USD&quot;,&quot;site_id&quot;:1,&quot;ordered_at&quot;:&quot;2024-05-06T12:10:57.571000Z&quot;,&quot;applicant&quot;:{&quot;first_name&quot;:&quot;John&quot;,&quot;middle_name&quot;:&quot;Doe&quot;,&quot;last_name&quot;:&quot;Johnson&quot;,&quot;email&quot;:&quot;test@battleface.com&quot;,&quot;dob&quot;:&quot;1990-01-01&quot;,&quot;age_at_travel&quot;:28,&quot;contact_number&quot;:&quot;1234567890&quot;,&quot;address&quot;:&quot;123 Tester Street&quot;,&quot;city&quot;:&quot;Columbus&quot;,&quot;post_code&quot;:&quot;43201&quot;,&quot;country_code&quot;:&quot;US&quot;,&quot;state_code&quot;:&quot;OH&quot;,&quot;ip_address&quot;:&quot;172.31.40.219&quot;},&quot;flags&quot;:{&quot;send_policy_emails&quot;:true,&quot;generate_policy_document&quot;:true,&quot;trigger_sanction_search&quot;:true},&quot;order_number&quot;:&quot;1-MAY93E2-A6DB1DB06780&quot;,&quot;premium&quot;:673.99,&quot;fees&quot;:0,&quot;tax&quot;:0,&quot;refund_amount&quot;:0,&quot;is_refunded&quot;:false,&quot;tax_rate&quot;:0,&quot;schema_version&quot;:1,&quot;document_version&quot;:1,&quot;status&quot;:&quot;Pending&quot;,&quot;status_updated_at&quot;:&quot;2024-05-06T12:10:58.039000Z&quot;,&quot;client_id&quot;:48702,&quot;client_referral_code&quot;:&quot;&quot;,&quot;referral_code&quot;:null,&quot;updated_at&quot;:&quot;2024-05-06T12:10:59.374000Z&quot;,&quot;created_at&quot;:&quot;2024-05-06T12:10:59.374000Z&quot;,&quot;_id&quot;:&quot;6638c8d38133d1a93c07da39&quot;,&quot;meta&quot;:null,&quot;details&quot;:[]},&quot;meta&quot;:null,&quot;destinations&quot;:[{&quot;country_code&quot;:&quot;US&quot;,&quot;country_name&quot;:&quot;United States of America&quot;}]}],&quot;applicant&quot;:{&quot;first_name&quot;:&quot;John&quot;,&quot;middle_name&quot;:&quot;Doe&quot;,&quot;last_name&quot;:&quot;Johnson&quot;,&quot;dob&quot;:&quot;1990-01-01&quot;,&quot;age_at_travel&quot;:28,&quot;email&quot;:&quot;test@battleface.com&quot;,&quot;contact_number&quot;:&quot;1234567890&quot;,&quot;address&quot;:&quot;123 Tester Street&quot;,&quot;city&quot;:&quot;Columbus&quot;,&quot;post_code&quot;:&quot;43201&quot;,&quot;country_code&quot;:&quot;US&quot;,&quot;state_code&quot;:&quot;OH&quot;,&quot;ip_address&quot;:&quot;172.31.40.219&quot;},&quot;affiliate&quot;:{&quot;id&quot;:1,&quot;commission_amount&quot;:0,&quot;commission_percentage&quot;:0,&quot;contact_email&quot;:&quot;jchapelle@battleface.com&quot;},&quot;details&quot;:[]},&quot;payment&quot;:{&quot;type&quot;:&quot;charge&quot;,&quot;detail&quot;:{&quot;id&quot;:&quot;ch_3PDQNkDSrWezmkkZ0JhieKqv&quot;,&quot;merchantToken&quot;:&quot;285909f2b02007c65bf44f9e0759c72b&quot;,&quot;customerToken&quot;:&quot;94f3991265438ba5e3ac1f12955c9f9e&quot;,&quot;name&quot;:&quot;Stripe&quot;,&quot;status&quot;:&quot;Approved&quot;}}}}