# Download giftcard payments as JSON

**GET** `https://api.zoined.com/v2/download/giftcardPayments.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31`

Endpoint: GET /v2/download/giftcardPayments.json
Security: bearerAuth

## Security:

  - `bearerAuth` (unknown)
    http bearer token

## Query parameters:

  - `limit` (number)
    How many entries to return

  - `offset` (number)
    Which offset to return data from

  - `start` (string)
    Return data starting from given date

  - `end` (string)
    Return data ending to given date

## Response 200:

  - `200` (unknown)
    Request has been processed successfully.
**Headers**
- `Content-Type: application/json`

## Response 200 fields (application/json):

  - `giftcard_id` (string, required)
    Unique ID for the gift card.
    Example: A67gigMp

  - `giftcard_number` (string, required)
    Gift card number
    Example: 7TON39

  - `giftcard_status` (string, required)
    Gift card status
    Example: Active

  - `giftcard_balance` (number)
    Gift card balance
    Example: 50

  - `creation_date` (string, required)
    Gift card creation date (yyyy-mm-dd)
    Example: 2016-01-01

  - `creation_time` (string)
    Gift card creation time (HH:mm:ss)
    Example: 15:00:00

  - `expiration_date` (string)
    Gift card expiration date (yyyy-mm-dd)
    Example: 2017-01-01

  - `expiration_time` (string)
    Gift card expiration time (HH:mm:ss)
    Example: 15:00:00

  - `sales_id` (string)
    Sales Id
    Example: dbeba367

  - `organisation_id` (string, required)
    Organisation/Store ID
    Example: 540

  - `department_id` (string)
    Store department ID
    Example: 5401

  - `register_id` (string)
    Cash register ID
    Example: 32

  - `salesperson_id` (string)
    Sales person ID
    Example: 5402101

  - `customer_id` (string)
    Customer ID for identified customer
    Example: 32

  - `payment_id` (string, required)
    Payment method ID
    Example: A65A

  - `payment_type` (string, required)
    Payment type
    Example: Activation

  - `payment_date` (string, required)
    Payment date (yyyy-mm-dd)
    Example: 2016-05-15

  - `payment_time` (string, required)
    Payment time (HH:mm:ss)
    Example: 15:00:00

  - `payment_value` (number, required)
    Payment amount
    Example: 20

  - `payment_currency` (string)
    Currency as ISO 4217 currency code. Required if multiple currencies are used.
    Example: EUR

  - `custom_field_1` (string)
    Field that can be used for custom dimensions
    Example: XYZ

  - `custom_field_2` (string)
    Field that can be used for custom dimensions
    Example: XYZ

  - `custom_field_3` (string)
    Field that can be used for custom dimensions
    Example: XYZ

  - `custom_field_4` (string)
    Field that can be used for custom dimensions
    Example: XYZ

  - `custom_field_5` (string)
    Field that can be used for custom dimensions
    Example: XYZ

  - `custom_metric_1` (number)
    Custom metric 1
    Example: 1

  - `custom_metric_2` (number)
    Custom metric 2
    Example: 100

  - `custom_metric_3` (number)
    Custom metric 3
    Example: 2.2

  - `custom_metric_4` (number)
    Custom metric 4
    Example: 1.05

  - `custom_metric_5` (number)
    Custom metric 5
    Example: 10000

## Response 400:

  - `400` (unknown)
    Invalid or malformed request.
**Headers**
- `Content-Type: application/json`

## Response 400 fields (application/json):

  - `status` (string, required)
    Status of the operation OK / Not OK
    Example: Not OK

  - `msg` (string, required)
    Message describing result of operation
    Example: Reason for error

## Response 401:

  - `401` (unknown)
    Missing or invalid authorization token in header
**Headers**
- `Content-Type: application/json`

## Response 401 fields (application/json):

  - `status` (string, required)
    Status of the operation OK / Not OK
    Example: Not OK

  - `msg` (string, required)
    Message describing result of operation
    Example: Unauthorized

## Response 500:

  - `500` (unknown)
    Internal error or exception
**Headers**
- `Content-Type: application/json`

## Response 500 fields (application/json):

  - `status` (string, required)
    Status of the operation OK / Not OK
    Example: Not OK

  - `msg` (string, required)
    Message describing result of operation
    Example: Reason for error

## Response 200 examples:

  - `response` (unknown)

## Response 400 examples:

  - `response` (unknown)

## Response 401 examples:

  - `response` (unknown)

## Response 500 examples:

  - `response` (unknown)