Complete Order

POST

api

payment

domains

{domain}

complete-order

Complete Order

curl --request POST \
  --url https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-firmly-authorization: <x-firmly-authorization>' \
  --data '
{
  "encrypted_card": "<string>",
  "billing_info": {},
  "captcha_token": "<string>"
}
'

import requests

url = "https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order"

payload = {
    "encrypted_card": "<string>",
    "billing_info": {},
    "captcha_token": "<string>"
}
headers = {
    "x-firmly-authorization": "<x-firmly-authorization>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-firmly-authorization': '<x-firmly-authorization>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({encrypted_card: '<string>', billing_info: {}, captcha_token: '<string>'})
};

fetch('https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'encrypted_card' => '<string>',
    'billing_info' => [
        
    ],
    'captcha_token' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-firmly-authorization: <x-firmly-authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order"

	payload := strings.NewReader("{\n  \"encrypted_card\": \"<string>\",\n  \"billing_info\": {},\n  \"captcha_token\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-firmly-authorization", "<x-firmly-authorization>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order")
  .header("x-firmly-authorization", "<x-firmly-authorization>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"encrypted_card\": \"<string>\",\n  \"billing_info\": {},\n  \"captcha_token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-firmly-authorization"] = '<x-firmly-authorization>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"encrypted_card\": \"<string>\",\n  \"billing_info\": {},\n  \"captcha_token\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "platform_order_number": "<string>",
  "cart_id": "<string>",
  "line_items": [
    {}
  ],
  "total": {},
  "shipping_info": {},
  "shipping_method": {}
}

Overview

Completes the checkout process by placing an order with the merchant. This endpoint requires an existing cart with items and shipping information.

Authentication

string

required

Device authentication token from Browser Session

Path Parameters

string

required

The merchant domain (e.g., “staging.luma.gift”)

Request Body

string

required

JWE-encrypted credit card data using the public key from Get Public Key endpoint

object

required

Billing address informationRequired fields:

first_name (string): Customer’s first name
last_name (string): Customer’s last name
email (string): Email address
phone (string): Phone number
address1 (string): Primary address line
city (string): City name
state_or_province (string): State/province code
country (string): Country name or code
postal_code (string): ZIP or postal code

Optional fields:

address2 (string): Secondary address line
company (string): Company name

string

Captcha verification token when required by merchant

Response

Returns an order confirmation object with:

string

The order number from the merchant

string

Unique identifier for the cart

array

Array of items in the order

object

Final order total with currency information

object

Delivery address details

object

Selected shipping option with pricing

Credit Card Encryption

The credit card must be encrypted as a JWE token with the following structure:

{
  "number": "4111111111111111",
  "name": "John Smith",
  "verification_value": "123",
  "month": "08",
  "year": "2025"
}

Code Example

// 1. Get public key
const keyResponse = await fetch('https://cc.firmly.work/api/v1/payment/key');
const publicKey = await keyResponse.json();

// 2. Encrypt card data (using jose or similar library)
const encryptedCard = await encryptCardData(cardData, publicKey);

// 3. Complete order
const response = await fetch('https://cc.firmly.work/api/v1/payment/domains/staging.luma.gift/complete-order', {
  method: 'POST',
  headers: {
    'x-firmly-authorization': authToken,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    encrypted_card: encryptedCard,
    billing_info: {
      first_name: 'John',
      last_name: 'Smith',
      email: 'john@staging.luma.gift',
      phone: '2065551212',
      address1: '123 Main St',
      city: 'Seattle',
      state_or_province: 'WA',
      country: 'US',
      postal_code: '98101'
    }
  })
});

const order = await response.json();

Prerequisites

Before calling this endpoint:

Cart must have at least one item
Shipping information must be set
Shipping method must be selected

Error Responses

Code	Description
`ErrorInvalidInputBody`	Request validation failed
`ErrorMissingRequiredParameters`	Cart missing required data
`ErrorCartNotFound`	No cart found for domain
`ErrorPaymentDeclined`	Payment was declined
`ErrorStoreUnavailable`	Merchant temporarily unavailable

Get Public Key - Get encryption key
Set Shipping Info - Add delivery address
Add Line Item - Add products to cart

⌘I

Complete Order

curl --request POST \
  --url https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-firmly-authorization: <x-firmly-authorization>' \
  --data '
{
  "encrypted_card": "<string>",
  "billing_info": {},
  "captcha_token": "<string>"
}
'

import requests

url = "https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order"

payload = {
    "encrypted_card": "<string>",
    "billing_info": {},
    "captcha_token": "<string>"
}
headers = {
    "x-firmly-authorization": "<x-firmly-authorization>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-firmly-authorization': '<x-firmly-authorization>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({encrypted_card: '<string>', billing_info: {}, captcha_token: '<string>'})
};

fetch('https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'encrypted_card' => '<string>',
    'billing_info' => [
        
    ],
    'captcha_token' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-firmly-authorization: <x-firmly-authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order"

	payload := strings.NewReader("{\n  \"encrypted_card\": \"<string>\",\n  \"billing_info\": {},\n  \"captcha_token\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-firmly-authorization", "<x-firmly-authorization>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order")
  .header("x-firmly-authorization", "<x-firmly-authorization>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"encrypted_card\": \"<string>\",\n  \"billing_info\": {},\n  \"captcha_token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cc.firmly.work/api/v1/payment/domains/{domain}/complete-order")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-firmly-authorization"] = '<x-firmly-authorization>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"encrypted_card\": \"<string>\",\n  \"billing_info\": {},\n  \"captcha_token\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "platform_order_number": "<string>",
  "cart_id": "<string>",
  "line_items": [
    {}
  ],
  "total": {},
  "shipping_info": {},
  "shipping_method": {}
}

Home

Core Concepts

Implementation Guides

Ask Agent SDK

API Reference

firmly Connect

Resources

Overview

Authentication

Path Parameters

Request Body

Response

Credit Card Encryption

Code Example

Prerequisites

Error Responses

​Overview

​Authentication

​Path Parameters

​Request Body

​Response

​Credit Card Encryption

​Code Example

​Prerequisites

​Error Responses

​Related Endpoints

Overview

Authentication

Path Parameters

Request Body

Response

Credit Card Encryption

Code Example

Prerequisites

Error Responses

Related Endpoints