PoshVine API reference

The PoshVine API is organized around REST. Our API has predictable resource- oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The APIs enable you to seamlessly connect to Poshvine's treasure of offers, gift cards, memberships and a lot more!

You can use Poshvine APIs in sandbox and production environments.

Base URI's

Please use the following base URI's. The URI you use will determine the environment. For all testing purposes please use the staging URI. All the requests made to the production URI will affect production data and all the bookings made will be considered as actual user bookings.

For Staging:-

For Production:-

Authentication

PoshVine APIs use API key to authenticate requests. You can generate your API key from the dashboard under settings.
In addition to API key, we also whitelist the IP's from where the APIs calls will be triggered.

Note:-Please contact PoshVine Team for whitelisting your production IP's.

In headers pass the credentials with the following keys along with each request:-

Key	Value
X-API-Client-Token	[YOUR_API_KEY]

Example:-

  curl -X GET 'https://sandbox-api.poshvine.com/cs/external/[ENDPOINT]' \
  -H 'X-API-Client-Token: test_client'

User Module

User module Apis helps to create, update and fetch user data. User ID is required for all the redemption API calls.Redemption options are linked to with users, hence user creation is mandatory part of the integration.

Create User

API to create user

POST /cs/external/users

Sample Request




curl --location --request POST 'https://sandbox-api.poshvine.com/cs/external/users/' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "abc cba",
"mobile": "000000000",
"salutation": "Mr",
"email": "abc@acb.com",
"customer_id": "AB1"
}'

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
name	String	Name of the user	Yes	query parameter
mobile	String	mobile no. of user (10 digits )	No	query parameters
email	String	user email id	yes	query parameter
customer_id	String	Unique identifier of user (this value will be used in X-External-Id parameter in all the APIs where user id is required)	No	query parameter
card_name	String	name of the card issued to user	Yes	query parameter
card_id	String	unique identifier for the card this value will used in X-External-Card-Id parameter in all the APIs where user card is required	Yes	query parameter
bin	String	BIN no of user card, can be first 8 or first 4 last 4 digit of the card	Yes	query parameter
segment	String	Segment if user card	Yes	query parameter
credit_limit	String	Credit limit of user card	Yes	query parameter
cash_limit	String	Cash limit of user card	Yes	query parameter

Note:- Please contact PoshVine Team for more details on parameters.

Sample Response




{
"success": true
}

Update User

This API is used to update the user details.

PUT /cs/external/users

Sample Request




curl --location --request PUT 'https://sandbox-api.poshvine.com/cs/external/users' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-External-Id: [USER EXTERNAL ID]' \
--header 'Content-Type: application/json' \
--data-raw '{"name": "user name"}'

Request Attributes

Attribute	Datatype	Description
X-API-Client-Token	String	client API key shared by PoshVine Team
X-External-Id	String	user external id shared in response of create user api (attribute: external_id)
name	String	name of the user
salutation	String	title of the user
email	String	user email id
mobile	String	user mobile no.

Sample Response




{
    "data": {
        "id": "ffbb9f15-019c-4098-a2c0-9170afa82154",
        "type": "user",
        "attributes": {
            "email": "abc@abc.com
            ",
            "salutation": null,
            "client_segment_id": null,
            "client_tier_id": null,
            "account_id": null,
            "external_id": "12ID",
            "name": "abc abc",
            "mobile": "910000000000",
            "client_tier": null
        }
    }
}

Fetch User

This API is used to fetch user details.

GET /cs/external/users

Sample Request




curl --location --request GET 'https://sandbox-api.poshvine.com/cs/external/users' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-External-Id: [USER EXTERNAL ID]' \
--data-raw ''

Request Attributes

Attribute	Datatype	Description
X-API-Client-Token	String	client API key shared by PoshVine Team
X-External-Id	String	user external id shared in response of create user api (attribute: external_id)

Sample Response




{
    "data": {
        "id": "ffbb9f15-019c-4098-a2q0-9170afa82d54",
        "type": "user",
        "attributes": {
            "email": "abc@abc.com",
            "salutation": null,
            "client_segment_id": null,
            "client_tier_id": null,
            "account_id": null,
            "external_id": "12ID",
            "name": "abc abc",
            "mobile": "910000000000",
            "client_tier": null
        }
    }
}

Offer Management Suite

These APIs allow you to integrate with PoshVine Offers Management Suite. Below is the list of commonly used APIs -

Get list of all offers
Get details of an offer
Get list of all Gift Cards
Get list of all Memberships
Offer Redemption
Gift Card Redemption
Membership Redemption
Redemption History

List Offers

This API is used to fetch list of all offers

GET /ps/external/offers

Sample Request




curl --location --request GET 'https://sandbox-api.poshvine.com/ps/external/offers' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-Project-ID: [PROJECT ID]'

Note:- Please contact PoshVine Team for your staging and production project_id.

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-Project-ID	String	ID of the project for which offers to be displayed.	Yes	header
X-External-Id	String	user external id shared in response of create user api(attribute: external_id) to be passed as header parameter. If passed response will return additional parameter claimable	Yes	header
title	String	Title of the offer	Yes	query parameter
merchant_name	String	search for offers with merchant name	Yes	query parameter
start_date__gte	String (format: dd/mm/yyyy)	offer start date >= start_date__gte	Yes	query parameter
start_date__lte	String (format: dd/mm/yyyy)	offer start date <= start_date__lte	Yes	query parameter
end_date__gte	String (format: dd/mm/yyyy)	offer end date >= end_date__gte	Yes	query parameter
end_date__lte	String (format: dd/mm/yyyy)	offer end date <= end_date__lte	Yes	query parameter
page	Numeric	page no to fetch offers (default value: 1)	Yes	query parameter
per_page	Numeric	per page count of offers(default value: 30)	Yes	query parameter

Sample Response




{
  "offers_count": 2,
  "data": [{
      "id": "1d4e6d9a-3440-4de4-9682-c1bfea277568",
      "type": "offer",
      "attributes": {
        "id": "1d4e6d9a-3440-4de4-9682-c1bfea277568",
        "title": "10% discount on the rates published on website/Food/Beverages & Spa.",
        "terms": "<ul>\r\n\t<li>10% discount on the rates published on our Brand Website.</li>\r\n\t<li>10% discount on Food & Beverages.</li>\r\n\t<li>10% discount on Spa</li>\r\n\t<li>Blackout dates will be applicable.</li>\r\n\t<li>Rooms are subject to hotel availability.</li>\r\n\t<li>Non-Cancelable; Non-Amendable.</li>\r\n</ul>\r\n",
        "description": "<p>10% discount on the rates published on website/Food/Beverages & Spa.</p>",
        "start_date": "2021-07-02",
        "offer_type": "no_voucher",
        "redemption_url": "https://khyberhotels.com/",
        "redemption_steps": null,
        "image_url": "<image url>",
        "offer_end_date": "2022-03-31",
        "merchant": {
          "name": "MamaEarth",
          "logo_url": null
        },
        "categories": {
          "data": [{
            "id": "0ecb9cde-d2d0-41cc-9e5c-298fd93316cf",
            "type": "category",
            "attributes": {
              "name": "Health & Wellness",
              "code": "health-wellness",
              "logo_url": "<logo_url>"
            }
          }]
        },
        "computed_offer_value": null
      }
    },
    {
      "id": "295d0fe6-ad2c-45e4-9117-6529f48c9384",
      "type": "offer",
      "attributes": {
        "id": "295d0fe6-ad2c-45e4-9117-6529f48c9384",
        "title": "20% off at Yash Hotel",
        "terms": "<p><strong>How to redeem:</strong></p>\r\n\r\n<ul>\r\n\t<li>Please ask for the offer before the bill is generated</li>\r\n\t<li><span style=\"font-size:small\"><span style=\"color:#222222\"><span style=\"font-family:Arial, Helvetica, sans-serif\"><span style=\"font-style:normal\"><span style=\"font-variant-ligatures:normal\">",
        "description": "<p>Get 20% off on total bill</p>\r\n\r\n<p><strong>How to redeem:</strong></p>\r\n\r\n<ul>\r\n\t<li>Please ask for the offer before the bill is generated</li>\r\n\t<li>For any queries / escalation related to Yash Hotel, please contact Yash Fagna on 8094444471</li>\r\n</ul>\r\n",
        "start_date": "2020-03-11",
        "offer_type": "no_voucher",
        "redemption_url": "http://null.com",
        "redemption_steps": null,
        "image_url": "<image_url>",
        "offer_end_date": "2021-12-31",
        "merchant": {
          "name": "Yash Hotel",
          "logo_url": "<logo_url>"
        },
        "categories": {
          "data": [{
              "id": "3374b4ad-7c1b-4e55-8176-45382e8f950e",
              "type": "category",
              "attributes": {
                "name": "Dining",
                "code": "dining",
                "logo_url": "<logo_url>"
              }
            },
            {
              "id": "8ce47d44-3ff1-44ae-b122-1c171399ee9e",
              "type": "category",
              "attributes": {
                "name": "Dining Out",
                "code": "dining-out",
                "logo_url": null
              }
            }
          ]
        },
        "computed_offer_value": null
      }
    }
  ]
}

Response Attributes

Attribute	Datatype	Description
id	String	Offer id
title	String	offer title
description	String	Offer description
start_date	String	Offer start date
offer_type	String	Type of offer values can be (no_voucher/generic_voucher/personalized_voucher)
redemption_url	String	URL to redeem the coupon code
redemption_steps	String	Steps to redeem offer
image_url	String	Offer Image URL
offer_end_date	String	Offer end date
merchant	String	Merchant details of offer
categories	String	Categories associated with offer
offer_value	String
claimable	String	Offer eligibility for user (passed only if X-External-Id is passed in request header parameters)

List Offer

This API is used to fetch details of offer

GET /ps/external/offers/[OFFER ID]

Sample Request




curl --location --request GET 'https://sandbox-api.poshvine.com/ps/external/offers/1d4e6d9a-3440-4de4-9682-c1bfea277568'
\
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-Project-ID: [PROJECT ID]'

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-Project-ID	String	ID of the project for which offer to be displayed.	Yes	header
X-External-Id	String	user external id shared in response of create user api(attribute: external_id) to be passed as header parameter. If passed response will return additional parameter claimable	Yes	header

Sample Response




{
  "id": "1d4e6d9a-3440-4de4-9682-c1bfea277568",
  "type": "offer",
  "attributes": {
    "id": "1d4e6d9a-3440-4de4-9682-c1bfea277568",
    "title": "10% discount on the rates published on website/Food/Beverages & Spa.",
    "terms": "t&c",
    "start_date": "2021-07-02",
    "offer_type": "generic_voucher",
    "redemption_url": "https://khyberhotels.com/",
    "redemption_steps": null,
    "image_url": "image_url",
    "offer_end_date": "2022-03-31",
    "merchant": {
        "name": "MamaEarth",
        "logo_url": null
    },
    "categories": {
        "data": [
            {
                "id": "0ecb9cde-d2d0-41cc-9e5c-298fd93316cf",
                "type": "category",
                "attributes": {
                    "name": "Health & Wellness",
                    "code": "health-wellness",
                    "logo_url": "logo_url"
                }
            }
        ]
    },
    "computed_offer_value": null
  }
}

Response Attributes

Attribute	Datatype	Description
id	String	Offer id
title	String	offer title
description	String	Offer description
start_date	String	Offer start date
offer_type	String	Type of offer values can be (no_voucher/generic_voucher/personalized_voucher)
redemption_url	String	URL to redeem the coupon code
redemption_steps	String	Steps to redeem offer
image_url	String	Offer Image URL
offer_end_date	String	Offer end date
merchant	String	Merchant details of offer
categories	String	Categories associated with offer
offer_value	String
claimable	String	Offer eligibility for user (passed only if X-External-Id is passed in request header parameters)

Redeem Offer

API used to make redemption offer redemption

POST /ps/external/redemptions

Sample Request




curl --location --request POST 'https://sandbox-api.poshvine.com/ps/external/redemptions' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'Origin: [ORIGIN]' \
--header 'X-Project-ID: [PROJECT ID]' \
--header 'X-External-Id: [USER EXTERNAL ID]' \
--header 'Content-Type: application/json' \
--data-raw '{
"benefit_id" : "[OFFER ID]",
"benefit_type" : "offer"
}'

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-External-Id	String	user external id shared in response of create user api(attribute: external_id) to be passed as header parameter.	No	header
X-Project-ID	String	Project ID of the offer	No	header
Origin	String	whitelisted origin	No	header
benefit_id	String	ID of the order to be redeemed	No	query parameter
benefit_type	String	value: offer	No	query parameter

Sample Response




{
    "success": true,
    "redemption_id": "82716061-d7eb-4bda-881c-b4004c791234",
    "voucher": {
        "code": "test",
        "pin": "1234",
        "redemption_link": "https://www.testmerchant.com/redeem"
    }
}

Response Attributes

Attribute	Datatype	Description
redemption_id	String	ID of redemption
voucher	Object	has details of voucher code and pin

List Gift Cards

This API is used to fetch list of all gift cards

GET /ps/external/gift_cards

Sample Request




curl --location --request GET 'https://sandbox-api.poshvine.com/ps/external/gift_cards' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-Project-ID: [PROJECT ID]'

Note:- Please contact PoshVine Team for your staging and production project_id.

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-Project-ID	String	ID of the project for which gift cards to be displayed.	No	header

Sample Response




{
  "data": [
    {
      "id": "e1b710b1-435c-404f-87c4-bcd45efb4df1",
      "type": "gift_card",
      "attributes": {
        "id": "e1b710b1-435c-404f-87c4-bcd45efb4df1",
        "title": "Test",
        "price_type": "range",
        "popular": true,
        "active": true,
        "denominations": [],
        "start_date": "2021-06-07",
        "end_date": "2021-12-31",
        "redemption_type": [
            "online"
        ],
        "redemption_url": "",
        "image_url": "https://poshvine-dev-testing.s3.ap-south-1.amazonaws.com/kml4e6gciy2nncl5tc4jzx3a451v?response-content-disposition=inline%3B%20filename%3D%22Screenshot%20from%202021-01-17%2006-14-21.png%22%3B%20filename%2A%3DUTF-8%27%27Screenshot%2520from%25202021-01-17%252006-14-21.png&response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA5DSJ7WXBBOBFZVCG%2F20211017%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20211017T172553Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=0f69c61614b72e40aff2294cf2ea0f9d91d2ae1c80eaf160564da97ad0033d07",
        "eligible_denominations": [],
        "eligible_denomination_range": [
            2344,
            6281
        ]
      }
    }
  ],
  "total_count": 1
}

Response Attributes

Attribute	Datatype	Description
id	String	Gift Card id
title	String	Name of gift card
price_type	String	type of gift card denominations, can have two values(range/slab)
active	boolean	Boolean parameter to show if gift card is available to purchase or not
start_date	String	Gift Card sale start date
end_date	String	Gift Card sale end date
redemption_type	String	type of redemption of gift card (online/offline)
redemption_url	String	Website link where gift card can be used
image_url	String	Image to be displayed
eligible_denominations	String	denomination available to buy
eligible_denomination_range	String	range of denomination available to purchase

Redeem Gift Card

Redeem one of more denominations of a gift card

POST /ps/external/redemptions

Sample Request




curl --location --request POST 'https://sandbox-api.poshvine.com/ps/external/redemptions' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-Project-ID: [PROJECT ID]' \
--header 'X-External-Id: [USER EXTERNAL ID]' \
--header 'X-External-Card-Id: [CARD EXTERNAL ID]' \
--header 'X-Request-ID: [UNIQUE REQUEST ID]' \
--header 'Content-Type: application/json' \
--data-raw '{
"benefit_id" : "[GIFT CARD ID]",
"benefit_type" : "gift_card",
"denomination_quantity": { "500": 2, "1000": 3 }
}'

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-External-Id	String	user external id shared in response of create user api(attribute: external_id) to be passed as header parameter.	No	header
X-External-Card-Id	String	card external id shared in response of create user api(attribute: card_id) to be passed as header parameter.	No	header
X-Project-ID	String	Project ID of the offer	No	header
X-Request-ID	String	Unique Request ID for retry and recon. Optional otherwise	No	header
benefit_id	String	ID of the gift card to be redeemed	No	query parameter / body
benefit_type	String	value: gift_card	No	query parameter / body
denomination_quantity	Hash	Key pair value of denomination and quantity. Quantity cannot be more than 4 and not more than 5 denominations per redeem call	No	query parameter / body

Sample Response




{
    "id": "b7364935-90b6-4b5f-b582-87919f1cde71",
    "type": "gift_card_booking",
    "attributes": {
        "id": "b7364935-90b6-4b5f-b582-87919f1cde71",
        "external_request_id": "request002",
        "status": "success",
        "created_at": "2023-06-30T11:32:27Z",
        "gift_card_orders": [
            {
                "id": "3780f9fb-1cbe-44e9-a97c-6bfc208524be",
                "type": "gift_card_order",
                "attributes": {
                    "id": "3780f9fb-1cbe-44e9-a97c-6bfc208524be",
                    "gift_card_id": "0b8d1eac-3f58-4459-aead-45a721475b88",
                    "denomination": "500.0",
                    "quantity": 1,
                    "status": "complete",
                    "order_no": "PSHVN1220521738",
                    "created_at": "2023-06-30T11:32:28Z",
                    "updated_at": "2023-06-30T11:32:30Z",
                    "redemption_link": "",
                    "vouchers": [
                        {
                            "card_number": "100xxxxxxxxxxxxx87",
                            "pin": "xxxxxxx",
                            "denomination": 500,
                            "code": null,
                            "validity": "2024-06-28T18:30:00.000Z",
                            "activation_url": null
                        }
                    ]
                }
            }
        ]
    }
}

Redemption Status

Verify the status of the pending gift card order

GET /ps/external/redemptions/status

Sample Request




curl --location --request GET 'https://sandbox-api.poshvine.com/ps/external/redemptions/status?benefit_type=gift_card&order_id=7576acea-35e9-4cda-a349-be38dd874388' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-Project-ID: [PROJECT ID]' \
--header 'X-Request-ID: [ORIGINAL REQUEST ID]'

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-Request-ID	String	The original request ID passed during redeem API call	No	header
X-Project-ID	String	Project ID of the offer	Yes	header
benefit_type	String	value: gift_card	No	query parameter
order_id	String	Order ID returned in the redeem Gift Card API	No	query parameter

Sample Response




{
    "id": "7576acea-35e9-4cda-a349-be38dd874388",
    "gift_card_id": "19a9db1e-f6be-4193-8026-c23ff9688975",
    "denomination": "300.0",
    "quantity": 1,
    "status": "status",
    "order_no": "PSHVN329532525",
    "created_at": "2023-06-30T01:08:18Z",
    "updated_at": "2023-06-30T01:15:19Z",
    "redemption_link": "https://www.swiggy.com/swiggy-instamart",
    "vouchers": [
				{
						"card_number": "100xxxxxxxxxxxxxxx87",
						"pin": "xxxxxxx",
						"denomination": 500,
						"code": null,
						"validity": "2024-06-28T18:30:00.000Z",
						"activation_url": null
				}
		]
}

Response Attributes

Attribute	Datatype	Description
status	String	Current status of the gift card order
voucher	Object	has details of voucher code and pin

List Memberships

This API is used to fetch list of all memberships available

GET /ps/external/memberships

Sample Request




curl --location --request GET 'https://sandbox-api.poshvine.com/ps/external/memberships' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-Project-ID: [PROJECT ID]'

Note:- Please contact PoshVine Team for your staging and production project_id.

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-Project-ID	String	ID of the project for which gift cards to be displayed.	No	header

Sample Response




{
  "data": [
    {
      "id": "094ff050-56c0-4bb9-9cc2-56eb05cd425d",
      "type": "membership",
      "attributes": {
        "id": "094ff050-56c0-4bb9-9cc2-56eb05cd425d",
        "title": " Get a complimentary 6 month subscription",
        "description": "<p>Get a complimentary bbstar subscription for 6 months. Key benefits include: </p>\r\n\r\n<ul>\r\n\t<li>No Delivery Charge</li>\r\n\t<li>Cashback on Successful Delivery</li>\r\n\t<li>Reserved Delivery Slots</li>\r\n\t<li>Exclusive bbstar offers</li>\r\n</ul>\r\n\r\n<p><strong>How to redeem:</strong></p>\r\n\r\n<ul>\r\n\t<li>Click on the 'Claim Offer' button</li>\r\n\t<li>You will receive the coupon code via an SMS and an email to your HDFC Bank registered mobile number and e-mail ID.</li>\r\n\t<li>The cardholder will have to apply the coupon code after clicking ‘Join Now’ in the given space on bbstar page.</li>\r\n\t<li>BigBasket will activate the bbstar membership of the customer with 3 working days.</li>\r\n\t<li>The complimentary membership is applicable for non-members of bbstar. This will not be applicable for you if you are an already existing member.</li>\r\n</ul>\r\n",
        "terms": "<p><strong>Terms and conditions:</strong></p>\r\n\r\n<ul>\r\n\t<li>Code should be redeemed here for the m-site: <a href=\"http://www.bigbasket.com/bbstar/\">www.bigbasket.com/bbstar/</a></li>\r\n\t<li>On the app, please go to the bbstar Membership page and click ‘Join Now’ to apply voucher code in the given space</li>\r\n\t<li>Code cannot be used during checkout for any order</li>\r\n\t<li>Offer not valid for existing bbstar members</li>\r\n\t<li>This voucher cannot be used to extend the validity of existing bbstar membership</li>\r\n\t<li>This voucher can be redeemed only on bigbasket app and m-site. Not valid on website.</li>\r\n\t<li>Coupon code is valid for one time activation of bbstar membership of 6 months</li>\r\n\t<li>bigbasket has the right to cancel orders if found to be of a fraudulent nature</li>\r\n\t<li>bigbasket reserves the right to change / modify / add / delete any of the terms and conditions of the offer at any time without notice</li>\r\n\t<li>Offer valid in all cities where bigbasket has its presence</li>\r\n</ul>\r\n",
        "membership_url": "https://www.bigbasket.com/bbstar/",
        "start_date": "2021-05-31T00:00:00.000Z",
        "membership_type": "personalized_voucher",
        "redemption_steps": "",
        "original_price": 150.0,
        "end_date": "2021-12-31T00:00:00.000Z",
        "image_url": "https://poshvine-dev-testing.s3.ap-south-1.amazonaws.com/7ghtwly6c63yp3es8vxb8cxa213v?response-content-disposition=inline%3B%20filename%3D%224.jpg%22%3B%20filename%2A%3DUTF-8%27%274.jpg&response-content-type=image%2Fjpeg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA5DSJ7WXBBOBFZVCG%2F20211017%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20211017T173649Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=d6165b0c365b3589b5dcad8c9df7dd98d1ca0eb822c0b0af93bc3b5b62c26410",
        "live?": true,
        "offer_price": 100
      }
    }
  ]
}

Response Attributes

Attribute	Datatype	Description
id	String	Membership id
title	String	Name of Membership
description	String	Description text for membership
terms	string	Terms and conditions of membership
membership_url	String	Website URL to avail membership
start_date	String	Membership sale start date
end_date	String	Gift Card sale end date
redemption_steps	String	Steps to redeem membership
original_price	Float	Original price of membership
offer_price	Float	Offer price of membership
image_url	String	Image Url to display
membership_type	String	type of membership personalized_voucher - Personalized voucher will be issued on purchase no_voucher - no voucher is required
live	String	status of membership availability

Redeem Membership

API used to make membership redemption

POST /ps/external/redemptions

Sample Request




curl --location --request POST 'https://sandbox-api.poshvine.com/ps/external/redemptions' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'Origin: [ORIGIN]' \
--header 'X-Project-ID: [PROJECT ID]' \
--header 'X-External-Id: [USER EXTERNAL ID]' \
--header 'X-External-Card-Id: [CARD EXTERNAL ID]' \
--header 'Content-Type: application/json' \
--data-raw '{
"benefit_id" : "[MEMBERSHIP ID]",
"benefit_type" : "membership"
}'

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-External-Id	String	user external id shared in response of create user api(attribute: external_id) to be passed as header parameter.	No	header
X-Project-ID	String	Project ID of the membership	No	header
X-External-Card-Id	String	card external id shared in response of create user api(attribute: card_id) to be passed as header parameter.	No	header
benefit_id	String	ID of the membership to be redeemed	No	query parameter
benefit_type	String	value: membership	No	query parameter

Sample Response




{
    "success": true,
    "redemption_id": "82716061-d7eb-4bda-881c-b4004c791234",
    "voucher": {
        "code": "test",
        "pin": "1234",
        "redemption_link": "https://www.testmerchant.com/redeem"
    }
}

Response Attributes

Attribute	Datatype	Description
redemption_id	String	ID of redemption
voucher	Object	has details of voucher code and pin

Redemption History

This API is used to fetch redemption history of the user. This is has a default pagination of 30 items per page

GET /ps/external/redemptions

Sample Request




curl --location --request GET 'https://sandbox-api.poshvine.com/ps/external/redemptions' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-Project-ID: [PROJECT ID]' \
--header 'X-External-Id: [USER EXTERNAL ID]'

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-External-Id	String	user external id shared in response of create user api(attribute: external_id) to be passed as header parameter.	No	header
X-Project-ID	String	Project ID of the offer	Yes	header
page	Numeric	page no to fetch offers (default value: 1)	Yes	query parameter
per_page	Numeric	per page count of offers(default value: 30)	Yes	query parameter

Sample Response




{
    "data": [
        {
            "id": "82716061-d7eb-4bda-881c-b4004c791234",
            "type": "redemption",
            "attributes": {
                "order_no": "5159582716",
                "created_at": "2021-09-06T18:06:35.968Z",
                "order_value": 0,
                "status": "success",
                "offer": {
                    "id": "1d4e6d9a-3440-4de4-9682-c1bfea277568",
                    "title": "10% discount on the rates published on website/Food/Beverages & Spa.",
                    "end_date": "2022-03-31",
                    "image": "image_url",
                    "computed_offer_value": 0,
                    "redemption_link": null
                },
                "voucher": {
                    "id": "ca9c90b9-e0f5-4fd4-a6d7-d68b7c636497",
                    "code": "test",
                    "status": "created",
                    "voucher_end_date": "2022-03-31"
                }
            }
        },
        {
            "id": "90ab76ab-af74-4f54-9fee-dacad2f1d10e",
            "type": "redemption",
            "attributes": {
                "order_no": "5150890ab7",
                "created_at": "2021-09-06T18:05:08.976Z",
                "order_value": 0,
                "status": "success",
                "offer": {
                    "id": "1d4e6d9a-3440-4de4-9682-c1bfea277568",
                    "title": "10% discount on the rates published on website/Food/Beverages & Spa.",
                    "end_date": "2022-03-31",
                    "image": "image_url",
                    "computed_offer_value": 0,
                    "redemption_link": null
                },
                "voucher": {
                    "id": "ca9c90b9-e0f5-4fd4-a6d7-d68b7c636497",
                    "code": "test",
                    "status": "created",
                    "voucher_end_date": "2022-03-31"
                }
            }
        }
    ]
}

Response Attributes

Attribute	Datatype	Description
id	String	Offer id
type	String	will have the static value redemption
order_no	String	Unique OrderNo for redemption
created_at	String	Time Stamp of redemption creation(GST)
order_value	String	Value of order
status	String	status of redemption (possible values: initiated/processing/success/failure)
offer	Object	offer details of redemption
voucher	Object	Voucher details of redemption. Has details for voucher code, pin and voucher end date

PointsPay Suite

These APIs allows you to integrate with PoshVine PointsPay Suite. PointsPay Suite has 8 APIs i.e

Create Booking
Update Payment Details
Confirm Booking or Make Purchase
Booking Details
User Booking History

Please check the data flow diagram for better understanding

Create Booking API

This API is used to initiate booking, this requires all the details related to item to be purchased and the purchase amount

POST /ps/external/memberships

Sample Request




curl --location --request POST 'https://sandbox-api.poshvine.com/bs/external/bookings/' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-Project-ID: [PROJECT ID]' \
--header 'X-External-Id: [USER EXTERNAL ID]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "item_type": "gift_card",
    "item_id": "e1b710b1-435c-404f-87c4-bcd45efb4df1",
    "item_qty": 1,
    "item_denominations": 3000,
    "amount": 3000,
    "fare_breakup": {
        "base": 3000,
        "taxes": 0,
        "price": 3000,
        "discount": 0
    },
    "user_pack": {
        "first_name": "<user_first_name>",
        "last_name": "<user_last_name>",
        "email": "<user_email>",
        "mobile": "<user_mobile_no.>"
    }
}'

Note:- Please contact PoshVine Team for your staging and production project_id.

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-Project-ID	String	ID of the project for which gift cards to be displayed.	No	header
X-External-Id	String	user external id shared in response of create user api(attribute: external_id) to be passed as header parameter.	No	header
item_type	String	type of item to be purchased (gift_card/membership)	No	body
item_id	String	ID of the item shared in the listing api of Gift Card and Membership	No	body
fare_breakup	Hash Object	Detail of fare, key to be passed in object 1.base - base fare of purchase 2.taxes - taxes applicable on purchase 3.discount - discount applied on purchase 4.price - actual purchase price	No	body
user_pack	Hash Object	Detail of user, key to be passed in object 1.first_name - first name of the user 2.last_name - last name of the user 3.mobile - phone no of the user 4.email - email id of the user	No	body

Sample Response




  { 
    booking_id: <booking_id>, 
    status: "booking_initiated" 
  }

Response Attributes

Attribute	Datatype	Description
booking_id	String	ID of the booking, this id will be used for all further communication related to this purchase
status	String	value: booking_initiated

Update Payment Details

This API is used to collect the payment informations related to the purchase

GET /pa/external/payments

Sample Request




curl --location --request POST 'https://sandbox-api.poshvine.com/pa/external/payments' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-Project-ID: [PROJECT ID]' \
--header 'X-External-Id: [USER EXTERNAL ID]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "booking_id": "<booking_id received from create booking api>",
    "amount": <actual purchase amount>,
    "payment_date": "<date of the payment>",
    "transactions_attributes": [
      {
          "amount": 6000,
          "txn_type": "<amount paid by points>"
      },
      {
        "txn_type": 'payment_gateway'
        "amount": <amount paid by card/net banking/UPI>
      }
    ]
}'

Note:- Please contact PoshVine Team for your staging and production project_id.

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-Project-ID	String	ID of the project for which gift cards to be displayed.	No	header
X-External-Id	String	user external id shared in response of create user api(attribute: external_id) to be passed as header parameter.	No	header
booking_id	String	ID of booking received on create booking api	No	body
amount	String	purchase amount	No	body
payment_date	date	date of payment	No	body
transactions_attributes	Hash Object	Detail of transactions, key to be passed in object 1.txn_type - transaction type (points / payment_gateway) 2.amount - amount paid by mode	No	body

Sample Response




  { 
    booking_id: <booking_id>, 
    booking_status: "booking_initiated",
    payment_status: "success"
  }

Response Attributes

Attribute	Datatype	Description
booking_id	String	ID of the booking, this id will be used for all further communication related to this purchase
booking_status	String	value: booking_in_progress/booking_confirmed
payment_status	String	status of payment

Fetch Booking Details

This API is used to collect the payment informations related to the purchase

GET /bs/external/bookings/:booking_id

Sample Request




curl --location --request GET 'https://sandbox-api.poshvine.com/bs/external/bookings/<booking_id>' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-Project-ID: [PROJECT ID]' \
--header 'X-External-Id: [USER EXTERNAL ID]'

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-Project-ID	String	ID of the project for which gift cards to be displayed.	No	header
X-External-Id	String	user external id shared in response of create user api(attribute: external_id) to be passed as header parameter.	No	header
booking_id	String	ID of booking received on create booking api	No	body

Sample Response




{
  "data": {
    "id": "c24dd811-8e42-4463-b35c-c93f36c28ed9",
    "type": "booking",
    "attributes": {
      "id": "c24dd811-8e42-4463-b35c-c93f36c28ed9",
      "owner_booking_type": "GiftCardBooking",
      "amount": 6000.0,
      "mobile": "9001822185",
      "status": "booking_confirmed",
      "unique_id": "PV1634649081",
      "order_details": [
        {
          "denomination": 3000,
          "qty": 1,
          "vouchers": [],
          "merchant": "Test",
          "title": "Test"
        }
      ]
    }
  }
}

Response Attributes

Attribute	Datatype	Description
booking_id	String	ID of the booking, this id will be used for all further communication related to this purchase
booking_status	String	value: booking_in_progress/booking_confirmed
payment_status	String	status of payment

Fetch User Booking History

This API is used to collect the payment informations related to the purchase

GET /bs/external/bookings/

Sample Request




curl --location --request GET 'https://sandbox-api.poshvine.com/bs/external/bookings' \
--header 'X-API-Client-Token: [CLIENT API KEY]' \
--header 'X-Project-ID: [PROJECT ID]' \
--header 'X-External-Id: [USER EXTERNAL ID]'

Request Attributes

Attribute	Datatype	Description	Optional	Parameter Type
X-API-Client-Token	String	client API key shared by PoshVine Team to be passed as header parameter	No	header
X-Project-ID	String	ID of the project for which gift cards to be displayed.	No	header
X-External-Id	String	user external id shared in response of create user api(attribute: external_id) to be passed as header parameter.	No	header

Sample Response




{
  "data": [
    {
      "id": "82716061-d7eb-4bda-881c-4124c791234",
      "type": "redemption",
      "attributes": {
        "created_at": "2021-09-06T18:06:35.968Z",
        "order_value": 0,
        "merchant": {
          "name": "MamaEarth",
          "logo": null,
          "website": "https://traqkar.com/?a=29&oc=468&c=466&p=r&s1=&s2=[SubID]"
        },
        "gift_card_order": {},
        "offer": {
          "title": "10% discount on the rates published on website/Food/Beverages & Spa.",
          "description": "<p>10% discount on the rates published on website/Food/Beverages & Spa.</p>\r\n\r\n<p><strong>How to redeem:</strong></p>\r\n\r\n<ul>\r\n\t<li>For other queries</li>\r\n\t<li>(M): +91 9596 767 888 (08:00 PM to 09:30 AM)</li>\r\n\t<li>E: reservations.gulmarg@khyberhotels.com<br />\r\n\t </li>\r\n</ul>\r\n",
          "end_date": "2022-03-31",
          "image": "https://poshvine-dev-testing.s3.ap-south-1.amazonaws.com/vwv28v4w3xhvpxzkxk7pfj5cfo1b?response-content-disposition=inline%3B%20filename%3D%22Untitled%20design%20%25281%2529.png%22%3B%20filename%2A%3DUTF-8%27%27Untitled%2520design%2520%25281%2529.png&response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA5DSJ7WXBBOBFZVCG%2F20211019%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20211019T174830Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=a32ae75b8ac56c3c153a639ed59ec6e631d7b18fea1686639ea58629cef31d9c",
          "computed_offer_value": 0,
          "redemption_url": "https://khyberhotels.com/"
        },
        "gift_card": {},
        "voucher": {
          "code": "test",
          "voucher_end_date": "2022-03-31",
          "pin": "1234"
        },
        "gift_card_voucher": {},
        "card_used": {}
      },
      "price": null
    }
  ]
}

Response Attributes

Attribute	Datatype	Description
booking_id	String	ID of the booking, this id will be used for all further communication related to this purchase
booking_status	String	value: booking_in_progress/booking_confirmed
payment_status	String	status of payment

Error Codes

Responses from the API use HTTP response codes to indicate general classes of success and error. Error responses contain more detail about the error in the response body. Following are the few error codes and their explanation.

Note:- Please contact PoshVine Team in case you receive errors not listed below.

HTTP Status Code	Description
200	Success
201	Record created
204	Record not found
401	Unauthorized access, missing/wrong mandatory header parameters
403	Forbidden, in case of wrong/not whitelisted IP or Origin
404	URL Not Found
500	Application error, contact PoshVine Team