Google Wallet API

Google Wallet API आपको प्रोग्रामेटिक रूप से Google Wallet पास बनाने, अपडेट करने, सूचीबद्ध करने और प्रबंधित करने की सुविधा देता है। यह Control Panel में पास बिल्डर द्वारा किए जाने वाले समान ऑपरेशनों का समर्थन करता है।

इसका उपयोग लॉयल्टी कार्ड, ऑफ़र, गिफ़्ट कार्ड, इवेंट टिकट, फ़्लाइट बोर्डिंग पास, ट्रांज़िट टिकट और सामान्य पास जारी करने के लिए, और आपके उपयोगकर्ताओं के डिवाइस पर पहले से सहेजे गए पास पर लाइव अपडेट पुश करने के लिए करें।

आवश्यकता: Google Wallet कॉन्फ़िगरेशन

किसी एप्लिकेशन के लिए पास बनाने से पहले, Pushwoosh Control Panel में उस एप्लिकेशन के लिए एक Google Wallet Issuer ID और सर्विस अकाउंट की कॉन्फ़िगर किया जाना चाहिए। उनके बिना, create और update अनुरोध विफल हो जाते हैं। Android के लिए Google Wallet पास कॉन्फ़िगरेशन देखें।

बेस URL

https://apple-passkit.svc-nue.pushwoosh.com

सभी एंडपॉइंट HTTPS पर परोसे जाते हैं। अनुरोध और प्रतिक्रियाएं application/json का उपयोग करती हैं जब तक कि अन्यथा उल्लेख न किया गया हो।

प्रमाणीकरण

प्रत्येक अनुरोध में आपके Pushwoosh API एक्सेस टोकन के साथ एक Authorization हेडर शामिल होना चाहिए:

Authorization: Token <api-token>

टोकन का स्वामी खाता applicationCode द्वारा संदर्भित एप्लिकेशन का स्वामी होना चाहिए। किसी अन्य खाते से संबंधित एप्लिकेशन के लिए अनुरोध 403 Forbidden लौटाता है।

परंपराएं

• फ़ील्ड नामकरण: JSON फ़ील्ड lowerCamelCase का उपयोग करते हैं (उदाहरण के लिए, serialNumber, hexBackgroundColor, logoUrl)।
• बिना भरे फ़ील्ड: प्रतिक्रियाओं में सभी फ़ील्ड शामिल होते हैं, भले ही वे खाली हों या शून्य-मूल्य वाले हों।
• पहचान: पास बनाते समय serialNumber हमेशा सर्वर द्वारा असाइन किया जाता है। बनाने पर आपके द्वारा भेजा गया कोई भी मान अनदेखा कर दिया जाता है। पूर्ण Google Wallet ऑब्जेक्ट आईडी {issuerId}.{serialNumber} है।
• छवियाँ: logoUrl और heroImageUrl उन छवियों के लिए सार्वजनिक HTTPS URL हैं जिन्हें Google प्राप्त करता है—अपलोड की गई फ़ाइलें नहीं।
• पास शैली: पास पर ठीक एक शैली ऑब्जेक्ट (generic, offer, loyalty, eventTicket, giftCard, flight, या transit) सेट होना चाहिए। बनाने के बाद शैली नहीं बदल सकती।

त्रुटि प्रतिक्रियाएं

HTTP स्थिति	अर्थ
400 Bad Request	अमान्य तर्क—एक आवश्यक फ़ील्ड गुम है या गलत प्रारूप में है।
401 Unauthorized	गुम या अमान्य Authorization हेडर।
403 Forbidden	एप्लिकेशन कॉलर के खाते से संबंधित नहीं है।
404 Not Found	पास, टेम्पलेट, या एप्लिकेशन नहीं मिला।
503 Service Unavailable	सेवा क्षमता पर है या अस्थायी रूप से अनुपलब्ध है।

एंडपॉइंट्स

विधि	पथ	विवरण
POST	/api/google/pass/validate	एक पास कॉन्फ़िगरेशन को मान्य करें
POST	/api/google/pass/create	एक नया पास ऑब्जेक्ट बनाएं और एक सेव लिंक प्राप्त करें
POST	/api/google/pass/update/{serialNumber}	एक मौजूदा पास को अपडेट करें; Google परिवर्तन वितरित करता है
GET	/api/google/pass/{applicationCode}/{serialNumber}/save-link	”Google Wallet में जोड़ें” सेव लिंक प्राप्त करें
GET	/api/google/pass/{applicationCode}/{serialNumber}	एक पास प्राप्त करें
GET	/api/google/passes	एक एप्लिकेशन के लिए सभी पास की सूची बनाएं
POST	/api/google/pass/{applicationCode}/{serialNumber}/state	एक पास को सक्रिय या अमान्य करें
DELETE	/api/google/pass/{applicationCode}/{serialNumber}	एक पास हटाएं
GET	/api/google/config	एप्लिकेशन का Google Wallet कॉन्फ़िगरेशन प्राप्त करें
GET	/api/google/templates	उपलब्ध पास टेम्पलेट्स की सूची बनाएं
GET	/api/google/templates/{filename}	एक टेम्पलेट प्राप्त करें

एक पास बनाएं

Google Wallet में पास क्लास और ऑब्जेक्ट बनाता है, फिर सर्वर-असाइन किया गया सीरियल नंबर, पूर्ण ऑब्जेक्ट आईडी, और एक “Google Wallet में जोड़ें” सेव लिंक लौटाता है।

POST /api/google/pass/create

अनुरोध बॉडी

पैरामीटर	प्रकार	आवश्यक	विवरण
pass	object	हाँ	पास का वर्णन करने वाला पास ऑब्जेक्ट। ठीक एक शैली सेट होनी चाहिए।
userId	string	हाँ	Pushwoosh User ID जिसे पास जारी किया गया है।
applicationCode	string	हाँ	Pushwoosh एप्लिकेशन कोड।

अनुरोध का उदाहरण

{
  "applicationCode": "XXXXX-XXXXX",
  "userId": "user-123",
  "pass": {
    "hexBackgroundColor": "#3c414c",
    "logoUrl": "https://cdn.acme.com/logo.png",
    "loyalty": {
      "programName": "Acme Rewards",
      "accountName": "Jane Doe",
      "accountId": "1234567890",
      "pointsLabel": "Points",
      "pointsBalance": "1200",
      "rewardsTier": "Gold"
    },
    "barcode": {
      "format": "QR_CODE",
      "value": "1234567890"
    }
  }
}

प्रतिक्रिया

फ़ील्ड	प्रकार	विवरण
serialNumber	string	बनाए गए पास की सर्वर-असाइन की गई अद्वितीय पहचान।
objectId	string	पूर्ण Google Wallet ऑब्जेक्ट आईडी: {issuerId}.{serialNumber}।
saveLink	string	”Google Wallet में जोड़ें” लिंक: https://pay.google.com/gp/v/save/{jwt}।
message	string	परिणाम संदेश।

प्रतिक्रिया का उदाहरण

{
  "serialNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "objectId": "XXXXXXXXXXXXXXX.XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "saveLink": "https://pay.google.com/gp/v/save/{jwt}",
  "message": "Pass created successfully"
}

एक पास को मान्य करें

यह Google की आवश्यकताओं के विरुद्ध एक पास कॉन्फ़िगरेशन की जाँच करता है बिना इसे बनाए। create को कॉल करने से पहले उपयोगी है।

POST /api/google/pass/validate

अनुरोध बॉडी

पैरामीटर	प्रकार	आवश्यक	विवरण
pass	object	हाँ	मान्य करने के लिए पास ऑब्जेक्ट।

प्रतिक्रिया

फ़ील्ड	प्रकार	विवरण
valid	boolean	क्या पास सत्यापन पास करता है।
errors	array of strings	अवरुद्ध करने वाली समस्याएं जिन्हें ठीक किया जाना चाहिए।
warnings	array of strings	गैर-अवरुद्ध सलाह।

एक पास अपडेट करें

पास ऑब्जेक्ट को नई सामग्री के साथ पैच करता है। Google फिर अपडेट किया गया संस्करण हर उस डिवाइस पर वितरित करता है जिसने पास सहेजा है। वैकल्पिक रूप से अपडेट के साथ एक Android सूचना भेजता है।

POST /api/google/pass/update/{serialNumber}

पाथ पैरामीटर्स

पैरामीटर	प्रकार	विवरण
serialNumber	string	पास बनाते समय लौटाया गया सीरियल नंबर।

अनुरोध बॉडी

पैरामीटर	प्रकार	आवश्यक	विवरण
updates	object	हाँ	नई सामग्री के साथ पास ऑब्जेक्ट। शैली नहीं बदल सकती।
applicationCode	string	हाँ	Pushwoosh एप्लिकेशन कोड।
notifyMessage	string	नहीं	जब खाली न हो, तो इस टेक्स्ट के साथ एक Android सूचना उन सभी को पुश करें जिन्होंने पास सहेजा है। खाली का मतलब एक मूक अपडेट है।
notifyOnUpdate	boolean	नहीं	एक फ़ील्ड-अपडेट सूचना का अनुरोध करें। केवल loyalty, eventTicket, और flight पास वास्तव में सूचित करते हैं; अन्य शैलियाँ ध्वज को स्वीकार करती हैं लेकिन कभी एक नहीं भेजती हैं। सूचनाएं केवल एक प्रासंगिक प्रारंभ समय के 3 घंटे के भीतर फायर होती हैं, और Google उन्हें प्रति पास प्रति 24 घंटे में 3 सूचनाओं तक सीमित करता है।

अपडेट पर सूचित करने के दो तरीके

notifyMessage उन सभी को एक कस्टम Android सूचना भेजता है जिन्होंने पास सहेजा है और यह किसी भी पास शैली के लिए काम करता है। notifyOnUpdate Google से अपनी फ़ील्ड-अपडेट सूचना भेजने के लिए कहता है, जो केवल loyalty, eventTicket, और flight पास के लिए फायर होती है।

प्रतिक्रिया

फ़ील्ड	प्रकार	विवरण
success	boolean	क्या अपडेट सफल हुआ।
message	string	परिणाम संदेश।

एक सेव लिंक प्राप्त करें

पहले से बनाए गए पास के लिए “Google Wallet में जोड़ें” सेव लिंक लौटाता है। पास ऑब्जेक्ट पहले से मौजूद होना चाहिए (एक पास बनाएं के माध्यम से बनाया गया)।

GET /api/google/pass/{applicationCode}/{serialNumber}/save-link

प्रतिक्रिया

फ़ील्ड	प्रकार	विवरण
saveLink	string	https://pay.google.com/gp/v/save/{jwt}।

लिंक साझा करें या इसे QR कोड के रूप में प्रस्तुत करें

saveLink को “Google Wallet में जोड़ें” बटन के पीछे रखें, या इसे किसी भी QR लाइब्रेरी के साथ QR कोड के रूप में प्रस्तुत करें। जब कोई उपयोगकर्ता इसे खोलता है, तो Google उन्हें पास सहेजने के लिए प्रेरित करता है और उनके डिवाइस को अपडेट के लिए पंजीकृत करता है।

एक पास प्राप्त करें

एक संग्रहीत पास लौटाता है, जिसमें उसका पूरा पास ऑब्जेक्ट शामिल है।

GET /api/google/pass/{applicationCode}/{serialNumber}

प्रतिक्रिया

{ "pass": { ... } } लौटाता है, जो एक पास रिकॉर्ड ऑब्जेक्ट है।

पास की सूची बनाएं

एक एप्लिकेशन के लिए संग्रहीत पास की एक पृष्ठबद्ध, क्रमबद्ध सूची लौटाता है।

GET /api/google/passes?applicationCode=XXXXX-XXXXX&page=0&perPage=20

क्वेरी पैरामीटर्स

पैरामीटर	प्रकार	आवश्यक	विवरण
applicationCode	string	हाँ	Pushwoosh एप्लिकेशन कोड।
orderBy	string	नहीं	सॉर्ट फ़ील्ड: UPDATED (डिफ़ॉल्ट) या CREATED।
orderDirection	string	नहीं	सॉर्ट दिशा: DESC (डिफ़ॉल्ट, सबसे नया पहले) या ASC।
page	integer	नहीं	शून्य-आधारित पृष्ठ सूचकांक। डिफ़ॉल्ट रूप से 0 होता है।
perPage	integer	नहीं	पृष्ठ आकार। 0 या छोड़ा गया सर्वर डिफ़ॉल्ट का उपयोग करता है।

प्रतिक्रिया

फ़ील्ड	प्रकार	विवरण
passes	array of objects	पास रिकॉर्ड ऑब्जेक्ट का वर्तमान पृष्ठ।
page	integer	लौटाया गया पृष्ठ सूचकांक।
perPage	integer	इस प्रतिक्रिया के लिए उपयोग किया गया पृष्ठ आकार।
total	integer	सभी पृष्ठों पर एप्लिकेशन के लिए पास की कुल संख्या।

पास की स्थिति सेट करें

एक पास को सक्रिय या अमान्य करता है। एक अमान्य (निष्क्रिय) पास उपयोगकर्ता के Google Wallet में समाप्त हो चुके पास अनुभाग में चला जाता है; रिकॉर्ड रखा जाता है ताकि इसे फिर से सक्रिय किया जा सके।

POST /api/google/pass/{applicationCode}/{serialNumber}/state

अनुरोध बॉडी

पैरामीटर	प्रकार	आवश्यक	विवरण
active	boolean	हाँ	true पास को ACTIVE पर सेट करता है; false इसे अमान्य करता है (INACTIVE)।

प्रतिक्रिया

सफलता पर एक खाली ऑब्जेक्ट {} लौटाता है।

एक पास हटाएं

Google में पास को अमान्य करता है और Pushwoosh में उसके संग्रहीत रिकॉर्ड को हटा देता है।

DELETE /api/google/pass/{applicationCode}/{serialNumber}

एक सहेजे गए पास को जबरन नहीं हटाया जा सकता

Google किसी उपयोगकर्ता के डिवाइस पर पहले से सहेजे गए पास को हटाने की अनुमति नहीं देता है। हटाने से पास अमान्य हो जाता है (यह समाप्त हो चुके पास में चला जाता है) और Pushwoosh रिकॉर्ड हटा दिया जाता है।

प्रतिक्रिया

सफलता पर एक खाली ऑब्जेक्ट {} लौटाता है।

कॉन्फ़िगरेशन प्राप्त करें

एक एप्लिकेशन के लिए Google Wallet कॉन्फ़िगरेशन स्थिति लौटाता है।

GET /api/google/config?applicationCode=XXXXX-XXXXX

प्रतिक्रिया

फ़ील्ड	प्रकार	विवरण
hasServiceAccount	boolean	क्या एक सर्विस अकाउंट की कॉन्फ़िगर की गई है।
issuerId	string	कॉन्फ़िगर किया गया Google Pay & Wallet Console Issuer ID।
serviceAccountEmail	string	कॉन्फ़िगर किए गए सर्विस अकाउंट का client_email।

टेम्पलेट्स

उपलब्ध उदाहरण पास टेम्पलेट्स की सूची बनाएं, या एक को पास ऑब्जेक्ट के रूप में प्राप्त करें जिसे आप एक शुरुआती बिंदु के रूप में उपयोग कर सकते हैं।

GET /api/google/templates — { "templates": [ { "filename", "name", "description", "style" } ] } लौटाता है।

GET /api/google/templates/{filename} — { "template": { ...pass object... } } लौटाता है।

ऑब्जेक्ट संदर्भ

पास ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
serialNumber	string	बनाने पर सर्वर द्वारा असाइन किया गया; पास की पहचान करता है।
generic / offer / loyalty / eventTicket / giftCard / flight / transit	object	पास की शैली। ठीक एक सेट होना चाहिए। नीचे शैली ऑब्जेक्ट देखें।
hexBackgroundColor	string	कार्ड की पृष्ठभूमि का रंग, #rrggbb।
logoUrl	string	लोगो छवि का सार्वजनिक HTTPS URL। लॉयल्टी और ट्रांज़िट के लिए आवश्यक है।
heroImageUrl	string	एक चौड़ी बैनर छवि का सार्वजनिक HTTPS URL।
barcode	object	पास पर दिखाया गया बारकोड।
textModules	array	विवरण दृश्य में दिखाए गए टेक्स्ट मॉड्यूल।
links	array	विवरण दृश्य में दिखाए गए लिंक मॉड्यूल।
expirationTime	string	ISO 8601 समय जब Google पास को स्वतः समाप्त कर देता है। खाली का मतलब कोई समाप्ति नहीं है।
appLink	object	ऐप लिंक: पास के सामने एक CTA बटन।
locations	array	स्थान जो एक जियोफेंस्ड सूचना को ट्रिगर करते हैं (अधिकतम 10)।
holdersPolicy	string	पास कौन सहेज सकता है: ONE_USER_ALL_DEVICES (डिफ़ॉल्ट), ONE_USER_ONE_DEVICE, या MULTIPLE_HOLDERS।

सामान्य ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
cardTitle	string	आवश्यक। कार्ड के शीर्ष पर जारीकर्ता/प्रोग्राम का नाम।
header	string	आवश्यक। कार्ड का मुख्य शीर्षक।
subheader	string	द्वितीयक शीर्षक।
cardFields	array	सामने पिन किए गए 6 तक टेक्स्ट मॉड्यूल (2 की 3 पंक्तियों तक)।

ऑफ़र ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
title	string	आवश्यक। उदाहरण के लिए, सब कुछ पर 20% की छूट।
provider	string	आवश्यक। व्यापारी का नाम।
details	string	ऑफ़र का विवरण।
finePrint	string	नियम और शर्तें।
redemptionChannel	string	ONLINE, INSTORE, BOTH (डिफ़ॉल्ट), या TEMPORARY_PRICE_REDUCTION।
issuerName	string	Google के “द्वारा जारी” सतहों पर दिखाया गया; डिफ़ॉल्ट रूप से provider होता है।

लॉयल्टी ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
programName	string	आवश्यक। पास पर logoUrl की आवश्यकता है।
accountName	string	कार्ड पर दिखाया गया सदस्य का नाम।
accountId	string	कार्ड पर दिखाया गया सदस्य आईडी।
pointsLabel	string	उदाहरण के लिए, पॉइंट्स। केवल बैलेंस के साथ दिखाया जाता है।
pointsBalance	string	पॉइंट्स बैलेंस।
rewardsTier	string	उदाहरण के लिए, गोल्ड।
rewardsTierLabel	string	टियर के बगल में लेबल; डिफ़ॉल्ट रूप से Tier होता है।
issuerName	string	डिफ़ॉल्ट रूप से programName होता है।

इवेंट टिकट ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
eventName	string	आवश्यक।
venueName / venueAddress	string	स्थान का विवरण।
startDateTime / endDateTime	string	ऑफसेट के साथ ISO 8601 (उदाहरण के लिए, 2026-07-01T19:30:00+02:00)।
ticketHolderName / ticketNumber / ticketType	string	धारक और टिकट का विवरण।
section / row / seat / gate	string	बैठने का विवरण।
issuerName	string	डिफ़ॉल्ट रूप से eventName होता है।

गिफ़्ट कार्ड ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
merchantName	string	आवश्यक।
cardNumber	string	आवश्यक।
pin	string	कार्ड पिन।
balance	string	दशमलव राशि, उदाहरण के लिए 25.00। balanceCurrency की आवश्यकता है।
balanceCurrency	string	ISO 4217 मुद्रा कोड, उदाहरण के लिए USD।
issuerName	string	डिफ़ॉल्ट रूप से merchantName होता है।

फ़्लाइट ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
carrierIataCode	string	आवश्यक। 2-अक्षर का IATA कोड, उदाहरण के लिए LX।
airlineName	string	एयरलाइन का प्रदर्शन नाम।
flightNumber	string	आवश्यक। केवल अंक, उदाहरण के लिए 113।
originAirportCode / destinationAirportCode	string	आवश्यक। 3-अक्षर के IATA कोड।
originTerminal / originGate / destinationTerminal	string	टर्मिनल और गेट का विवरण।
departureDateTime	string	आवश्यक। मूल हवाई अड्डे का स्थानीय समय, ISO 8601 बिना ऑफसेट के (उदाहरण के लिए, 2026-09-01T06:30:00)।
boardingTime / arrivalDateTime	string	समान स्थानीय प्रारूप। arrivalDateTime गंतव्य का स्थानीय समय है।
passengerName	string	आवश्यक।
confirmationCode / seatNumber / seatClass / boardingGroup	string	यात्री का विवरण।
issuerName	string	डिफ़ॉल्ट रूप से airlineName, फिर वाहक कोड होता है।

ट्रांज़िट ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
transitType	string	आवश्यक। BUS, RAIL, TRAM, FERRY, या OTHER।
transitOperatorName	string	आवश्यक। पास पर logoUrl की आवश्यकता है।
passengerName	string	आवश्यक।
ticketNumber	string	टिकट नंबर।
tripType	string	ONE_WAY (डिफ़ॉल्ट) या ROUND_TRIP।
legs	array	यात्रा क्रम में एक या अधिक ट्रांज़िट लेग।
issuerName	string	डिफ़ॉल्ट रूप से transitOperatorName होता है।

ट्रांज़िट लेग ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
originName / destinationName	string	आवश्यक।
departureDateTime / arrivalDateTime	string	ISO 8601; ऑफसेट वैकल्पिक (छोड़ने पर स्थानीय समय)।
platform / coach / seat	string	बोर्डिंग का विवरण।
fareName	string	उदाहरण के लिए, एनीटाइम सिंगल।

बारकोड ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
format	string	QR_CODE, PDF_417, AZTEC, CODE_128, EAN_13, और अन्य Google Wallet बारकोड प्रकार।
value	string	बारकोड में एन्कोड किया गया डेटा।
altText	string	बारकोड के नीचे दिखाया गया टेक्स्ट।

टेक्स्ट मॉड्यूल ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
id	string	मॉड्यूल का पहचानकर्ता।
header	string	मॉड्यूल का शीर्षक।
body	string	मॉड्यूल का टेक्स्ट।

लिंक मॉड्यूल ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
uri	string	बाहरी लिंक URL।
description	string	विवरण दृश्य में दिखाया गया लिंक लेबल।

ऐप लिंक ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
uri	string	वेब URL या डीप-लिंक लक्ष्य URI।
androidPackageName	string	वैकल्पिक। सेट होने पर, Android ऐप खोलता है।
description	string	लक्ष्य URI का आंतरिक विवरण (एक दृश्यमान बटन लेबल नहीं); डिफ़ॉल्ट रूप से URI होता है।

लोकेशन ऑब्जेक्ट

फ़ील्ड	प्रकार	विवरण
latitude	number	-90.0 से +90.0।
longitude	number	-180.0 से +180.0।

पास रिकॉर्ड ऑब्जेक्ट

सूची/प्राप्त एंडपॉइंट द्वारा लौटाया गया।

फ़ील्ड	प्रकार	विवरण
serialNumber	string	पास सीरियल नंबर।
objectId	string	पूर्ण Google Wallet ऑब्जेक्ट आईडी {issuerId}.{serialNumber}।
cardTitle	string	पास के लिए प्रदर्शन शीर्षक/हेडर।
header	string	द्वितीयक प्रदर्शन शीर्षक।
userId	string	Pushwoosh User ID जिसे पास जारी किया गया था।
createdAt / updatedAt	string	निर्माण और अंतिम-अपडेट टाइमस्टैम्प।
state	string	ACTIVE या INACTIVE।
style	string	generic, offer, loyalty, eventTicket, giftCard, flight, या transit।
pass	object	संपादन के लिए पूर्ण पास ऑब्जेक्ट।