Create an invoice

curl --request POST \
  --url https://api.example.com/v1/invoices \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "sellerExternalId": "seller-42",
  "buyerEmail": "buyer@acme.com",
  "buyerName": "ACME Imports LLC",
  "amount": "12500.00",
  "currency": "USD",
  "lineItems": [
    {
      "description": "Order #42 — green coffee, 18t",
      "quantity": "1",
      "unitPrice": "12500.00",
      "subtotal": "12500.00"
    }
  ]
}
'

import requests

url = "https://api.example.com/v1/invoices"

payload = {
    "sellerExternalId": "seller-42",
    "buyerEmail": "buyer@acme.com",
    "buyerName": "ACME Imports LLC",
    "amount": "12500.00",
    "currency": "USD",
    "lineItems": [
        {
            "description": "Order #42 — green coffee, 18t",
            "quantity": "1",
            "unitPrice": "12500.00",
            "subtotal": "12500.00"
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    sellerExternalId: 'seller-42',
    buyerEmail: 'buyer@acme.com',
    buyerName: 'ACME Imports LLC',
    amount: '12500.00',
    currency: 'USD',
    lineItems: [
      {
        description: 'Order #42 — green coffee, 18t',
        quantity: '1',
        unitPrice: '12500.00',
        subtotal: '12500.00'
      }
    ]
  })
};

fetch('https://api.example.com/v1/invoices', 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://api.example.com/v1/invoices",
  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([
    'sellerExternalId' => 'seller-42',
    'buyerEmail' => 'buyer@acme.com',
    'buyerName' => 'ACME Imports LLC',
    'amount' => '12500.00',
    'currency' => 'USD',
    'lineItems' => [
        [
                'description' => 'Order #42 — green coffee, 18t',
                'quantity' => '1',
                'unitPrice' => '12500.00',
                'subtotal' => '12500.00'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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://api.example.com/v1/invoices"

	payload := strings.NewReader("{\n  \"sellerExternalId\": \"seller-42\",\n  \"buyerEmail\": \"buyer@acme.com\",\n  \"buyerName\": \"ACME Imports LLC\",\n  \"amount\": \"12500.00\",\n  \"currency\": \"USD\",\n  \"lineItems\": [\n    {\n      \"description\": \"Order #42 — green coffee, 18t\",\n      \"quantity\": \"1\",\n      \"unitPrice\": \"12500.00\",\n      \"subtotal\": \"12500.00\"\n    }\n  ]\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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://api.example.com/v1/invoices")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sellerExternalId\": \"seller-42\",\n  \"buyerEmail\": \"buyer@acme.com\",\n  \"buyerName\": \"ACME Imports LLC\",\n  \"amount\": \"12500.00\",\n  \"currency\": \"USD\",\n  \"lineItems\": [\n    {\n      \"description\": \"Order #42 — green coffee, 18t\",\n      \"quantity\": \"1\",\n      \"unitPrice\": \"12500.00\",\n      \"subtotal\": \"12500.00\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/invoices")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sellerExternalId\": \"seller-42\",\n  \"buyerEmail\": \"buyer@acme.com\",\n  \"buyerName\": \"ACME Imports LLC\",\n  \"amount\": \"12500.00\",\n  \"currency\": \"USD\",\n  \"lineItems\": [\n    {\n      \"description\": \"Order #42 — green coffee, 18t\",\n      \"quantity\": \"1\",\n      \"unitPrice\": \"12500.00\",\n      \"subtotal\": \"12500.00\"\n    }\n  ]\n}"

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

{
  "id": "ckxinv042",
  "publicId": "ckpub042",
  "orgId": "ckorg001",
  "buyerId": "ckbuy001",
  "buyerEmail": "buyer@acme.com",
  "buyerName": "ACME Imports LLC",
  "sellerConnectedAccountId": "ckacc042",
  "sellerExternalId": "seller-42",
  "sellerName": "Fazenda Boa Vista",
  "status": "draft",
  "currency": "USD",
  "amount": "12500.00",
  "requestNetworkId": null,
  "paymentChain": "base",
  "paymentAddress": "0x5fbe…a91c",
  "dueDate": null,
  "expiresAt": null,
  "cancelReason": null,
  "pendingApproval": false,
  "buyerRef": null,
  "dueNumber": null,
  "exportContractRef": null,
  "incoterm": null,
  "portOfLoading": null,
  "feeBps": 50,
  "feeAmount": "62.50",
  "brlSettledAmount": null,
  "fxRateAtSettlement": null,
  "createdAt": "2026-06-30T12:00:00.000Z",
  "updatedAt": "2026-06-30T12:00:00.000Z",
  "lineItems": [
    {
      "id": "ckli001",
      "description": "Order #42 — green coffee, 18t",
      "quantity": "1",
      "unitPrice": "12500.00",
      "subtotal": "12500.00",
      "ncmCode": null,
      "originState": null
    }
  ],
  "timeline": [
    {
      "id": "ckev001",
      "invoiceId": "ckxinv042",
      "type": "created",
      "source": "caratuva",
      "externalEventId": null,
      "occurredAt": "2026-06-30T12:00:00.000Z"
    }
  ]
}

{
  "statusCode": 400,
  "error": "SellerNotFound",
  "message": "No ready-to-collect seller for that sellerExternalId (also: SellerKybNotApproved, BuyerAccountNotApproved, amount below the minimum)."
}

POST

invoices

Create an invoice

curl --request POST \
  --url https://api.example.com/v1/invoices \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "sellerExternalId": "seller-42",
  "buyerEmail": "buyer@acme.com",
  "buyerName": "ACME Imports LLC",
  "amount": "12500.00",
  "currency": "USD",
  "lineItems": [
    {
      "description": "Order #42 — green coffee, 18t",
      "quantity": "1",
      "unitPrice": "12500.00",
      "subtotal": "12500.00"
    }
  ]
}
'

import requests

url = "https://api.example.com/v1/invoices"

payload = {
    "sellerExternalId": "seller-42",
    "buyerEmail": "buyer@acme.com",
    "buyerName": "ACME Imports LLC",
    "amount": "12500.00",
    "currency": "USD",
    "lineItems": [
        {
            "description": "Order #42 — green coffee, 18t",
            "quantity": "1",
            "unitPrice": "12500.00",
            "subtotal": "12500.00"
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    sellerExternalId: 'seller-42',
    buyerEmail: 'buyer@acme.com',
    buyerName: 'ACME Imports LLC',
    amount: '12500.00',
    currency: 'USD',
    lineItems: [
      {
        description: 'Order #42 — green coffee, 18t',
        quantity: '1',
        unitPrice: '12500.00',
        subtotal: '12500.00'
      }
    ]
  })
};

fetch('https://api.example.com/v1/invoices', 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://api.example.com/v1/invoices",
  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([
    'sellerExternalId' => 'seller-42',
    'buyerEmail' => 'buyer@acme.com',
    'buyerName' => 'ACME Imports LLC',
    'amount' => '12500.00',
    'currency' => 'USD',
    'lineItems' => [
        [
                'description' => 'Order #42 — green coffee, 18t',
                'quantity' => '1',
                'unitPrice' => '12500.00',
                'subtotal' => '12500.00'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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://api.example.com/v1/invoices"

	payload := strings.NewReader("{\n  \"sellerExternalId\": \"seller-42\",\n  \"buyerEmail\": \"buyer@acme.com\",\n  \"buyerName\": \"ACME Imports LLC\",\n  \"amount\": \"12500.00\",\n  \"currency\": \"USD\",\n  \"lineItems\": [\n    {\n      \"description\": \"Order #42 — green coffee, 18t\",\n      \"quantity\": \"1\",\n      \"unitPrice\": \"12500.00\",\n      \"subtotal\": \"12500.00\"\n    }\n  ]\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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://api.example.com/v1/invoices")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sellerExternalId\": \"seller-42\",\n  \"buyerEmail\": \"buyer@acme.com\",\n  \"buyerName\": \"ACME Imports LLC\",\n  \"amount\": \"12500.00\",\n  \"currency\": \"USD\",\n  \"lineItems\": [\n    {\n      \"description\": \"Order #42 — green coffee, 18t\",\n      \"quantity\": \"1\",\n      \"unitPrice\": \"12500.00\",\n      \"subtotal\": \"12500.00\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/invoices")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sellerExternalId\": \"seller-42\",\n  \"buyerEmail\": \"buyer@acme.com\",\n  \"buyerName\": \"ACME Imports LLC\",\n  \"amount\": \"12500.00\",\n  \"currency\": \"USD\",\n  \"lineItems\": [\n    {\n      \"description\": \"Order #42 — green coffee, 18t\",\n      \"quantity\": \"1\",\n      \"unitPrice\": \"12500.00\",\n      \"subtotal\": \"12500.00\"\n    }\n  ]\n}"

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

{
  "id": "ckxinv042",
  "publicId": "ckpub042",
  "orgId": "ckorg001",
  "buyerId": "ckbuy001",
  "buyerEmail": "buyer@acme.com",
  "buyerName": "ACME Imports LLC",
  "sellerConnectedAccountId": "ckacc042",
  "sellerExternalId": "seller-42",
  "sellerName": "Fazenda Boa Vista",
  "status": "draft",
  "currency": "USD",
  "amount": "12500.00",
  "requestNetworkId": null,
  "paymentChain": "base",
  "paymentAddress": "0x5fbe…a91c",
  "dueDate": null,
  "expiresAt": null,
  "cancelReason": null,
  "pendingApproval": false,
  "buyerRef": null,
  "dueNumber": null,
  "exportContractRef": null,
  "incoterm": null,
  "portOfLoading": null,
  "feeBps": 50,
  "feeAmount": "62.50",
  "brlSettledAmount": null,
  "fxRateAtSettlement": null,
  "createdAt": "2026-06-30T12:00:00.000Z",
  "updatedAt": "2026-06-30T12:00:00.000Z",
  "lineItems": [
    {
      "id": "ckli001",
      "description": "Order #42 — green coffee, 18t",
      "quantity": "1",
      "unitPrice": "12500.00",
      "subtotal": "12500.00",
      "ncmCode": null,
      "originState": null
    }
  ],
  "timeline": [
    {
      "id": "ckev001",
      "invoiceId": "ckxinv042",
      "type": "created",
      "source": "caratuva",
      "externalEventId": null,
      "occurredAt": "2026-06-30T12:00:00.000Z"
    }
  ]
}

{
  "statusCode": 400,
  "error": "SellerNotFound",
  "message": "No ready-to-collect seller for that sellerExternalId (also: SellerKybNotApproved, BuyerAccountNotApproved, amount below the minimum)."
}

Authorizations

X-API-Key

string

header

required

Headers

Idempotency-Key

string

Body

application/json

amount

string

required

Pattern: ^\d+(\.\d{1,2})?$

lineItems

object[]

required

Required array length: 1 - 500 elements

Show child attributes

sellerExternalId

string

required

Required string length: 1 - 200

buyerExternalId

string

Required string length: 1 - 200

buyerEmail

string<email>

buyerName

string

Required string length: 1 - 200

buyerCountry

string

Required string length: 2

currency

string

default:USD

Required string length: 3

dueDate

string<date-time>

expiresAt

string<date-time>

buyerRef

string

Maximum string length: 200

dueNumber

string

Pattern: ^\d{11}$

exportContractRef

string

Maximum string length: 200

incoterm

enum<string>

Available options:

FOB,

CIF,

FCA,

CFR,

EXW,

DAP,

DDP

portOfLoading

string

Maximum string length: 64

Response

Invoice created

string

required

publicId

string

required

orgId

string

required

buyerId

string

required

sellerConnectedAccountId

string

required

sellerExternalId

string | null

required

sellerName

string | null

required

status

enum<string>

required

Available options:

draft,

awaiting_approval,

approved,

awaiting_buyer,

buyer_kyc_pending,

buyer_kyc_approved,

buyer_kyc_rejected,

fx_quoted,

fx_expired,

on_ramp_pending,

on_ramp_failed,

fiat_received,

on_chain_confirmed,

offramp_pending,

offramp_failed,

settled,

partial_payment,

expired,

cancelled,

restored,

manual_review

currency

string

required

amount

string

required

requestNetworkId

string | null

required

paymentChain

string | null

required

paymentAddress

string | null

required

dueDate

string | null

required

expiresAt

string | null

required

cancelReason

string | null

required

pendingApproval

boolean

required

buyerRef

string | null

required

dueNumber

string | null

required

exportContractRef

string | null

required

incoterm

string | null

required

portOfLoading

string | null

required

feeBps

integer | null

required

feeAmount

string | null

required

brlSettledAmount

string | null

required

fxRateAtSettlement

string | null

required

createdAt

string

required

updatedAt

string

required

timeline

object[]

required

Show child attributes

buyerEmail

string<email>

buyerName

string | null

lineItems

object[]

Show child attributes

Overview

Integration

Endpoints

Create an invoice

Authorizations

Headers

Body

Response