Activate Issued Gift Card
curl --request POST \
--url https://api.decodahealth.com/billing/gift-cards/issued/{gift_card_id}/activate \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"sendNotification": true
}
'import requests
url = "https://api.decodahealth.com/billing/gift-cards/issued/{gift_card_id}/activate"
payload = { "sendNotification": True }
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({sendNotification: true})
};
fetch('https://api.decodahealth.com/billing/gift-cards/issued/{gift_card_id}/activate', 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/gift-cards/issued/{gift_card_id}/activate",
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([
'sendNotification' => true
]),
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/gift-cards/issued/{gift_card_id}/activate"
payload := strings.NewReader("{\n \"sendNotification\": true\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/gift-cards/issued/{gift_card_id}/activate")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sendNotification\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/gift-cards/issued/{gift_card_id}/activate")
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 \"sendNotification\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"code": "<string>",
"initialValue": 123,
"currentBalance": 123,
"isActive": true,
"status": "PENDING",
"createdDate": "2023-11-07T05:31:56Z",
"purchasingPatientId": "<string>",
"purchasingPatientName": "<string>",
"recipientPatientId": "<string>",
"recipientPatientName": "<string>",
"recipientNote": "<string>",
"activatedAt": "2023-11-07T05:31:56Z",
"recipientPatientEmail": "<string>",
"recipientPatientPhone": "<string>",
"chargeItemId": "<string>",
"purchasingPatientEmail": "<string>",
"purchasingPatientPhone": "<string>",
"scheduledSendDate": "2023-11-07T05:31:56Z",
"suppressRecipientNotification": false,
"notificationSentAt": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"transactions": []
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Gift Cards
Activate Issued Gift Card
Staff-initiated activation of a pending gift card.
Flips the card to active and (by default) sends the recipient notification. 409 if the card is not pending. Returns the updated card so the client can write it straight into its React Query cache: reads hit a replica that can lag this write, so a refetch could resurrect the pre-activation row.
POST
/
billing
/
gift-cards
/
issued
/
{gift_card_id}
/
activate
Activate Issued Gift Card
curl --request POST \
--url https://api.decodahealth.com/billing/gift-cards/issued/{gift_card_id}/activate \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"sendNotification": true
}
'import requests
url = "https://api.decodahealth.com/billing/gift-cards/issued/{gift_card_id}/activate"
payload = { "sendNotification": True }
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({sendNotification: true})
};
fetch('https://api.decodahealth.com/billing/gift-cards/issued/{gift_card_id}/activate', 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/gift-cards/issued/{gift_card_id}/activate",
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([
'sendNotification' => true
]),
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/gift-cards/issued/{gift_card_id}/activate"
payload := strings.NewReader("{\n \"sendNotification\": true\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/gift-cards/issued/{gift_card_id}/activate")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sendNotification\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/gift-cards/issued/{gift_card_id}/activate")
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 \"sendNotification\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"code": "<string>",
"initialValue": 123,
"currentBalance": 123,
"isActive": true,
"status": "PENDING",
"createdDate": "2023-11-07T05:31:56Z",
"purchasingPatientId": "<string>",
"purchasingPatientName": "<string>",
"recipientPatientId": "<string>",
"recipientPatientName": "<string>",
"recipientNote": "<string>",
"activatedAt": "2023-11-07T05:31:56Z",
"recipientPatientEmail": "<string>",
"recipientPatientPhone": "<string>",
"chargeItemId": "<string>",
"purchasingPatientEmail": "<string>",
"purchasingPatientPhone": "<string>",
"scheduledSendDate": "2023-11-07T05:31:56Z",
"suppressRecipientNotification": false,
"notificationSentAt": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"transactions": []
}{
"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
Response
Successful Response
Available options:
PENDING, ACTIVE, DISABLED, VOIDED Show child attributes
Show child attributes

