Create an order

POST/orders

Body application/json

amountintegerrequired

Amount in the smallest currency unit.

currencystringrequired

Three-letter ISO 4217 code.

Response

The created order.

idstring

amountinteger

currencystring

status"pending" | "paid" | "canceled"

Missing or invalid API key.

errorobject

Show error properties

codestring

messagestring

Request

curl -X POST "https://sandbox.api.example.com/v1/orders" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
  "amount": 2500,
  "currency": "USD"
}'

const response = await fetch(`https://sandbox.api.example.com/v1/orders`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer <token>' },
  body: JSON.stringify({
  "amount": 2500,
  "currency": "USD"
})
});
const data = await response.json();

import requests

response = requests.request(
    "POST",
    "https://sandbox.api.example.com/v1/orders",
    headers={ "Authorization": "Bearer <token>" },
    json={
  "amount": 2500,
  "currency": "USD"
},
)
data = response.json()

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://sandbox.api.example.com/v1/orders");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json", "Authorization: Bearer <token>"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "amount": 2500,
  "currency": "USD"
}');
$response = curl_exec($ch);
curl_close($ch);

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://sandbox.api.example.com/v1/orders", strings.NewReader(`{
  "amount": 2500,
  "currency": "USD"
}`))
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer <token>")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, _ := io.ReadAll(resp.Body)
	fmt.Println(string(data))
}

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox.api.example.com/v1/orders"))
    .header("Content-Type", "application/json")
    .header("Authorization", "Bearer <token>")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"amount\": 2500,\n  \"currency\": \"USD\"\n}"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require "net/http"
require "uri"

uri = URI("https://sandbox.api.example.com/v1/orders")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer <token>"
request.body = "{\n  \"amount\": 2500,\n  \"currency\": \"USD\"\n}"

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

Response

{
  "id": "ord_123",
  "amount": 2500,
  "currency": "USD",
  "status": "pending"
}

{
  "error": {
    "code": "not_found",
    "message": "Order not found."
  }
}

Authentication

Request

curl -X POST "https://sandbox.api.example.com/v1/orders" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
  "amount": 2500,
  "currency": "USD"
}'

const response = await fetch(`https://sandbox.api.example.com/v1/orders`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer <token>' },
  body: JSON.stringify({
  "amount": 2500,
  "currency": "USD"
})
});
const data = await response.json();

import requests

response = requests.request(
    "POST",
    "https://sandbox.api.example.com/v1/orders",
    headers={ "Authorization": "Bearer <token>" },
    json={
  "amount": 2500,
  "currency": "USD"
},
)
data = response.json()

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://sandbox.api.example.com/v1/orders");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json", "Authorization: Bearer <token>"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
  "amount": 2500,
  "currency": "USD"
}');
$response = curl_exec($ch);
curl_close($ch);

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://sandbox.api.example.com/v1/orders", strings.NewReader(`{
  "amount": 2500,
  "currency": "USD"
}`))
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer <token>")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, _ := io.ReadAll(resp.Body)
	fmt.Println(string(data))
}

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox.api.example.com/v1/orders"))
    .header("Content-Type", "application/json")
    .header("Authorization", "Bearer <token>")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"amount\": 2500,\n  \"currency\": \"USD\"\n}"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require "net/http"
require "uri"

uri = URI("https://sandbox.api.example.com/v1/orders")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer <token>"
request.body = "{\n  \"amount\": 2500,\n  \"currency\": \"USD\"\n}"

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

Response