cURL

curl --request POST \
  --url https://api.example.com/v1/account/orders/{orderID}/payment \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-CSRF-Token: <x-csrf-token>' \
  --data '
{
  "provider": "<string>"
}
'

import requests

url = "https://api.example.com/v1/account/orders/{orderID}/payment"

payload = { "provider": "<string>" }
headers = {
    "X-CSRF-Token": "<x-csrf-token>",
    "Idempotency-Key": "<idempotency-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-CSRF-Token': '<x-csrf-token>',
    'Idempotency-Key': '<idempotency-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({provider: '<string>'})
};

fetch('https://api.example.com/v1/account/orders/{orderID}/payment', 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/account/orders/{orderID}/payment",
  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([
    'provider' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-CSRF-Token: <x-csrf-token>"
  ],
]);

$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/account/orders/{orderID}/payment"

	payload := strings.NewReader("{\n  \"provider\": \"<string>\"\n}")

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

	req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
	req.Header.Add("Idempotency-Key", "<idempotency-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/account/orders/{orderID}/payment")
  .header("X-CSRF-Token", "<x-csrf-token>")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/account/orders/{orderID}/payment")

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

request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider": "<string>",
  "status": "<string>",
  "amountMinor": 123,
  "currency": "<string>",
  "handoff": "hosted",
  "checkoutUrl": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

account

Post v1accountorders payment

Creates or resumes the provider payment. The key is scoped to the order and the chosen adapter, so switching provider is a new payment while pressing the same button twice is not. The provider defaults to the one the order’s payment already names, then to the one the checkout that became this order recorded. An order that is no longer pending, or whose expiry has passed, answers 409 order_not_payable; a configured method that does not settle the order’s currency answers 422 provider_currency_unsupported.

POST

account

orders

{orderID}

payment

cURL

curl --request POST \
  --url https://api.example.com/v1/account/orders/{orderID}/payment \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-CSRF-Token: <x-csrf-token>' \
  --data '
{
  "provider": "<string>"
}
'

import requests

url = "https://api.example.com/v1/account/orders/{orderID}/payment"

payload = { "provider": "<string>" }
headers = {
    "X-CSRF-Token": "<x-csrf-token>",
    "Idempotency-Key": "<idempotency-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-CSRF-Token': '<x-csrf-token>',
    'Idempotency-Key': '<idempotency-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({provider: '<string>'})
};

fetch('https://api.example.com/v1/account/orders/{orderID}/payment', 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/account/orders/{orderID}/payment",
  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([
    'provider' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-CSRF-Token: <x-csrf-token>"
  ],
]);

$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/account/orders/{orderID}/payment"

	payload := strings.NewReader("{\n  \"provider\": \"<string>\"\n}")

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

	req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
	req.Header.Add("Idempotency-Key", "<idempotency-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/account/orders/{orderID}/payment")
  .header("X-CSRF-Token", "<x-csrf-token>")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/account/orders/{orderID}/payment")

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

request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider": "<string>",
  "status": "<string>",
  "amountMinor": 123,
  "currency": "<string>",
  "handoff": "hosted",
  "checkoutUrl": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

Headers

X-CSRF-Token

string

required

Echoes the token from the current session. Required on every unsafe method.

Idempotency-Key

string

required

Required string length: 8 - 128

Path Parameters

orderID

string<uuid>

required

Body

application/json

provider

string

Response

Payment handoff

string<uuid>

required

provider

string

required

status

string

required

amountMinor

integer<int64>

required

currency

string

required

handoff

enum<string>

required

How the customer completes the payment. none means nothing further is owed, which is what a wallet-covered order looks like.

Available options:

hosted,

telegram_invoice,

manual,

none

checkoutUrl

string

Start

Architecture

For customers

Commerce

Integrations

API reference

Operator panel

AI and MCP

Running Omniflow

Contributing

Post v1accountorders payment

Headers

Path Parameters

Body

Response