gift_cards

Get one gift card by its id or its code (in any case, spaced or not), with every change to what's on it: purchase or issue, redeems, refunds and adjusts

get/gift_cards/{id}

Request

  • Base URL: https://daybag.io/api/v1
  • URL: https://daybag.io/api/v1/gift_cards/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The card's id, or its code

Response

Success

idstring required
org_idstring required
codestring required

12 characters of Crockford base32, as made: guests give it as they book (bookings.create's gift_card_code), in any case, spaced or not

amount_centsinteger required

What it was worth when made, in the currency's minor units (cents; whole yen for zero-decimal currencies)

currencystring required

ISO 4217, lowercase: the org's when it was made

for_namestring required

Who it's for, as given; may be empty

for_emailstring required

Who it's for: emailed the code when it was made

from_namestring required

Who it's from: the buyer, or your business for one you issued

from_emailstring required
messagestring required

The buyer's message to who it's for, up to 300 characters; may be empty

issued_by'purchase' | 'business' nullable required

purchase: bought on your booking page; business: issued by you (gift_cards_issue)

checkout_session_idstring nullable required

A bought card's Stripe Checkout, on your account

payment_intent_idstring nullable required

A bought card's Stripe payment, on your account

created_atstring required

ISO 8601 timestamp (UTC)

balanceinteger required

What's on it: the sum of its entries, in the currency's minor units (cents; whole yen for zero-decimal currencies). Gift cards never expire

availableinteger required

What it can spend now: the balance less the parts of live holds that take it once they're confirmed, in the currency's minor units (cents; whole yen for zero-decimal currencies)

Changes

No recorded changes to this operation across all 1 revision of this API.