[{"data":1,"prerenderedAt":634},["ShallowReactive",2],{"header:help":3,"footer:default":63,"story:navigation\u002Fsearch:help":243,"story:help\u002Fcategories":281,"story:help\u002Farticles\u002Fpre-payment-webhook-payload-reference":307,"no-guide:pre-payment-webhook-payload-reference":55,"article:\u002Fhelp\u002Farticles\u002Fpre-payment-webhook-payload-reference":381,"story:contact":391,"help:tree:f355b6c0-90d6-49b2-9bb7-cd272a429792:5c49218e-d3ae-4f94-b450-8f27240924b1":582,"_apollo:default":633},{"name":4,"created_at":5,"published_at":6,"updated_at":7,"id":8,"uuid":9,"content":10,"slug":53,"full_slug":54,"sort_by_date":55,"position":56,"tag_list":57,"is_startpage":24,"parent_id":58,"meta_data":55,"group_id":59,"first_published_at":60,"release_id":55,"lang":61,"path":55,"alternates":62,"default_full_slug":55,"translated_slugs":55},"Help Center Header","2024-08-09T18:06:34.939Z","2026-07-30T21:52:27.962Z","2026-07-30T21:52:27.975Z",10082752,"3e9b88f7-c163-4657-a2f2-62532d600fad",{"_uid":11,"link":12,"badge":16,"items":17,"title":13,"buttons":45,"new_tab":24,"submenu":46,"subitems":47,"alignment":13,"component":48,"badge_link":49,"top_menu_items":52},"e5645a1a-f991-40e8-8d67-e40ebc082b5a",{"id":13,"url":13,"linktype":14,"fieldtype":15,"cached_url":13},"","story","multilink","Help Center",[18,27,34,39],{"_uid":19,"link":20,"title":23,"new_tab":24,"submenu":25,"component":26},"5cbe2861-1f49-4166-97da-a4dddd8105e3",{"id":21,"url":13,"linktype":14,"fieldtype":15,"cached_url":22},"4c0a2d99-ec30-4579-8ef1-6bf5564d4839","help\u002Fcategories\u002F","Articles",false,[],"header___item",{"_uid":28,"link":29,"title":32,"new_tab":33,"component":26},"8d7df70e-f087-4da0-b616-6f0e9a5af35c",{"id":13,"url":30,"linktype":31,"fieldtype":15,"cached_url":30},"https:\u002F\u002Fapi.foxycart.com\u002F","url","API Documentation",true,{"_uid":35,"link":36,"title":38,"new_tab":33,"component":26},"f76e7944-23d5-4652-87e4-cdae79272762",{"id":13,"url":37,"linktype":31,"fieldtype":15,"cached_url":37},"https:\u002F\u002Fstatus.foxy.io\u002F","System Status",{"_uid":40,"link":41,"title":44,"new_tab":24,"component":26},"0de16771-4c84-466c-a1da-d8568113c71f",{"id":42,"url":13,"linktype":14,"fieldtype":15,"cached_url":43},"01e4e370-f9b9-45af-8fa9-f15540699b0d","contact","Contact Us",[],[],[],"header",{"id":50,"url":13,"linktype":14,"fieldtype":15,"cached_url":51},"4a679eb7-662d-4ea4-a976-5a2acbf0b663","help\u002F",[],"help-header","navigation\u002Fhelp-header",null,20,[],10082747,"71b81c2e-5e09-48a1-a397-a3c72fcd344a","2022-09-21T14:50:25.655Z","default",[],{"name":64,"created_at":65,"published_at":66,"updated_at":67,"id":68,"uuid":69,"content":70,"slug":236,"full_slug":237,"sort_by_date":55,"position":238,"tag_list":239,"is_startpage":24,"parent_id":58,"meta_data":55,"group_id":240,"first_published_at":241,"release_id":55,"lang":61,"path":55,"alternates":242,"default_full_slug":55,"translated_slugs":55},"Default Footer","2024-08-09T18:06:59.024Z","2026-07-30T21:52:27.802Z","2026-07-30T21:52:27.816Z",10082753,"e59e67ac-248a-482f-84a1-53d4f318186a",{"_uid":71,"about":72,"logos":73,"socials":78,"sections":104,"component":218,"cta_title":219,"bottom_links":220,"cta_subtitle":234,"cta_button_link":235,"cta_button_text":179},"830983f5-c4c4-43c8-b150-86a5e3fa6dc8","Foxy’s hosted cart & payment page allow you to sell anything, using your existing website or platform.",[74],{"id":75,"alt":13,"name":13,"focus":13,"title":13,"filename":76,"copyright":13,"fieldtype":77},14760,"https:\u002F\u002Fa-us.storyblok.com\u002Ff\u002F1001040\u002Fx\u002F3b030847ec\u002Fb-corp.svg","asset",[79,86,92,98],{"_uid":80,"icon":81,"link":82,"name":84,"component":85},"faf0a618-ea94-42ea-9182-03be18c43216","fa-facebook",{"id":13,"url":83,"linktype":31,"fieldtype":15,"cached_url":83},"https:\u002F\u002Fwww.facebook.com\u002Ffoxycart","Facebook","footer___social",{"_uid":87,"icon":88,"link":89,"name":91,"component":85},"14309c18-7e79-423e-b375-34555bac0811","fa-instagram",{"id":13,"url":90,"linktype":31,"fieldtype":15,"cached_url":90},"https:\u002F\u002Fwww.instagram.com\u002Ffoxy_io","Instagram",{"_uid":93,"icon":94,"link":95,"name":97,"component":85},"8f7fe7cf-0dd3-4596-8334-226ea466716a","fa-linkedin",{"id":13,"url":96,"linktype":31,"fieldtype":15,"cached_url":96},"https:\u002F\u002Fwww.linkedin.com\u002Fcompany\u002Ffoxycart.com","LinkedIn",{"_uid":99,"icon":100,"link":101,"name":103,"component":85},"90a675b4-dd97-40b5-be09-00a87223d4c5","fa-youtube",{"id":13,"url":102,"linktype":31,"fieldtype":15,"cached_url":102},"https:\u002F\u002Fwww.youtube.com\u002Fuser\u002Ffoxycart","Youtube",[105,135,180,202],{"_uid":106,"name":107,"items":108,"component":134},"82849945-282f-488c-b18d-a8d2252f514a","Company",[109,116,122,128],{"_uid":110,"link":111,"title":114,"new_tab":24,"component":115},"1f699ab1-938b-4d9d-9825-aabcbe6f57fe",{"id":112,"url":13,"linktype":14,"fieldtype":15,"cached_url":113},"63634293-a749-4226-9439-9f38ee6dcda0","about-us","About Us","footer___menu_items",{"_uid":117,"link":118,"title":121,"new_tab":24,"component":115},"b26b00f1-a0e7-4be2-8ab3-428b8cc841f8",{"id":119,"url":13,"linktype":14,"fieldtype":15,"cached_url":120},"26cb7c55-faed-4a77-a291-1552d4111b3e","how-foxy-works","How Foxy Works",{"_uid":123,"link":124,"title":127,"new_tab":24,"component":115},"b40c68a0-1ceb-4226-9515-6176534f61fe",{"id":125,"url":13,"linktype":14,"fieldtype":15,"cached_url":126},"dc6657d7-7f4f-4c0d-b781-e971b038ee26","for-good","Foxy For Good",{"_uid":129,"link":130,"title":133,"new_tab":24,"component":115},"3ad0c134-bef9-4fff-b891-e09f16109036",{"id":131,"url":13,"linktype":14,"fieldtype":15,"cached_url":132},"23cae210-baf4-4588-9862-d09f4f52ccd2","brand-assets","Brand Assets","footer___section",{"_uid":136,"name":137,"items":138,"component":134},"a6805fa8-ac60-47f1-b8f0-f27aded0afbe","Product",[139,145,151,157,163,169,175],{"_uid":140,"link":141,"title":144,"new_tab":24,"component":115},"b39c8a4e-2383-486f-b76a-11fbb15d8134",{"id":142,"url":13,"linktype":14,"fieldtype":15,"cached_url":143},"bb04690f-fe98-4ce6-80be-05b950f2364f","features\u002F","Features",{"_uid":146,"link":147,"title":150,"new_tab":24,"component":115},"64f8a41f-c181-433d-bc0a-fc94e71ecbf6",{"id":148,"url":13,"linktype":14,"fieldtype":15,"cached_url":149},"c450c58d-761d-48c0-a9af-0b064611689b","pricing","Pricing",{"_uid":152,"link":153,"title":156,"new_tab":24,"component":115},"6e0b287f-fd8c-4146-9e0e-0ab0b5c9ce3c",{"id":154,"url":13,"linktype":14,"fieldtype":15,"cached_url":155},"fab20ad9-e76a-4947-b709-3a6fdfa88028","blog\u002Fcategories\u002Fproduct-updates","Product Updates",{"_uid":158,"link":159,"title":162,"new_tab":24,"component":115},"47e5a074-a6b5-4f1c-8c2f-89a2ae9f83eb",{"id":160,"url":13,"linktype":14,"fieldtype":15,"cached_url":161},"d2c83612-d611-47f3-a3b4-ca7fe08540b8","changelogs\u002F","Changelogs",{"_uid":164,"link":165,"title":168,"new_tab":24,"component":115},"b5c08774-542f-4ffd-b357-c94d674488b9",{"id":166,"url":13,"linktype":14,"fieldtype":15,"cached_url":167},"08876121-0df3-4ed9-aa11-902b3e41cd02","whats-next","What's Next",{"_uid":170,"link":171,"title":174,"new_tab":24,"component":115},"9c2704ed-6d9f-43e1-9e67-c8d91c083288",{"id":172,"url":13,"linktype":14,"fieldtype":15,"cached_url":173},"056a7857-b18f-4025-8f97-91a38fc19bc8","compare\u002F","Compare",{"_uid":176,"link":177,"title":179,"new_tab":24,"component":115},"5f2db35b-674b-406a-8fa7-d246633af9fe",{"id":13,"url":178,"linktype":31,"fieldtype":15,"cached_url":178},"https:\u002F\u002Fadmin.foxy.io\u002Fsign-up","Try Foxy Free",{"_uid":181,"name":182,"items":183,"component":134},"63fa1f29-4252-4640-9922-fe310e69e54a","Security",[184,190,196],{"_uid":185,"link":186,"title":189,"new_tab":24,"component":115},"1158ddb6-9eb0-466f-8eb6-7ca2ae66c8b8",{"id":187,"url":13,"linktype":14,"fieldtype":15,"cached_url":188},"1f58fb2c-8681-4742-b6e8-09999beae9f6","security-contact","Security Contact",{"_uid":191,"link":192,"title":195,"new_tab":24,"component":115},"9a79c54a-6022-4dfd-854b-766f5e4703ba",{"id":193,"url":13,"linktype":14,"fieldtype":15,"cached_url":194},"55cbfcc3-425a-4261-8037-54e919851d2d","pci","PCI Compliance",{"_uid":197,"link":198,"title":201,"new_tab":24,"component":115},"0b85f5b6-9534-4071-b323-b39d053dd4d7",{"id":199,"url":13,"linktype":14,"fieldtype":15,"cached_url":200},"c3ac0fe3-83e2-4879-afbd-d4c83e1590df","help\u002Farticles\u002Four-official-domains-public-code","Domains & Codebases",{"_uid":203,"name":204,"items":205,"component":134},"998ded67-d107-49f4-8154-ca6be51671ec","Support",[206,209,212,215],{"_uid":207,"link":208,"title":16,"new_tab":24,"component":115},"594ffd35-3049-4004-bb08-0db568ebd819",{"id":50,"url":13,"linktype":14,"fieldtype":15,"cached_url":51},{"_uid":210,"link":211,"title":32,"new_tab":33,"component":115},"61e0b7c8-aadf-419b-a339-b3ccabc65bf4",{"id":13,"url":30,"linktype":31,"fieldtype":15,"cached_url":30},{"_uid":213,"link":214,"title":38,"new_tab":33,"component":115},"fd67a89e-1c54-4d31-94b5-64be999062d6",{"id":13,"url":37,"linktype":31,"fieldtype":15,"cached_url":37},{"_uid":216,"link":217,"title":44,"new_tab":24,"component":115},"231a6f71-e996-4ad4-b033-d4d5542f34f0",{"id":42,"url":13,"linktype":14,"fieldtype":15,"cached_url":43},"footer","Get started with our *unlimited free trial*.",[221,228],{"_uid":222,"link":223,"text":226,"component":227},"f0b77210-2632-45a2-8436-e57cad84d01a",{"id":224,"url":13,"linktype":14,"fieldtype":15,"cached_url":225},"60ba16a2-c1f4-485f-b978-8d2eeeafbf5a","terms-of-service","Terms of Service","footer___bottom_links",{"_uid":229,"link":230,"text":233,"component":227},"4bd497b0-993f-4b4d-a5b7-8a49c7c8fec9",{"id":231,"url":13,"linktype":14,"fieldtype":15,"cached_url":232},"332302b9-1d18-4016-b9c8-9b33c72d782b","privacy-policy","Privacy Policy","No credit card required.",{"id":13,"url":178,"linktype":31,"fieldtype":15,"cached_url":178},"default-footer","navigation\u002Fdefault-footer",50,[],"11006268-07f9-41e9-96f3-c51fb723399d","2022-09-21T20:39:02.357Z",[],{"name":244,"created_at":245,"published_at":246,"updated_at":247,"id":248,"uuid":249,"content":250,"slug":272,"full_slug":275,"sort_by_date":55,"position":276,"tag_list":277,"is_startpage":24,"parent_id":58,"meta_data":55,"group_id":278,"first_published_at":279,"release_id":55,"lang":61,"path":55,"alternates":280,"default_full_slug":55,"translated_slugs":55},"Search","2024-10-21T22:08:54.973Z","2025-05-26T09:17:25.790Z","2025-05-26T09:17:25.804Z",13592003,"14cbc359-9ac1-4a7a-a8de-ad4ac8ef26d4",{"_uid":251,"name":244,"indices":252,"summary":13,"component":272,"primary_image":273},"5e4a56e8-76f1-4790-b3a7-70f1be97d042",[253,258,262,267],{"key":254,"_uid":255,"icon":13,"name":256,"component":257},"all","c12a3210-7323-4273-8217-5215e52efe84","All","index",{"key":259,"_uid":260,"icon":261,"name":23,"component":257},"help_center_article","5acff080-95e4-44d3-8dcf-1b19720af382","fa-file-alt",{"key":263,"_uid":264,"icon":265,"name":266,"component":257},"help_center_guide","b8fbc206-c083-471e-a1f0-0ebeb90a669d","fa-book","Guides",{"key":268,"_uid":269,"icon":270,"name":271,"component":257},"blog_post","23419e83-2e56-4c4c-8a05-9fd1b3c9a9bd","fa-file-image","Blog Posts","search",{"id":55,"alt":55,"name":13,"focus":55,"title":55,"source":55,"filename":13,"copyright":55,"fieldtype":77,"meta_data":274},{},"navigation\u002Fsearch",60,[],"11e1fd31-95cd-4fc9-b736-8b8910663e6c","2024-10-21T23:17:05.904Z",[],{"name":23,"created_at":282,"published_at":283,"updated_at":284,"id":285,"uuid":21,"content":286,"slug":300,"full_slug":22,"sort_by_date":55,"position":301,"tag_list":302,"is_startpage":33,"parent_id":303,"meta_data":55,"group_id":304,"first_published_at":305,"release_id":55,"lang":61,"path":55,"alternates":306,"default_full_slug":55,"translated_slugs":55},"2022-09-19T14:42:29.685Z","2024-07-30T18:17:22.506Z","2024-07-30T18:17:22.525Z",2660,{"_uid":287,"icon":13,"name":23,"guides":288,"pinned":24,"summary":289,"category":13,"component":290,"blog_posts":291,"content_hub":24,"icon_custom":292,"case_studies":293,"faq_sections":294,"help_articles":295,"featured_guides":296,"mailbox_category":13,"featured_articles":297,"featured_blog_posts":298,"featured_case_studies":299},"d6dae89a-907a-4bf7-82de-fe2ba875ee6e",[],"Get your questions answered with our browsable knowledge base.","help_center_category",[],{"id":55,"alt":55,"name":13,"focus":55,"title":55,"filename":13,"copyright":55,"fieldtype":77},[],[],[],[],[],[],[],"categories",530,[],2658,"19ebcdd2-027f-47f5-9a5b-a8992c959578","2022-09-19T16:24:39.219Z",[],{"name":308,"created_at":309,"published_at":310,"updated_at":311,"id":312,"uuid":313,"content":314,"slug":374,"full_slug":375,"sort_by_date":55,"position":376,"tag_list":377,"is_startpage":24,"parent_id":378,"meta_data":55,"group_id":379,"first_published_at":310,"release_id":55,"lang":61,"path":55,"alternates":380,"default_full_slug":55,"translated_slugs":55},"Pre-payment webhook payload reference","2026-07-20T20:24:36.387Z","2026-07-20T20:30:24.725Z","2026-07-20T20:30:25.209Z",200251295332220,"f355b6c0-90d6-49b2-9bb7-cd272a429792",{"_uid":315,"body":316,"name":308,"image":369,"pinned":24,"summary":371,"category":372,"component":259,"related_articles":373},"ee62dafa-8889-427a-8528-cd326b524505",{"type":317,"content":318},"doc",[319,326,331,337,344],{"type":320,"attrs":321,"content":322},"paragraph",{"textAlign":55},[323],{"text":324,"type":325},"When the customer attempts to complete their purchase — after Google reCAPTCHA is validated, if active — a POST request is sent to your custom endpoint with a JSON payload representing the current cart. It follows the same structure as the Hypermedia API, since most of the data comes from there.","text",{"type":320,"attrs":327,"content":328},{"textAlign":55},[329],{"text":330,"type":325},"The following example shows two products (one with live shipping rates) and a coupon applied.",{"type":332,"attrs":333,"content":334},"code_block",{"class":55},[335],{"text":336,"type":325},"{\n    \"_links\": {\n    },\n    \"_embedded\": {\n        \"fx:items\": [\n            {\n                \"_links\": {\n                },\n                \"_embedded\": {\n                    \"fx:item_options\": [\n                        {\n                            \"_links\": {\n                            },\n                            \"name\": \"size\",\n                            \"value\": \"medium\",\n                            \"price_mod\": 0,\n                            \"weight_mod\": 0,\n                            \"date_created\": null,\n                            \"date_modified\": null\n                        },\n                        {\n                            \"_links\": {\n                            },\n                            \"name\": \"color\",\n                            \"value\": \"red\",\n                            \"price_mod\": 0,\n                            \"weight_mod\": 0,\n                            \"date_created\": null,\n                            \"date_modified\": null\n                        }\n                    ],\n                    \"fx:item_category\": {\n                        \"_links\": {\n                        },\n                        \"admin_email_template_uri\": \"\",\n                        \"customer_email_template_uri\": \"\",\n                        \"code\": \"DEFAULT\",\n                        \"name\": \"Default for all products\",\n                        \"item_delivery_type\": \"flat_rate\",\n                        \"max_downloads_per_customer\": 3,\n                        \"max_downloads_time_period\": 24,\n                        \"default_weight\": 0,\n                        \"default_weight_unit\": \"LBS\",\n                        \"default_length_unit\": \"IN\",\n                        \"shipping_flat_rate_type\": \"per_item\",\n                        \"shipping_flat_rate\": 5,\n                        \"handling_fee_type\": \"none\",\n                        \"handling_fee\": 0\n                    }\n                },\n                \"item_category_uri\": \"https:\u002F\u002Fapi.foxycart.com\u002Fitem_categories\u002F100\",\n                \"name\": \"Example Product\",\n                \"price\": 20,\n                \"quantity\": 1,\n                \"quantity_min\": 0,\n                \"quantity_max\": 0,\n                \"weight\": 5,\n                \"code\": \"foo321\",\n                \"parent_code\": \"\",\n                \"discount_name\": \"\",\n                \"discount_type\": \"\",\n                \"discount_details\": \"\",\n                \"subscription_frequency\": \"\",\n                \"subscription_start_date\": null,\n                \"subscription_next_transaction_date\": null,\n                \"subscription_end_date\": null,\n                \"is_future_line_item\": false,\n                \"shipto\": \"Me\",\n                \"url\": \"\",\n                \"image\": \"\",\n                \"length\": 0,\n                \"width\": 0,\n                \"height\": 0,\n                \"expires\": 0,\n                \"date_created\": null,\n                \"date_modified\": \"2017-07-20T04:14:03-0700\"\n            }\n        ],\n        \"fx:discounts\": [\n            {\n                \"code\": \"coupon\",\n                \"amount\": -3.6,\n                \"name\": \"Default Discount\",\n                \"display\": \"-$3.60\",\n                \"is_taxable\": false,\n                \"is_future_discount\": false\n            }\n        ],\n        \"fx:custom_fields\": [\n            {\n                \"name\": \"custom_note\",\n                \"value\": \"Happy Birthday!\",\n                \"is_hidden\": 0\n            }],\n        \"fx:shipment\": {\n            \"address_name\": \"\",\n            \"first_name\": \"John\",\n            \"last_name\": \"Smith\",\n            \"company\": \"\",\n            \"address1\": \"Main Street\",\n            \"address2\": \"\",\n            \"city\": \"Saint Paul\",\n            \"region\": \"MN\",\n            \"postal_code\": \"55116\",\n            \"country\": \"US\",\n            \"origin_region\": \"TX\",\n            \"origin_postal_code\": \"77018\",\n            \"origin_country\": \"US\",\n            \"shipping_service_id\": 0,\n            \"shipping_service_description\": \"\",\n            \"is_residential\": false,\n            \"item_count\": 2,\n            \"total_weight\": 5,\n            \"total_customs_value\": 0,\n            \"total_handling_fee\": 0,\n            \"total_flat_rate_shipping\": 5,\n            \"total_item_price\": 35.99,\n            \"total_tax\": 3.24,\n            \"total_shipping\": 0,\n            \"total_price\": 39.23\n        },\n        \"fx:customer\": {\n            \"id\": \"1512345\",\n            \"first_name\": \"John\",\n            \"last_name\": \"Smith\",\n            \"email\": \"john@example.com\",\n            \"tax_id\": \"\",\n            \"is_anonymous\": \"0\",\n            \"_embedded\": {\n                \"fx:payments\": [\n                    {\n                        \"cc_type\": \"plastic\",\n                        \"cc_number_masked\": \"xxxx xxxx xxxx 4242\",\n                        \"cc_exp_month\": \"10\",\n                        \"cc_exp_year\": \"2020\",\n                        \"purchase_order\": null\n                    }\n                ],\n                \"fx:default_billing_address\": {\n                    \"country\": \"US\",\n                    \"region\": \"MN\",\n                    \"city\": \"Saint Paul\",\n                    \"postal_code\": \"55116\",\n                    \"address1\": \"Main Street\",\n                    \"address2\": \"\",\n                    \"company\": \"\",\n                    \"full_name\": \"John Smith\",\n                    \"first_name\": \"John\",\n                    \"last_name\": \"Smith\",\n                    \"phone\": \"\"\n                }\n            }\n        }\n    },\n    \"customer_uri\": \"\",\n    \"template_set_uri\": \"\",\n    \"language\": \"\",\n    \"locale_code\": \"en_US\",\n    \"customer_ip\": \"192.168.0.1\",\n    \"ip_country\": \"United States\",\n    \"session_name\": \"fcsid\",\n    \"session_id\": \"hvcv28l8md0qc8qt5rrjh4qo85\",\n    \"total_item_price\": 35.99,\n    \"total_tax\": 3.24,\n    \"total_shipping\": 14.23,\n    \"total_future_shipping\": 0,\n    \"total_order\": 49.86,\n    \"date_created\": null,\n    \"date_modified\": \"2017-07-20T04:12:25-0700\"\n}\n",{"type":338,"attrs":339,"content":341},"heading",{"level":340,"textAlign":55},2,[342],{"text":343,"type":325},"Notes",{"type":345,"content":346},"bullet_list",[347,362],{"type":348,"content":349},"list_item",[350],{"type":320,"attrs":351,"content":352},{"textAlign":55},[353,355,360],{"text":354,"type":325},"The payload includes several ",{"text":356,"type":325,"marks":357},"_links",[358],{"type":359},"code",{"text":361,"type":325}," arrays. These contain URIs that can be used through the Hypermedia API if you’re also making use of it — otherwise, they can be safely ignored.",{"type":348,"content":363},[364],{"type":320,"attrs":365,"content":366},{"textAlign":55},[367],{"text":368,"type":325},"A response is expected from your endpoint within 20 seconds of the request being sent, so any logic your endpoint runs needs to complete quickly. This request happens after the customer clicks to complete their transaction, so extended delays mean the customer waits longer for a response too.",{"id":55,"alt":55,"name":13,"focus":55,"title":55,"source":55,"filename":13,"copyright":55,"fieldtype":77,"meta_data":370},{},"The example JSON payload sent to your endpoint before a transaction is submitted to the gateway.","5c49218e-d3ae-4f94-b450-8f27240924b1",[],"pre-payment-webhook-payload-reference","help\u002Farticles\u002Fpre-payment-webhook-payload-reference",-3980,[],2659,"ef3a085b-8548-4c63-a02d-5aceff11aba4",[],{"html":382,"sections":383,"segments":387},"\u003Cp>When the customer attempts to complete their purchase — after Google reCAPTCHA is validated, if active — a POST request is sent to your custom endpoint with a JSON payload representing the current cart. It follows the same structure as the Hypermedia API, since most of the data comes from there.\u003C\u002Fp>\u003Cp>The following example shows two products (one with live shipping rates) and a coupon applied.\u003C\u002Fp>\u003Cdiv class=\"position-relative w-100 overflow-hidden rounded-2\" data-code-block>\u003Cdiv class=\"d-flex justify-content-end border-bottom\" style=\"background:#2b2c3b;\">\u003Cbutton type=\"button\" class=\"btn btn-link btn-sm text-light\" title=\"Copy\" data-code-button>\u003Cspan data-code-default style=\"\">\u003Ci class=\"fal fa-copy me-2\">\u003C\u002Fi> Copy \u003C\u002Fspan>\u003Cspan class=\"text-success\" data-code-success style=\"display:none;\">\u003Ci class=\"fal fa-check ms-2\">\u003C\u002Fi> Copied \u003C\u002Fspan>\u003C\u002Fbutton>\u003C\u002Fdiv>\u003Cdiv class=\"small\">\u003Cpre class=\"hljs p-2\" data-code-content>{\n    "_links": {\n    },\n    "_embedded": {\n        "fx:items": [\n            {\n                "_links": {\n                },\n                "_embedded": {\n                    "fx:item_options": [\n                        {\n                            "_links": {\n                            },\n                            "name": "size",\n                            "value": "medium",\n                            "price_mod": 0,\n                            "weight_mod": 0,\n                            "date_created": null,\n                            "date_modified": null\n                        },\n                        {\n                            "_links": {\n                            },\n                            "name": "color",\n                            "value": "red",\n                            "price_mod": 0,\n                            "weight_mod": 0,\n                            "date_created": null,\n                            "date_modified": null\n                        }\n                    ],\n                    "fx:item_category": {\n                        "_links": {\n                        },\n                        "admin_email_template_uri": "",\n                        "customer_email_template_uri": "",\n                        "code": "DEFAULT",\n                        "name": "Default for all products",\n                        "item_delivery_type": "flat_rate",\n                        "max_downloads_per_customer": 3,\n                        "max_downloads_time_period": 24,\n                        "default_weight": 0,\n                        "default_weight_unit": "LBS",\n                        "default_length_unit": "IN",\n                        "shipping_flat_rate_type": "per_item",\n                        "shipping_flat_rate": 5,\n                        "handling_fee_type": "none",\n                        "handling_fee": 0\n                    }\n                },\n                "item_category_uri": "https:\u002F\u002Fapi.foxycart.com\u002Fitem_categories\u002F100",\n                "name": "Example Product",\n                "price": 20,\n                "quantity": 1,\n                "quantity_min": 0,\n                "quantity_max": 0,\n                "weight": 5,\n                "code": "foo321",\n                "parent_code": "",\n                "discount_name": "",\n                "discount_type": "",\n                "discount_details": "",\n                "subscription_frequency": "",\n                "subscription_start_date": null,\n                "subscription_next_transaction_date": null,\n                "subscription_end_date": null,\n                "is_future_line_item": false,\n                "shipto": "Me",\n                "url": "",\n                "image": "",\n                "length": 0,\n                "width": 0,\n                "height": 0,\n                "expires": 0,\n                "date_created": null,\n                "date_modified": "2017-07-20T04:14:03-0700"\n            }\n        ],\n        "fx:discounts": [\n            {\n                "code": "coupon",\n                "amount": -3.6,\n                "name": "Default Discount",\n                "display": "-$3.60",\n                "is_taxable": false,\n                "is_future_discount": false\n            }\n        ],\n        "fx:custom_fields": [\n            {\n                "name": "custom_note",\n                "value": "Happy Birthday!",\n                "is_hidden": 0\n            }],\n        "fx:shipment": {\n            "address_name": "",\n            "first_name": "John",\n            "last_name": "Smith",\n            "company": "",\n            "address1": "Main Street",\n            "address2": "",\n            "city": "Saint Paul",\n            "region": "MN",\n            "postal_code": "55116",\n            "country": "US",\n            "origin_region": "TX",\n            "origin_postal_code": "77018",\n            "origin_country": "US",\n            "shipping_service_id": 0,\n            "shipping_service_description": "",\n            "is_residential": false,\n            "item_count": 2,\n            "total_weight": 5,\n            "total_customs_value": 0,\n            "total_handling_fee": 0,\n            "total_flat_rate_shipping": 5,\n            "total_item_price": 35.99,\n            "total_tax": 3.24,\n            "total_shipping": 0,\n            "total_price": 39.23\n        },\n        "fx:customer": {\n            "id": "1512345",\n            "first_name": "John",\n            "last_name": "Smith",\n            "email": "john@example.com",\n            "tax_id": "",\n            "is_anonymous": "0",\n            "_embedded": {\n                "fx:payments": [\n                    {\n                        "cc_type": "plastic",\n                        "cc_number_masked": "xxxx xxxx xxxx 4242",\n                        "cc_exp_month": "10",\n                        "cc_exp_year": "2020",\n                        "purchase_order": null\n                    }\n                ],\n                "fx:default_billing_address": {\n                    "country": "US",\n                    "region": "MN",\n                    "city": "Saint Paul",\n                    "postal_code": "55116",\n                    "address1": "Main Street",\n                    "address2": "",\n                    "company": "",\n                    "full_name": "John Smith",\n                    "first_name": "John",\n                    "last_name": "Smith",\n                    "phone": ""\n                }\n            }\n        }\n    },\n    "customer_uri": "",\n    "template_set_uri": "",\n    "language": "",\n    "locale_code": "en_US",\n    "customer_ip": "192.168.0.1",\n    "ip_country": "United States",\n    "session_name": "fcsid",\n    "session_id": "hvcv28l8md0qc8qt5rrjh4qo85",\n    "total_item_price": 35.99,\n    "total_tax": 3.24,\n    "total_shipping": 14.23,\n    "total_future_shipping": 0,\n    "total_order": 49.86,\n    "date_created": null,\n    "date_modified": "2017-07-20T04:12:25-0700"\n}\n\u003C\u002Fpre>\u003C\u002Fdiv>\u003C\u002Fdiv>\u003Csection id=\"notes\" data-title=\"Notes\" data-title-node=\"H2\">\u003Chr class=\"my-8\" style=\"margin-left: -48px; margin-right: -40vw\">\u003Ch2 data-anchor-id=\"notes\">Notes\u003C\u002Fh2>\u003Cul>\u003Cli>\u003Cp>The payload includes several \u003Ccode class=\"badge bg-soft-danger text-danger\">_links\u003C\u002Fcode> arrays. These contain URIs that can be used through the Hypermedia API if you’re also making use of it — otherwise, they can be safely ignored.\u003C\u002Fp>\u003C\u002Fli>\u003Cli>\u003Cp>A response is expected from your endpoint within 20 seconds of the request being sent, so any logic your endpoint runs needs to complete quickly. This request happens after the customer clicks to complete their transaction, so extended delays mean the customer waits longer for a response too.\u003C\u002Fp>\u003C\u002Fli>\u003C\u002Ful>\u003C\u002Fsection>",[384],{"id":385,"title":343,"level":386},"notes","H2",[388],{"type":389,"content":390},"html","\u003Cp>When the customer attempts to complete their purchase — after Google reCAPTCHA is validated, if active — a POST request is sent to your custom endpoint with a JSON payload representing the current cart. It follows the same structure as the Hypermedia API, since most of the data comes from there.\u003C\u002Fp>\u003Cp>The following example shows two products (one with live shipping rates) and a coupon applied.\u003C\u002Fp>\u003Cpre>\u003Ccode>{\n    "_links": {\n    },\n    "_embedded": {\n        "fx:items": [\n            {\n                "_links": {\n                },\n                "_embedded": {\n                    "fx:item_options": [\n                        {\n                            "_links": {\n                            },\n                            "name": "size",\n                            "value": "medium",\n                            "price_mod": 0,\n                            "weight_mod": 0,\n                            "date_created": null,\n                            "date_modified": null\n                        },\n                        {\n                            "_links": {\n                            },\n                            "name": "color",\n                            "value": "red",\n                            "price_mod": 0,\n                            "weight_mod": 0,\n                            "date_created": null,\n                            "date_modified": null\n                        }\n                    ],\n                    "fx:item_category": {\n                        "_links": {\n                        },\n                        "admin_email_template_uri": "",\n                        "customer_email_template_uri": "",\n                        "code": "DEFAULT",\n                        "name": "Default for all products",\n                        "item_delivery_type": "flat_rate",\n                        "max_downloads_per_customer": 3,\n                        "max_downloads_time_period": 24,\n                        "default_weight": 0,\n                        "default_weight_unit": "LBS",\n                        "default_length_unit": "IN",\n                        "shipping_flat_rate_type": "per_item",\n                        "shipping_flat_rate": 5,\n                        "handling_fee_type": "none",\n                        "handling_fee": 0\n                    }\n                },\n                "item_category_uri": "https:\u002F\u002Fapi.foxycart.com\u002Fitem_categories\u002F100",\n                "name": "Example Product",\n                "price": 20,\n                "quantity": 1,\n                "quantity_min": 0,\n                "quantity_max": 0,\n                "weight": 5,\n                "code": "foo321",\n                "parent_code": "",\n                "discount_name": "",\n                "discount_type": "",\n                "discount_details": "",\n                "subscription_frequency": "",\n                "subscription_start_date": null,\n                "subscription_next_transaction_date": null,\n                "subscription_end_date": null,\n                "is_future_line_item": false,\n                "shipto": "Me",\n                "url": "",\n                "image": "",\n                "length": 0,\n                "width": 0,\n                "height": 0,\n                "expires": 0,\n                "date_created": null,\n                "date_modified": "2017-07-20T04:14:03-0700"\n            }\n        ],\n        "fx:discounts": [\n            {\n                "code": "coupon",\n                "amount": -3.6,\n                "name": "Default Discount",\n                "display": "-$3.60",\n                "is_taxable": false,\n                "is_future_discount": false\n            }\n        ],\n        "fx:custom_fields": [\n            {\n                "name": "custom_note",\n                "value": "Happy Birthday!",\n                "is_hidden": 0\n            }],\n        "fx:shipment": {\n            "address_name": "",\n            "first_name": "John",\n            "last_name": "Smith",\n            "company": "",\n            "address1": "Main Street",\n            "address2": "",\n            "city": "Saint Paul",\n            "region": "MN",\n            "postal_code": "55116",\n            "country": "US",\n            "origin_region": "TX",\n            "origin_postal_code": "77018",\n            "origin_country": "US",\n            "shipping_service_id": 0,\n            "shipping_service_description": "",\n            "is_residential": false,\n            "item_count": 2,\n            "total_weight": 5,\n            "total_customs_value": 0,\n            "total_handling_fee": 0,\n            "total_flat_rate_shipping": 5,\n            "total_item_price": 35.99,\n            "total_tax": 3.24,\n            "total_shipping": 0,\n            "total_price": 39.23\n        },\n        "fx:customer": {\n            "id": "1512345",\n            "first_name": "John",\n            "last_name": "Smith",\n            "email": "john@example.com",\n            "tax_id": "",\n            "is_anonymous": "0",\n            "_embedded": {\n                "fx:payments": [\n                    {\n                        "cc_type": "plastic",\n                        "cc_number_masked": "xxxx xxxx xxxx 4242",\n                        "cc_exp_month": "10",\n                        "cc_exp_year": "2020",\n                        "purchase_order": null\n                    }\n                ],\n                "fx:default_billing_address": {\n                    "country": "US",\n                    "region": "MN",\n                    "city": "Saint Paul",\n                    "postal_code": "55116",\n                    "address1": "Main Street",\n                    "address2": "",\n                    "company": "",\n                    "full_name": "John Smith",\n                    "first_name": "John",\n                    "last_name": "Smith",\n                    "phone": ""\n                }\n            }\n        }\n    },\n    "customer_uri": "",\n    "template_set_uri": "",\n    "language": "",\n    "locale_code": "en_US",\n    "customer_ip": "192.168.0.1",\n    "ip_country": "United States",\n    "session_name": "fcsid",\n    "session_id": "hvcv28l8md0qc8qt5rrjh4qo85",\n    "total_item_price": 35.99,\n    "total_tax": 3.24,\n    "total_shipping": 14.23,\n    "total_future_shipping": 0,\n    "total_order": 49.86,\n    "date_created": null,\n    "date_modified": "2017-07-20T04:12:25-0700"\n}\n\u003C\u002Fcode>\u003C\u002Fpre>\u003Ch2>Notes\u003C\u002Fh2>\u003Cul>\u003Cli>\u003Cp>The payload includes several \u003Ccode class=\"badge bg-soft-danger text-danger\">_links\u003C\u002Fcode> arrays. These contain URIs that can be used through the Hypermedia API if you’re also making use of it — otherwise, they can be safely ignored.\u003C\u002Fp>\u003C\u002Fli>\u003Cli>\u003Cp>A response is expected from your endpoint within 20 seconds of the request being sent, so any logic your endpoint runs needs to complete quickly. This request happens after the customer clicks to complete their transaction, so extended delays mean the customer waits longer for a response too.\u003C\u002Fp>\u003C\u002Fli>\u003C\u002Ful>",{"name":392,"created_at":393,"published_at":394,"updated_at":395,"id":396,"uuid":42,"content":397,"slug":43,"full_slug":43,"sort_by_date":55,"position":577,"tag_list":578,"is_startpage":24,"parent_id":55,"meta_data":55,"group_id":579,"first_published_at":580,"release_id":55,"lang":61,"path":55,"alternates":581,"default_full_slug":55,"translated_slugs":55},"Contact","2022-09-23T19:56:58.957Z","2025-05-08T18:24:40.382Z","2025-05-08T18:24:40.392Z",3138,{"seo":398,"_uid":401,"title":402,"action":403,"fields":404,"method":553,"columns":554,"subtitle":568,"component":43,"button_text":574,"submit_title":575,"submit_subtitle":576},{"_uid":399,"title":392,"plugin":400,"description":13},"24ff7574-3bcc-48d2-85b5-e529dfea1cc4","meta-fields","8f54f1da-9d8f-49b2-89e7-840e886491cb","We're here to help.","https:\u002F\u002Fusebasin.com\u002Ff\u002F029f48d65402",[405,410,414,524,527,532,547],{"_uid":406,"name":407,"type":325,"label":408,"options":13,"required":33,"component":409,"placeholder":13},"9a70b226-2036-4f90-a052-b3efa61c5896","name","Name","form___field",{"_uid":411,"name":412,"type":412,"label":413,"options":13,"required":33,"component":409,"placeholder":13},"86ba35be-ff43-4a28-8633-14052a8f6622","email","Email Address",{"_uid":415,"name":416,"type":417,"label":418,"options":419,"required":33,"component":409,"conditions":420,"placeholder":13},"3f827475-492c-4f97-aa1e-2386ac263b6c","topic","select","Topic","Presales, Support, Billing, Partnerships, Order Enquiry, Other",[421,478,488,495,503,511,517],{"_uid":422,"equals":423,"fields":424,"component":477},"e21d97dd-e68e-4fa6-ba97-bc40f3041dde","Order Enquiry",[425],{"_uid":426,"body":427,"type":475,"title":13,"component":476},"b64992bc-6d53-48b8-b7a0-d81e5a062e50",{"type":317,"content":428},[429],{"type":320,"content":430},[431,433,441,443,445,446,451,453,458,466,468,473],{"text":432,"type":325},"We are ",{"text":434,"type":325,"marks":435},"Foxy.io",[436],{"type":437,"attrs":438},"link",{"href":439,"uuid":55,"anchor":55,"custom":440,"target":55,"linktype":31},"http:\u002F\u002FFoxy.io",{},{"text":442,"type":325},", an ecommerce platform powering ecommerce for other merchants. We do not sell products, and are unable to assist with questions about order statuses or refunds for any merchants using our platform. Please contact the merchant you ordered from for assistance. If you’d like to report a store using Foxy for fraudulent practices, please select ‘other’ in the subject.",{"type":444},"hard_break",{"type":444},{"text":447,"type":325,"marks":448},"NOTE:",[449],{"type":450},"bold",{"text":452,"type":325}," We are ",{"text":454,"type":325,"marks":455},"not ",[456],{"type":457},"italic",{"text":459,"type":325,"marks":460},"Foxy.in",[461,465],{"type":437,"attrs":462},{"href":463,"uuid":55,"anchor":55,"custom":464,"target":55,"linktype":31},"http:\u002F\u002FFoxy.in",{},{"type":457},{"text":467,"type":325},". We are not in any way affiliated with ",{"text":459,"type":325,"marks":469},[470],{"type":437,"attrs":471},{"href":463,"uuid":55,"anchor":55,"custom":472,"target":55,"linktype":31},{},{"text":474,"type":325},", and cannot help in any way with your order from that website.","danger","global___alert","form___condition",{"_uid":479,"equals":480,"fields":481,"component":477},"8765c3e1-25cf-44aa-b8ea-fc6094acf9c3","Presales",[482],{"_uid":483,"name":484,"type":485,"label":13,"options":13,"required":24,"component":409,"conditions":486,"placeholder":13,"default_value":487},"cf464f8e-d643-4f6e-af29-d3abffaf7380","department_email_address","hidden",[],"hello@foxy.io",{"_uid":489,"equals":204,"fields":490,"component":477},"4007b6d8-77e5-421d-bd1e-6f336dd853fb",[491],{"_uid":492,"name":484,"type":485,"label":13,"options":13,"required":24,"component":409,"conditions":493,"placeholder":13,"default_value":494},"7b4c6aa5-a68c-45e0-9ce1-0a36af10c0c2",[],"help@foxy.io",{"_uid":496,"equals":497,"fields":498,"component":477},"1dbb8f11-613d-43cd-9e09-1b94f6e19219","Billing",[499],{"_uid":500,"name":484,"type":485,"label":13,"options":13,"required":24,"component":409,"conditions":501,"placeholder":13,"default_value":502},"a0ac0d1b-bc4f-4a6c-a682-581d450b0b73",[],"help+billing@foxy.io",{"_uid":504,"equals":505,"fields":506,"component":477},"a0a53a50-7172-4a29-ba58-181e38874e12","Partnerships",[507],{"_uid":508,"name":484,"type":485,"label":13,"options":13,"required":24,"component":409,"conditions":509,"placeholder":13,"default_value":510},"7aa011d9-f374-4aed-b5a5-929b54aaf152",[],"partners@foxy.io",{"_uid":512,"equals":423,"fields":513,"component":477},"a4cd431f-25d5-41c7-bfdc-02c908c8fb47",[514],{"_uid":515,"name":484,"type":485,"label":13,"options":13,"required":24,"component":409,"conditions":516,"placeholder":13,"default_value":487},"f5d52168-d6ae-451b-94ee-2ced1cbd28ad",[],{"_uid":518,"equals":519,"fields":520,"component":477},"25aba1ed-eb41-4bbc-aa89-f7a7167ea86e","Other",[521],{"_uid":522,"name":484,"type":485,"label":13,"options":13,"required":24,"component":409,"conditions":523,"placeholder":13,"default_value":487},"f40dfaef-c203-4b71-bf4e-e1b43cef192b",[],{"_uid":525,"component":526},"e9c53a05-f40a-4510-aaf8-bc072a235a0c","form___subject",{"_uid":528,"name":529,"type":530,"label":531,"options":13,"required":33,"component":409,"placeholder":13},"a4c4d385-fff4-4978-99fb-b68cfea623d6","message","textarea","Message",{"_uid":533,"name":534,"type":417,"label":535,"options":536,"required":33,"component":409,"conditions":537,"placeholder":13},"8a3c9f85-f438-427d-9c7a-d7b295a14b5b","existing_user","Are you an existing user?","No, Yes",[538],{"_uid":539,"equals":540,"fields":541,"component":477},"115933d6-262a-4b59-8fa8-579c5ad73de1","Yes",[542],{"_uid":543,"name":544,"type":325,"label":545,"options":13,"required":33,"component":409,"conditions":546,"placeholder":13},"44b6ff23-98f0-4e95-b7f5-c23e06415c2d","subdomain","Store Subdomain",[],{"_uid":548,"name":549,"type":417,"label":550,"options":551,"required":33,"component":409,"conditions":552,"placeholder":13},"922a5cef-3af2-4113-8855-36c7910e3ee3","user_type","What type of user are you?","Developer, Designer, Merchant",[],"POST",[555],{"_uid":556,"text":557,"title":566,"component":567},"7323b90d-a93a-4bf1-baa9-20d0b7ead61b",{"type":317,"content":558},[559],{"type":320,"content":560},[561,563,564],{"text":562,"type":325},"855.369.9227",{"type":444},{"text":565,"type":325},"9:30am-6pm Central M-F","Pre-sales, Sales, & Partnerships","contact___footer_column",{"type":317,"content":569},[570],{"type":320,"content":571},[572],{"text":573,"type":325},"Get in touch to get help from our friendly support team.","Submit","Success!","Your email has been received. We'll get back to you as soon as we can, but it might take a business day. If you don't hear back from us in a timely manner, please check your spam folder to ensure our reply didn't go there.",-80,[],"2fd9fb7d-a48a-4184-acfd-30022d8d6f08","2022-09-23T20:10:45.360Z",[],[281,583,609],{"name":584,"created_at":585,"published_at":586,"updated_at":587,"id":588,"uuid":589,"content":590,"slug":603,"full_slug":604,"sort_by_date":55,"position":605,"tag_list":606,"is_startpage":24,"parent_id":303,"meta_data":55,"group_id":607,"first_published_at":586,"release_id":55,"lang":61,"path":55,"alternates":608,"default_full_slug":55,"translated_slugs":55},"Webhooks","2026-07-20T19:37:26.231Z","2026-07-20T19:41:27.137Z","2026-07-20T19:41:27.157Z",200239703052833,"5f8f8006-b68e-4a03-8638-2d28a556726e",{"_uid":591,"icon":13,"name":584,"type":592,"pinned":24,"summary":593,"category":13,"component":290,"blog_posts":594,"icon_custom":595,"case_studies":597,"faq_sections":598,"featured_guides":599,"mailbox_category":13,"featured_articles":600,"featured_blog_posts":601,"featured_case_studies":602},"c8a9b798-94ba-4a83-9ba5-c851b17946df","simple","Send real-time event notifications to your own endpoint when transactions, subscriptions, and customers change.",[],{"id":55,"alt":55,"name":13,"focus":55,"title":55,"source":55,"filename":13,"copyright":55,"fieldtype":77,"meta_data":596},{},[],[],[],[],[],[],"webhooks","help\u002Fcategories\u002Fwebhooks",-750,[],"c59e6243-064a-4f06-a367-c14a15c02ff3",[],{"name":610,"created_at":611,"published_at":612,"updated_at":613,"id":614,"uuid":372,"content":615,"slug":627,"full_slug":628,"sort_by_date":55,"position":629,"tag_list":630,"is_startpage":24,"parent_id":303,"meta_data":55,"group_id":631,"first_published_at":612,"release_id":55,"lang":61,"path":55,"alternates":632,"default_full_slug":55,"translated_slugs":55},"Pre-Payment Webhook","2026-07-20T19:40:10.710Z","2026-07-20T19:41:25.621Z","2026-07-20T19:41:25.642Z",200240376723276,{"_uid":616,"icon":13,"name":610,"type":592,"pinned":24,"summary":617,"category":589,"component":290,"blog_posts":618,"icon_custom":619,"case_studies":621,"faq_sections":622,"featured_guides":623,"mailbox_category":13,"featured_articles":624,"featured_blog_posts":625,"featured_case_studies":626},"d1f89ece-95ef-4c06-b1ce-30e0c404e9b4","Approve or reject a transaction with custom validation before payment is sent to the gateway.",[],{"id":55,"alt":55,"name":13,"focus":55,"title":55,"source":55,"filename":13,"copyright":55,"fieldtype":77,"meta_data":620},{},[],[],[],[],[],[],"pre-payment-webhook","help\u002Fcategories\u002Fpre-payment-webhook",-810,[],"5e799081-aa86-40f8-add1-8646aa9b5f96",[],{},1785861241097]