cURL
curl --request POST \
--url https://api.example.com/v1/account/orders/{orderID}/refresh \
--header 'X-CSRF-Token: <x-csrf-token>'import requests
url = "https://api.example.com/v1/account/orders/{orderID}/refresh"
headers = {"X-CSRF-Token": "<x-csrf-token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-CSRF-Token': '<x-csrf-token>'}};
fetch('https://api.example.com/v1/account/orders/{orderID}/refresh', 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}/refresh",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/account/orders/{orderID}/refresh"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
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}/refresh")
.header("X-CSRF-Token", "<x-csrf-token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/account/orders/{orderID}/refresh")
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>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "draft",
"operation": "<string>",
"phase": "<string>",
"currency": "<string>",
"subtotalMinor": 123,
"discountMinor": 123,
"walletMinor": 123,
"externalMinor": 123,
"paidMinor": 123,
"refundedMinor": 123,
"plan": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"subscriptionId": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"payment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"status": "<string>",
"handoff": "hosted",
"checkoutUrl": "<string>",
"receiptUrl": "<string>"
},
"fulfillment": {
"status": "<string>",
"attempts": 123,
"errorCode": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"refunds": [
{
"status": "<string>",
"amountMinor": 123,
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"paymentChoices": [
{
"provider": "<string>",
"currency": "<string>",
"recurring": true,
"amountMinor": 123
}
],
"preferredProvider": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}account
Post v1accountorders refresh
Re-reads the provider so a customer who returns before the webhook arrives still sees the settled state.
POST
/
v1
/
account
/
orders
/
{orderID}
/
refresh
cURL
curl --request POST \
--url https://api.example.com/v1/account/orders/{orderID}/refresh \
--header 'X-CSRF-Token: <x-csrf-token>'import requests
url = "https://api.example.com/v1/account/orders/{orderID}/refresh"
headers = {"X-CSRF-Token": "<x-csrf-token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-CSRF-Token': '<x-csrf-token>'}};
fetch('https://api.example.com/v1/account/orders/{orderID}/refresh', 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}/refresh",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/account/orders/{orderID}/refresh"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
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}/refresh")
.header("X-CSRF-Token", "<x-csrf-token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/account/orders/{orderID}/refresh")
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>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "draft",
"operation": "<string>",
"phase": "<string>",
"currency": "<string>",
"subtotalMinor": 123,
"discountMinor": 123,
"walletMinor": 123,
"externalMinor": 123,
"paidMinor": 123,
"refundedMinor": 123,
"plan": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"subscriptionId": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"payment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"status": "<string>",
"handoff": "hosted",
"checkoutUrl": "<string>",
"receiptUrl": "<string>"
},
"fulfillment": {
"status": "<string>",
"attempts": 123,
"errorCode": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"refunds": [
{
"status": "<string>",
"amountMinor": 123,
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"paymentChoices": [
{
"provider": "<string>",
"currency": "<string>",
"recurring": true,
"amountMinor": 123
}
],
"preferredProvider": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}Headers
Echoes the token from the current session. Required on every unsafe method.
Path Parameters
Response
Order
Available options:
draft, pending, paid, fulfilled, cancelled, expired, partially_refunded, refunded The combined payment and provisioning state the panel renders: what the customer is waiting for, rather than which table changed.
Show child attributes
Show child attributes
Provisioning progress, read from the fulfillment operation rather than carried by the client.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The methods that can settle this order in its currency, each priced at what the order still owes. Present on the detail response while the order is pending and owes something, so the page can offer a method without depending on the URL the checkout redirected to. Telegram Stars appears only for a customer with a Telegram identity.
Show child attributes
Show child attributes
The method the checkout recorded, while that checkout is still attached to the order.