Gift Card Redemptions

Operations related to gift card redemptions.

List Gift Card Redemptions

get

Retrieves the redemption history for a specific gift card.

Authorizations

basicAuth

AuthorizationstringRequired

Basic Authentication requires a Base64 encoded string of your <Merchant_Id>:<Api_Key>.

Path parameters

gift_card_idstringRequired

The unique identifier of the gift card.

Example: gift-148061212058405918eee94

Responses

200

A successful response with the gift card's redemption history.

application/json

401

Unauthorized. The request lacks valid authentication credentials.

404

Not Found. A gift card with the specified ID does not exist.

get

/gift-cards/{gift_card_id}/redemptions

HTTPcURLJavaScriptPython

GET /gift-cards/{gift_card_id}/redemptions HTTP/1.1
Host: api.vauchar.com
Authorization: Basic username:password
Accept: */*

{
  "href": "https://example.com",
  "data": [
    {
      "href": "https://example.com",
      "type": "redemption",
      "id": "text",
      "gift_card_id": "text",
      "user_id": "text",
      "user_email": "[e-mail]",
      "user_phone": "text",
      "transaction_id": "text",
      "value_used": "text",
      "created": 1
    }
  ]
}

Create a Gift Card Redemption

post

Redeems a specific gift card by its ID.

Authorizations

basicAuth

AuthorizationstringRequired

Basic Authentication requires a Base64 encoded string of your <Merchant_Id>:<Api_Key>.

Path parameters

gift_card_idstringRequired

The unique identifier of the gift card to redeem.

Example: gift-148061360458405ee43a1a8

Body

application/json

user_idstringOptional

user_emailstring · emailOptional

user_phonestringOptional

value_usednumberRequired

The amount of value to be used from the gift card.

Responses

201

Redemption created successfully.

application/json

400

Bad Request. The request body is invalid or the gift card cannot be redeemed.

401

Unauthorized. The request lacks valid authentication credentials.

404

Not Found. A gift card with the specified ID does not exist.

post

/gift-cards/{gift_card_id}/redemptions

HTTPcURLJavaScriptPython

POST /gift-cards/{gift_card_id}/redemptions HTTP/1.1
Host: api.vauchar.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "user_id": "user001",
  "user_email": "[e-mail]",
  "user_phone": "91100911100",
  "value_used": 50
}

{
  "href": "https://example.com",
  "type": "redemption",
  "id": "text",
  "gift_card_id": "text",
  "user_id": "text",
  "user_email": "[e-mail]",
  "user_phone": "text",
  "transaction_id": "text",
  "value_used": "text",
  "created": 1
}

Retrieve a specific Redemption

get

Retrieves the details of a single gift card redemption.

Authorizations

basicAuth

AuthorizationstringRequired

Basic Authentication requires a Base64 encoded string of your <Merchant_Id>:<Api_Key>.

Path parameters

gift_card_idstringRequired

The unique identifier of the gift card.

Example: gift-148061360458405ee43a1a8

redemption_idstringRequired

The unique identifier of the redemption.

Example: res-148061693358406be5cbe66

Responses

200

A successful response with the redemption details.

application/json

401

Unauthorized. The request lacks valid authentication credentials.

404

Not Found. A redemption with the specified ID does not exist.

get

/gift-cards/{gift_card_id}/redemptions/{redemption_id}

HTTPcURLJavaScriptPython

GET /gift-cards/{gift_card_id}/redemptions/{redemption_id} HTTP/1.1
Host: api.vauchar.com
Authorization: Basic username:password
Accept: */*

{
  "href": "https://example.com",
  "data": {
    "href": "https://example.com",
    "type": "redemption",
    "id": "text",
    "gift_card_id": "text",
    "user_id": "text",
    "user_email": "[e-mail]",
    "user_phone": "text",
    "transaction_id": "text",
    "value_used": "text",
    "created": 1
  }
}

Delete a Redemption

delete

Permanently deletes a specific gift card redemption.

Authorizations

basicAuth

AuthorizationstringRequired

Basic Authentication requires a Base64 encoded string of your <Merchant_Id>:<Api_Key>.

Path parameters

gift_card_idstringRequired

The unique identifier of the gift card.

Example: gift-148061360458405ee43a1a8

redemption_idstringRequired

The unique identifier of the redemption to delete.

Example: res-148061693358406be5cbe66

Responses

204

No Content. The redemption was successfully deleted.

401

Unauthorized. The request lacks valid authentication credentials.

404

Not Found. The specified redemption does not exist.

delete

/gift-cards/{gift_card_id}/redemptions/{redemption_id}

HTTPcURLJavaScriptPython

DELETE /gift-cards/{gift_card_id}/redemptions/{redemption_id} HTTP/1.1
Host: api.vauchar.com
Authorization: Basic username:password
Accept: */*

No content