Create or fund a gift card

curl --request POST \
  --url https://api.vori.com/v1/gift-cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "199.99",
  "idempotency_key": "<string>",
  "account_number": "<string>",
  "description": "<string>",
  "employee_id": "<string>",
  "order_id": "<string>",
  "physical_barcode": "<string>",
  "purchaser_phone_number": "<string>",
  "recipient_phone_number": "<string>",
  "store_id": "<string>"
}
'

import requests

url = "https://api.vori.com/v1/gift-cards"

payload = {
    "amount": "199.99",
    "idempotency_key": "<string>",
    "account_number": "<string>",
    "description": "<string>",
    "employee_id": "<string>",
    "order_id": "<string>",
    "physical_barcode": "<string>",
    "purchaser_phone_number": "<string>",
    "recipient_phone_number": "<string>",
    "store_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '199.99',
    idempotency_key: '<string>',
    account_number: '<string>',
    description: '<string>',
    employee_id: '<string>',
    order_id: '<string>',
    physical_barcode: '<string>',
    purchaser_phone_number: '<string>',
    recipient_phone_number: '<string>',
    store_id: '<string>'
  })
};

fetch('https://api.vori.com/v1/gift-cards', 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.vori.com/v1/gift-cards",
  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([
    'amount' => '199.99',
    'idempotency_key' => '<string>',
    'account_number' => '<string>',
    'description' => '<string>',
    'employee_id' => '<string>',
    'order_id' => '<string>',
    'physical_barcode' => '<string>',
    'purchaser_phone_number' => '<string>',
    'recipient_phone_number' => '<string>',
    'store_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.vori.com/v1/gift-cards"

	payload := strings.NewReader("{\n  \"amount\": \"199.99\",\n  \"idempotency_key\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"description\": \"<string>\",\n  \"employee_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"physical_barcode\": \"<string>\",\n  \"purchaser_phone_number\": \"<string>\",\n  \"recipient_phone_number\": \"<string>\",\n  \"store_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.vori.com/v1/gift-cards")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"199.99\",\n  \"idempotency_key\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"description\": \"<string>\",\n  \"employee_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"physical_barcode\": \"<string>\",\n  \"purchaser_phone_number\": \"<string>\",\n  \"recipient_phone_number\": \"<string>\",\n  \"store_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vori.com/v1/gift-cards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"199.99\",\n  \"idempotency_key\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"description\": \"<string>\",\n  \"employee_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"physical_barcode\": \"<string>\",\n  \"purchaser_phone_number\": \"<string>\",\n  \"recipient_phone_number\": \"<string>\",\n  \"store_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "balance": "199.99",
  "barcodes": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "deactivated_at": "2023-11-07T05:31:56Z",
  "deactivated_by_api_client_id": "<string>",
  "deactivated_by_employee_id": "<string>",
  "deactivated_by_user_id": "<string>",
  "deactivation_reason": "<string>",
  "last_order_at": "2023-11-07T05:31:56Z",
  "magstripe_account_numbers": [
    "<string>"
  ],
  "owner_id": "<string>",
  "printed_account_numbers": [
    "<string>"
  ],
  "purchaser_id": "<string>",
  "shopper_facing_id": "<string>",
  "status": "active",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error_code": "invalid_employee"
}

{
  "error_code": "insufficient_permissions",
  "error_details": {
    "action": "*",
    "resource": "*"
  }
}

POST

gift-cards

Create or fund a gift card

curl --request POST \
  --url https://api.vori.com/v1/gift-cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "199.99",
  "idempotency_key": "<string>",
  "account_number": "<string>",
  "description": "<string>",
  "employee_id": "<string>",
  "order_id": "<string>",
  "physical_barcode": "<string>",
  "purchaser_phone_number": "<string>",
  "recipient_phone_number": "<string>",
  "store_id": "<string>"
}
'

import requests

url = "https://api.vori.com/v1/gift-cards"

payload = {
    "amount": "199.99",
    "idempotency_key": "<string>",
    "account_number": "<string>",
    "description": "<string>",
    "employee_id": "<string>",
    "order_id": "<string>",
    "physical_barcode": "<string>",
    "purchaser_phone_number": "<string>",
    "recipient_phone_number": "<string>",
    "store_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '199.99',
    idempotency_key: '<string>',
    account_number: '<string>',
    description: '<string>',
    employee_id: '<string>',
    order_id: '<string>',
    physical_barcode: '<string>',
    purchaser_phone_number: '<string>',
    recipient_phone_number: '<string>',
    store_id: '<string>'
  })
};

fetch('https://api.vori.com/v1/gift-cards', 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.vori.com/v1/gift-cards",
  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([
    'amount' => '199.99',
    'idempotency_key' => '<string>',
    'account_number' => '<string>',
    'description' => '<string>',
    'employee_id' => '<string>',
    'order_id' => '<string>',
    'physical_barcode' => '<string>',
    'purchaser_phone_number' => '<string>',
    'recipient_phone_number' => '<string>',
    'store_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.vori.com/v1/gift-cards"

	payload := strings.NewReader("{\n  \"amount\": \"199.99\",\n  \"idempotency_key\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"description\": \"<string>\",\n  \"employee_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"physical_barcode\": \"<string>\",\n  \"purchaser_phone_number\": \"<string>\",\n  \"recipient_phone_number\": \"<string>\",\n  \"store_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.vori.com/v1/gift-cards")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"199.99\",\n  \"idempotency_key\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"description\": \"<string>\",\n  \"employee_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"physical_barcode\": \"<string>\",\n  \"purchaser_phone_number\": \"<string>\",\n  \"recipient_phone_number\": \"<string>\",\n  \"store_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vori.com/v1/gift-cards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"199.99\",\n  \"idempotency_key\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"description\": \"<string>\",\n  \"employee_id\": \"<string>\",\n  \"order_id\": \"<string>\",\n  \"physical_barcode\": \"<string>\",\n  \"purchaser_phone_number\": \"<string>\",\n  \"recipient_phone_number\": \"<string>\",\n  \"store_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "balance": "199.99",
  "barcodes": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "deactivated_at": "2023-11-07T05:31:56Z",
  "deactivated_by_api_client_id": "<string>",
  "deactivated_by_employee_id": "<string>",
  "deactivated_by_user_id": "<string>",
  "deactivation_reason": "<string>",
  "last_order_at": "2023-11-07T05:31:56Z",
  "magstripe_account_numbers": [
    "<string>"
  ],
  "owner_id": "<string>",
  "printed_account_numbers": [
    "<string>"
  ],
  "purchaser_id": "<string>",
  "shopper_facing_id": "<string>",
  "status": "active",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error_code": "invalid_employee"
}

{
  "error_code": "insufficient_permissions",
  "error_details": {
    "action": "*",
    "resource": "*"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

amount

string<positive-monetary>

required

Amount to load onto the gift card.

Pattern: ^[0-9]+(\.[0-9]+)?$

Example:

"199.99"

idempotency_key

string

required

Idempotency key to avoid duplicate transactions. Only one transaction may exist with a given idempotency key. Subsequent requests with the same idempotency key will return the data persisted in the database.

account_number

string | null

The account number, typically read from the physical card's magnetic stripe. Note that this should just be the account number, not any additional Track data.

description

string

Description to write alongside the funding transaction

employee_id

string

ID of the employee responsible. Only a register sends one, and it is required there; a back-office session records the signed-in user, and an API credential records itself.

order_id

string

ID of the checkout that funded the gift card, from the transactions resource. Only a register sends one.

physical_barcode

string | null

Barcode on the physical gift card. Provide this, recipient_phone_number, or account_number.

purchaser_phone_number

string<phone>

Phone number of the Shopper that funded the gift card. This may be the same as recipient_phone_number if a shopper buys a gift card for themselves.

Pattern: ^\+[1-9]\d{1,14}$

recipient_phone_number

string<phone> | null

Phone number of the shopper who will own this gift card. This shopper receives messages about this and future transactions. Provide this, physical_barcode, or account_number.

Pattern: ^\+[1-9]\d{1,14}$

store_id

string

ID of the store the funding belongs to. Optional: name a store to attribute it to, or omit it for funding not tied to a store.

Pattern: ^[0-9]+$

Response

Gift card funded successfully.

A prepaid balance a shopper spends at the register. It can be digital, tied to a shopper, or backed by one or more physical cards. A gift card belongs to the banner rather than to any one store, and can be sold, redeemed, or reloaded at any of its registers.

string

required

Unique identifier for the record.

balance

string<monetary>

required

Current balance on the gift card.

Pattern: ^-?[0-9]+(\.[0-9]+)?$

Example:

"199.99"

barcodes

string[]

required

Barcodes on the physical cards backing this gift card, across the card and any cards merged into it.

created_at

string<date-time>

required

When the record was created.

deactivated_at

string<date-time> | null

required

When the gift card was deactivated, or null when it is active.

deactivated_by_api_client_id

string | null

required

ID of the API credential that deactivated the gift card, or null when it is active or was deactivated by a person.

deactivated_by_employee_id

string | null

required

ID of the employee who deactivated the gift card, or null when it is active or was deactivated by another actor.

deactivated_by_user_id

string | null

required

ID of the back-office user who deactivated the gift card, or null when it is active or was deactivated by another actor.

deactivation_reason

string | null

required

Reason recorded when the gift card was deactivated, or null when it is active.

last_order_at

string<date-time> | null

required

When the gift card was last used in a sale or refund, or null when it has not been used yet.

magstripe_account_numbers

string[]

required

Account numbers encoded on the magnetic stripe of the physical cards.

owner_id

string | null

required

ID of the shopper who owns the gift card, or null when it has no owner.

printed_account_numbers

string[]

required

Account numbers printed on the physical cards.

purchaser_id

string | null

required

ID of the shopper who purchased the gift card, or null when unknown.

shopper_facing_id

string

required

Short human-readable ID for the gift card, shown to shoppers on receipts and messages.

status

enum<string>

required

Whether the gift card is active and can be used, or has been deactivated.

Available options:

active,

deactivated

updated_at

string<date-time>

required

When the record was last changed.