Redeem a gift card against an invoice.
curl --request POST \
--url https://dash.dmly.io/api/v1/gift-cards/redeem \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"code": "GIFT-A1B2C3D4",
"invoice_id": "3c2b1a09-8f7e-6d5c-4b3a-291807060504",
"amount": 25
}
'import requests
url = "https://dash.dmly.io/api/v1/gift-cards/redeem"
payload = {
"code": "GIFT-A1B2C3D4",
"invoice_id": "3c2b1a09-8f7e-6d5c-4b3a-291807060504",
"amount": 25
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
code: 'GIFT-A1B2C3D4',
invoice_id: '3c2b1a09-8f7e-6d5c-4b3a-291807060504',
amount: 25
})
};
fetch('https://dash.dmly.io/api/v1/gift-cards/redeem', 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://dash.dmly.io/api/v1/gift-cards/redeem",
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([
'code' => 'GIFT-A1B2C3D4',
'invoice_id' => '3c2b1a09-8f7e-6d5c-4b3a-291807060504',
'amount' => 25
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://dash.dmly.io/api/v1/gift-cards/redeem"
payload := strings.NewReader("{\n \"code\": \"GIFT-A1B2C3D4\",\n \"invoice_id\": \"3c2b1a09-8f7e-6d5c-4b3a-291807060504\",\n \"amount\": 25\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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://dash.dmly.io/api/v1/gift-cards/redeem")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"GIFT-A1B2C3D4\",\n \"invoice_id\": \"3c2b1a09-8f7e-6d5c-4b3a-291807060504\",\n \"amount\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dash.dmly.io/api/v1/gift-cards/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"GIFT-A1B2C3D4\",\n \"invoice_id\": \"3c2b1a09-8f7e-6d5c-4b3a-291807060504\",\n \"amount\": 25\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>"
}Redeem a gift card against an invoice.
Draws a gift card (identified by its code) against an invoice (identified by its uuid), recording a gift_card payment that settles the invoice. An optional amount caps how much to draw; otherwise the lesser of the card balance and the invoice’s amount due is applied. Responds with the redeemed amount, the card’s remaining balance and the invoice’s new amount due, or 422 if redemption fails.
POST
/
gift-cards
/
redeem
Redeem a gift card against an invoice.
curl --request POST \
--url https://dash.dmly.io/api/v1/gift-cards/redeem \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"code": "GIFT-A1B2C3D4",
"invoice_id": "3c2b1a09-8f7e-6d5c-4b3a-291807060504",
"amount": 25
}
'import requests
url = "https://dash.dmly.io/api/v1/gift-cards/redeem"
payload = {
"code": "GIFT-A1B2C3D4",
"invoice_id": "3c2b1a09-8f7e-6d5c-4b3a-291807060504",
"amount": 25
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
code: 'GIFT-A1B2C3D4',
invoice_id: '3c2b1a09-8f7e-6d5c-4b3a-291807060504',
amount: 25
})
};
fetch('https://dash.dmly.io/api/v1/gift-cards/redeem', 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://dash.dmly.io/api/v1/gift-cards/redeem",
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([
'code' => 'GIFT-A1B2C3D4',
'invoice_id' => '3c2b1a09-8f7e-6d5c-4b3a-291807060504',
'amount' => 25
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://dash.dmly.io/api/v1/gift-cards/redeem"
payload := strings.NewReader("{\n \"code\": \"GIFT-A1B2C3D4\",\n \"invoice_id\": \"3c2b1a09-8f7e-6d5c-4b3a-291807060504\",\n \"amount\": 25\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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://dash.dmly.io/api/v1/gift-cards/redeem")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"GIFT-A1B2C3D4\",\n \"invoice_id\": \"3c2b1a09-8f7e-6d5c-4b3a-291807060504\",\n \"amount\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dash.dmly.io/api/v1/gift-cards/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"GIFT-A1B2C3D4\",\n \"invoice_id\": \"3c2b1a09-8f7e-6d5c-4b3a-291807060504\",\n \"amount\": 25\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>"
}Was this page helpful?
⌘I

