> For the complete documentation index, see [llms.txt](https://api-docs.fcfpay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.fcfpay.com/reference/api-requests-v2/create-order.md). # Create Order ## Creating a new order {% tabs %} {% tab title="cURL" %} ``` curl --location -g --request POST '{{BASE_URL}}/v2/create-order' \ --header 'Authorization: Bearer {{API_KEY}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "domain": "yourdomain.com", "order_id": "Test123", "user_id": "1", "amount": "100", "currency_name": "EUR", "order_date": "2022-04-26", "redirect_url": "https://yourdomain.com/thank-you/", "items": { "1": { "Item Name": "Test Item 1", "Quantity":"1", "Price": 10, "Total":"12", }, "2": { "Item Name": "Test Item 2", "Price": 20 } } }' ``` {% endtab %} {% tab title="JavaScript" %} ``` var myHeaders = new Headers(); myHeaders.append("Authorization", "Bearer {{API_KEY}}"); myHeaders.append("Content-Type", "application/json"); var raw = "{\r\n \"domain\": \"yourdomain.com\",\r\n \"order_id\": \"Test123\",\r\n \"user_id\": \"1\",\r\n \"amount\": \"100\",\r\n \"currency_name\": \"EUR\",\r\n \"order_date\": \"2022-04-26\",\r\n \"redirect_url\": \"https://yourdomain.com/thank-you/\",\r\n \"items\": {\r\n \"1\": {\r\n \"Item Name\": \"Test Item 1\",\r\n \"Quantity\":\"1\",\r\n \"Price\": 10,\r\n \"Total\":\"12\",\r\n },\r\n \"2\": {\r\n \"Item Name\": \"Test Item 2\",\r\n \"Price\": 20\r\n }\r\n }\r\n}"; var requestOptions = { method: 'POST', headers: myHeaders, body: raw, redirect: 'follow' }; fetch("{{BASE_URL}}/v2/create-order", requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log('error', error)); ``` {% endtab %} {% tab title="Node.js" %} ``` var request = require('request'); var options = { 'method': 'POST', 'url': '{{BASE_URL}}/v2/create-order', 'headers': { 'Authorization': 'Bearer {{API_KEY}}', 'Content-Type': 'application/json' }, body: '{\r\n "domain": "yourdomain.com",\r\n "order_id": "Test123",\r\n "user_id": "1",\r\n "amount": "100",\r\n "currency_name": "EUR",\r\n "order_date": "2022-04-26",\r\n "redirect_url": "https://yourdomain.com/thank-you/",\r\n "items": {\r\n "1": {\r\n "Item Name": "Test Item 1",\r\n "Quantity":"1",\r\n "Price": 10,\r\n "Total":"12",\r\n },\r\n "2": {\r\n "Item Name": "Test Item 2",\r\n "Price": 20\r\n }\r\n }\r\n}' }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` {% endtab %} {% tab title="PHP" %} ``` '%7B%7BBASE_URL%7D%7D/v2/create-order', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS =>'{ "domain": "yourdomain.com", "order_id": "Test123", "user_id": "1", "amount": "100", "currency_name": "EUR", "order_date": "2022-04-26", "redirect_url": "https://yourdomain.com/thank-you/", "items": { "1": { "Item Name": "Test Item 1", "Quantity":"1", "Price": 10, "Total":"12", }, "2": { "Item Name": "Test Item 2", "Price": 20 } } }', CURLOPT_HTTPHEADER => array( 'Authorization: Bearer {{API_KEY}}', 'Content-Type: application/json' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; ``` {% endtab %} {% tab title="Python" %} ``` import requests import json url = "{{BASE_URL}}/v2/create-order" payload = "{\r\n\t\"domain\": \"yourdomain.com\",\r\n\t\"order_id\": \"Test123\",\r\n \"user_id\": \"1\",\r\n\t\"amount\": \"100\",\r\n\t\"currency_name\": \"EUR\",\r\n \"order_date\": \"2022-04-26\",\r\n\t\"redirect_url\": \"https://yourdomain.com/thank-you/\",\r\n \"items\": {\r\n\t\t\t\"1\": {\r\n\t\t\t\t\"Item Name\": \"Test Item 1\",\r\n \"Quantity\":\"1\",\r\n\t\t\t\t\"Price\": 10,\r\n \"Total\":\"12\",\r\n\t\t\t},\r\n\t\t\t\"2\": {\r\n\t\t\t\t\"Item Name\": \"Test Item 2\",\r\n\t\t\t\t\"Price\": 20\r\n\t\t\t}\r\n\t\t}\r\n}" headers = { 'Authorization': 'Bearer {{API_KEY}}', 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` {% endtab %} {% endtabs %} | Field | Description | Example | | -------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | domain | Your domain name | "yourdomain.com" | | order\_id | The `id` of the order | "3" | | user\_id | The user's ID (optional) | "1" | | amount | The amount of the order | "10" | | currency\_name | The ISO-4217 currency | "USD" | | order\_date | The date of the order | "2022-04-26" | | redirect\_url | The page where you want to redirect users after the payment | "" | | items | List of items in JSON format | { "1": { "Item Name": "Test Item 1", "Quantity":"1", "Price": 10, "Total":"12" }, "2": { "Item Name": "Test Item 2", "Price": 20 } } | ## Create an order. `POST` `https://merchant.fcfpay.com/api/v2/create-order` Creates a new order. #### Request Body | Name | Type | Description | | ------------------------------------------------ | ------- | --------------------------------- | | domain\* | string | domain host of the order | | order\_id\* | string | The `id` of the order as a string | | amount\* | decimal | The amount as a string | | currency\_name\* | string | The ISO-4217 currency | | redirect\_url\* | string | The URL where will redirected | | order\_date | string | The date with "YYYY-MM-DD" format | | user\_id | String | The `id` of the user as a string | | items | JSON | List of Items | {% tabs %} {% tab title="200 Order successfully created" %} ```javascript { "success": true, "data": { "checkout_page_url": "https://checkout-sandbox.fcfpay.com/pay/JDJ5JDEwJGNFWHNualp6NnFydDNNZzhkVUJwN2VILkJkTko1RmFTZ1ZVQVRCVWxqSVlxUy83YzRwTFou", "payment_status": "waiting" }, "message": "Order successfully created. Waiting for the payment." } ``` {% endtab %} {% tab title="401: Unauthorized Invalid API Key" %} ```javascript { "success": false, "data": [], "message": "Merchant Authentication problem!" } ``` {% endtab %} {% endtabs %} After order creation, our system will send you a checkout page URL. You should redirect your customers to that URL. If you send information about items, this will be displayed on the checkout page:
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://api-docs.fcfpay.com/reference/api-requests-v2/create-order.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.