Get refund availability
curl --request GET \
--url https://api.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability', 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.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <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.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"is_refundable": true,
"refundable_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"refunded_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"pending_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"has_pending_refund": true,
"available_types": [
"full",
"partial"
],
"unavailable_reason": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Refunds
Get refund availability
What this payment can still be refunded for, before you submit an amount: the remaining balance, whether a refund is possible at all, and which refund types it allows.
GET
/
payment
/
intents
/
{paymentIntentId}
/
refunds
/
availability
Get refund availability
curl --request GET \
--url https://api.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability', 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.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <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.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orqex.com/v1/payment/intents/{paymentIntentId}/refunds/availability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"is_refundable": true,
"refundable_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"refunded_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"pending_amount": {
"value": 50,
"formatted": "$50.00",
"short": "$50",
"currency": "USD"
},
"has_pending_refund": true,
"available_types": [
"full",
"partial"
],
"unavailable_reason": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Your secret key, e.g. sk_live_... or sk_sandbox_....
Path Parameters
The payment intent id.
Response
The refund position of the payment.
What this payment can still be refunded for. refundable_amount is authoritative: it already reserves in-flight refunds, so a refund up to that amount is the one guaranteed not to be rejected on balance.
Show child attributes
Show child attributes
Was this page helpful?
⌘I