Preview Item Refund
curl --request POST \
--url https://api.decodahealth.com/billing/payment/{payment_id}/refund-preview \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"items": [
{
"chargeItemId": "<string>",
"quantity": 1,
"soldPackageId": "<string>",
"issuedGiftCardId": "<string>",
"reversalActions": []
}
],
"refundDestination": "ORIGINAL_METHOD"
}
'import requests
url = "https://api.decodahealth.com/billing/payment/{payment_id}/refund-preview"
payload = {
"items": [
{
"chargeItemId": "<string>",
"quantity": 1,
"soldPackageId": "<string>",
"issuedGiftCardId": "<string>",
"reversalActions": []
}
],
"refundDestination": "ORIGINAL_METHOD"
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
chargeItemId: '<string>',
quantity: 1,
soldPackageId: '<string>',
issuedGiftCardId: '<string>',
reversalActions: []
}
],
refundDestination: 'ORIGINAL_METHOD'
})
};
fetch('https://api.decodahealth.com/billing/payment/{payment_id}/refund-preview', 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.decodahealth.com/billing/payment/{payment_id}/refund-preview",
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([
'items' => [
[
'chargeItemId' => '<string>',
'quantity' => 1,
'soldPackageId' => '<string>',
'issuedGiftCardId' => '<string>',
'reversalActions' => [
]
]
],
'refundDestination' => 'ORIGINAL_METHOD'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/billing/payment/{payment_id}/refund-preview"
payload := strings.NewReader("{\n \"items\": [\n {\n \"chargeItemId\": \"<string>\",\n \"quantity\": 1,\n \"soldPackageId\": \"<string>\",\n \"issuedGiftCardId\": \"<string>\",\n \"reversalActions\": []\n }\n ],\n \"refundDestination\": \"ORIGINAL_METHOD\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("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.decodahealth.com/billing/payment/{payment_id}/refund-preview")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"chargeItemId\": \"<string>\",\n \"quantity\": 1,\n \"soldPackageId\": \"<string>\",\n \"issuedGiftCardId\": \"<string>\",\n \"reversalActions\": []\n }\n ],\n \"refundDestination\": \"ORIGINAL_METHOD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/payment/{payment_id}/refund-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"chargeItemId\": \"<string>\",\n \"quantity\": 1,\n \"soldPackageId\": \"<string>\",\n \"issuedGiftCardId\": \"<string>\",\n \"reversalActions\": []\n }\n ],\n \"refundDestination\": \"ORIGINAL_METHOD\"\n}"
response = http.request(request)
puts response.read_body{
"paymentId": "<string>",
"itemSubtotal": 123,
"surchargeAmount": 123,
"refundTotal": 123,
"items": [
{
"chargeItemId": "<string>",
"grossAmount": 123,
"discountAmount": 123,
"amount": 123,
"taxAmount": 123,
"refundAmount": 123,
"quantity": 123,
"soldPackageId": "<string>",
"issuedGiftCardId": "<string>",
"reversalActions": [],
"availableReversalActions": []
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Payments
Preview Item Refund
Preview the amounts and side effects of a line-item refund before it is submitted.
POST
/
billing
/
payment
/
{payment_id}
/
refund-preview
Preview Item Refund
curl --request POST \
--url https://api.decodahealth.com/billing/payment/{payment_id}/refund-preview \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"items": [
{
"chargeItemId": "<string>",
"quantity": 1,
"soldPackageId": "<string>",
"issuedGiftCardId": "<string>",
"reversalActions": []
}
],
"refundDestination": "ORIGINAL_METHOD"
}
'import requests
url = "https://api.decodahealth.com/billing/payment/{payment_id}/refund-preview"
payload = {
"items": [
{
"chargeItemId": "<string>",
"quantity": 1,
"soldPackageId": "<string>",
"issuedGiftCardId": "<string>",
"reversalActions": []
}
],
"refundDestination": "ORIGINAL_METHOD"
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
chargeItemId: '<string>',
quantity: 1,
soldPackageId: '<string>',
issuedGiftCardId: '<string>',
reversalActions: []
}
],
refundDestination: 'ORIGINAL_METHOD'
})
};
fetch('https://api.decodahealth.com/billing/payment/{payment_id}/refund-preview', 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.decodahealth.com/billing/payment/{payment_id}/refund-preview",
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([
'items' => [
[
'chargeItemId' => '<string>',
'quantity' => 1,
'soldPackageId' => '<string>',
'issuedGiftCardId' => '<string>',
'reversalActions' => [
]
]
],
'refundDestination' => 'ORIGINAL_METHOD'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/billing/payment/{payment_id}/refund-preview"
payload := strings.NewReader("{\n \"items\": [\n {\n \"chargeItemId\": \"<string>\",\n \"quantity\": 1,\n \"soldPackageId\": \"<string>\",\n \"issuedGiftCardId\": \"<string>\",\n \"reversalActions\": []\n }\n ],\n \"refundDestination\": \"ORIGINAL_METHOD\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("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.decodahealth.com/billing/payment/{payment_id}/refund-preview")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"chargeItemId\": \"<string>\",\n \"quantity\": 1,\n \"soldPackageId\": \"<string>\",\n \"issuedGiftCardId\": \"<string>\",\n \"reversalActions\": []\n }\n ],\n \"refundDestination\": \"ORIGINAL_METHOD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/payment/{payment_id}/refund-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"chargeItemId\": \"<string>\",\n \"quantity\": 1,\n \"soldPackageId\": \"<string>\",\n \"issuedGiftCardId\": \"<string>\",\n \"reversalActions\": []\n }\n ],\n \"refundDestination\": \"ORIGINAL_METHOD\"\n}"
response = http.request(request)
puts response.read_body{
"paymentId": "<string>",
"itemSubtotal": 123,
"surchargeAmount": 123,
"refundTotal": 123,
"items": [
{
"chargeItemId": "<string>",
"grossAmount": 123,
"discountAmount": 123,
"amount": 123,
"taxAmount": 123,
"refundAmount": 123,
"quantity": 123,
"soldPackageId": "<string>",
"issuedGiftCardId": "<string>",
"reversalActions": [],
"availableReversalActions": []
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Body
application/json
⌘I
