# Giftcard

**POST /giftcard**

The Giftcard POST request can be made to create or register a new giftcard to the client.
Cards can be created of various types and note some of the optional values that can be included to set an expiry date, intitial balance and to lock the card to a specific site.

Where a card is to be used across several sites / locations, please omit the siteId from the request. 

If the unique idenitifier for the card is known then this value can be included in the request. If not then this API will return a card identifier for the newly created card.


## Servers



## Parameters
### Headers
- **Authorization** (string)
  Bearer accessToken



### Body:  (object)

- **expiry** (string)
  Expiry Date for the card in format YYYY-MM-DD
- **cardType** (integer)
  1 = Barcode, 2 = QR
- **currencyCode** (integer)
  ISO Numeric e.g. 826, 840, 978
- **identifier** (string)
  Unique identfier for the card. Max length 256 characters
- **initialBalance** (number)

- **siteId** (string)
  ID of a site to lock this card to. Not reccomended but if used the siteId can be obtained from /sites/


## Responses
### 200


#### Body:  (object)
- **message** (string)

- **records_updated** (integer)

- **timestamp** (integer)

- **data** (object)


### 400
A Bad request could be returned for a variety of reasons e.g. not including required fields in the request body or including an invalid value for any of these fields.

The body of the response will be a json object containing a message which can be used to help identify what caused the 400 response.

#### Body:  (object)
- **message** (string)

- **timestamp** (integer)



[Powered by Bump.sh](https://bump.sh)