- एचटीटीपी अनुरोध
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- RequestHeader
- टाइमस्टैंप
- वर्शन
- PaymentLookupCriteria
- ArnCriteria
- GoogleTransactionReferenceNumberCriteria
- CaptureRequestCriteria
- RequestOriginator
- GetDisputeInquiryReportResponse
- ResponseHeader
- GetDisputeInquiryReportResult
- SuccessDetails
- PurchaseReport
- CustomerAccount
- क्रम
- रकम
- पता
- आइटम
- टैक्स
- पेमेंट
- रिफ़ंड
- PaymentCardDetails
- AuthResult
- खाली
- ErrorResponse
- ErrorResponseResult
- InvalidApiVersion
- InvalidPayloadSignature
- InvalidPayloadEncryption
- RequestTimestampOutOfRange
- InvalidIdentifier
- IdempotencyViolation
- InvalidFieldValue
- MissingRequiredField
- PreconditionViolation
- UserActionInProgress
- InvalidDecryptedRequest
- अनुमति नहीं है
पैसे चुकाने के संभावित विवाद के बारे में उपयोगकर्ता के साथ ग्राहक सहायता की बातचीत को आसान बनाने के लिए, जानकारी देने वाली रिपोर्ट पाएं.
अगर इस तरीके से कोई एचटीटीपी 200 नहीं मिलती है, तो इस क्वेरी के जवाब खाली हो सकते हैं.
अगर अनुरोध को प्रोसेस करते समय एंडपॉइंट किसी गड़बड़ी का सामना करता है, तो इस एंडपॉइंट से मिलने वाला रिस्पॉन्स
टाइप का होगा.ErrorResponse
अगर इस तरीके से कोई एचटीटीपी 200 नहीं मिलती है, तो इस क्वेरी के जवाब खाली हो सकते हैं. रिस्पॉन्स का मुख्य हिस्सा तब खाली होता है, जब साफ़ तौर पर जानकारी देने वाले
का इस्तेमाल किया जा सकता है. इससे किसी हमलावर को यह समझने में मदद मिलती है कि अन्य इंटिग्रेटर के पेमेंट इंटिग्रेटर खाते का आइडेंटिफ़ायर है या नहीं. इन स्थितियों में, जब साइनिंग पासकोड मेल नहीं खाता, पेमेंट इंटिग्रेटर आइडेंटिफ़ायर नहीं मिलता या एन्क्रिप्ट (सुरक्षित) करने वाली कुंजी के बारे में जानकारी नहीं थी, तो यह तरीका खाली बॉडी के साथ एचटीटीपी 404 दिखाएगा. अगर अनुरोध पर किए गए हस्ताक्षर की पुष्टि हो पाती है, तो गड़बड़ी के बारे में ज़्यादा जानकारी जवाब के मुख्य हिस्से में दिखेगी.ErrorResponse
अनुरोध का एक उदाहरण ऐसा दिखता है:
{
"requestHeader": {
"protocolVersion": {
"major": 3
},
"requestId": "HsKv5pvtQKTtz7rdcw1YqE",
"requestTimestamp": {
"epochMillis": "1519996751331"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD"
},
"paymentLookupCriteria": {
"googleTransactionReferenceNumberCriteria": {
"googleTransactionReferenceNumber": "714545417102363157911822",
"authorizationCode": "111111"
}
},
"existingGoogleClaimId": "138431383281",
"requestOriginator": {
"organizationId": "ISSUER_256",
"organizationDescription": "Community Bank of Some City",
"agentId": "982749"
}
}
जवाब का एक उदाहरण ऐसा दिखता है:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": "1519996752221"
}
},
"result": {
"success": {
"googleClaimId": "138431383281",
"report": {
"customerAccount": {
"customerEmail": "example@gmail.com",
"customerName" : "Example Customer"
},
"order": {
"timestamp": {
"epochMillis": "1517992525972"
},
"orderId": "SOP.8976-1234-1234-123456..99",
"subTotalAmount": {
"amountMicros": "206990000",
"currencyCode": "USD"
},
"totalAmount": {
"amountMicros": "212990000",
"currencyCode": "USD"
},
"shippingAddress": {
"addressLine": ["123 Main St"],
"localityName": "Springfield",
"administrativeAreaName": "CO",
"postalCodeNumber": "80309",
"countryCode": "US"
},
"taxes": [
{
"description": "Colorado Sales Tax",
"amount": {
"amountMicros": "6000000",
"currencyCode": "USD"
}
}
],
"items": [
{
"description": "Super cool gizmo",
"merchant": "HTC",
"googleProductName": "Google Store",
"quantity": "2",
"totalPrice": {
"amountMicros": "198000000",
"currencyCode": "USD"
}
},
{
"description": "Gizmo charger",
"merchant": "HTC",
"googleProductName": "Google Store",
"quantity": "1",
"totalPrice": {
"amountMicros": "8990000",
"currencyCode": "USD"
}
}
]
},
"payment": {
"billingAddress" : {
"addressLine": ["123 Main St"],
"localityName": "Springfield",
"administrativeAreaName": "CO",
"postalCodeNumber": "80309",
"countryCode": "US"
},
"amount": {
"amountMicros": "100000000",
"currencyCode": "USD"
},
"refunds": [
{
"amount": {
"amountMicros": "9250000",
"currencyCode": "USD"
},
"initiatedTimestamp": {
"epochMillis": "1518811245384"
}
}
],
"cardDetails": {
"authResult": "APPROVED"
}
}
}
}
}
}
एचटीटीपी अनुरोध
POST https://vgw.googleapis.com/secure-serving/gsp/v3/getDisputeInquiryReport/:PIAID
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में इस तरह का डेटा शामिल होता है:
जेएसओएन के काेड में दिखाना |
---|
{ "requestHeader": { object ( |
फ़ील्ड | |
---|---|
requestHeader |
ज़रूरी: सभी अनुरोधों के लिए सामान्य हेडर. |
paymentLookupCriteria |
ज़रूरी: इस पूछताछ के लिए किस पेमेंट की जानकारी चाहिए, यह दिखाने वाला मानदंड. |
existingGoogleClaimId |
ज़रूरी नहीं: Google की जनरेट की गई स्ट्रिंग, जिसे अगर यह मौजूद नहीं है, तो एक नया दावा आईडी जनरेट किया जाएगा. कॉल करने वाला (कॉलर) यहां भरे गए या जनरेट किए गए दावे के आईडी को, जवाब के
|
requestOriginator |
ज़रूरी: यह अनुरोध करने वाले संगठन या संगठन के सब-ग्रुप की जानकारी. |
जवाब का मुख्य भाग
इस तरीके से, कई तरह के सामान लौटाए जा सकते हैं. ErrorResponse
के साथ आपको 4XX या 5XX एचटीटीपी स्टेटस कोड दिखाने के बारे में ज़्यादा जानने के लिए, ErrorResponse
ऑब्जेक्ट और एचटीटीपी स्टेटस कोड के दस्तावेज़ देखें.
इस तरीके से, कई तरह के सामान लौटाए जा सकते हैं. ErrorResponse
के साथ आपको 4XX या 5XX एचटीटीपी स्टेटस कोड दिखाने के बारे में ज़्यादा जानने के लिए, ErrorResponse
ऑब्जेक्ट और एचटीटीपी स्टेटस कोड के दस्तावेज़ देखें.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
जवाब के तौर पर मिलने वाले मैसेज | |
---|---|
HTTP 200 स्थिति |
|
एचटीटीपी 4XX / 5XX स्टेटस |
|
RequestHeader
हेडर ऑब्जेक्ट, जो सर्वर को भेजे गए सभी अनुरोधों पर तय होता है.
जेएसओएन के काेड में दिखाना |
---|
{ "requestId": string, "requestTimestamp": { object ( |
फ़ील्ड | |
---|---|
requestId |
ज़रूरी है: इस अनुरोध का यूनीक आइडेंटिफ़ायर. यह स्ट्रिंग ज़्यादा से ज़्यादा 100 वर्णों की होती है. साथ ही, इसमें सिर्फ़ "a-z", "A-Z", "0-9", -->, "-", और "_" वर्ण शामिल हैं. |
requestTimestamp |
ज़रूरी है: इस अनुरोध का टाइमस्टैंप. रिसीवर को यह पुष्टि करनी होगी कि यह टाइमस्टैंप 'अभी' का ± 60 सेकंड का है. अगर ऐसा नहीं है, तो अनुरोध को अस्वीकार कर दें. बार-बार कोशिश करने पर, अनुरोध के इस टाइमस्टैंप का पता नहीं चलता. |
protocolVersion |
ज़रूरी: इस अनुरोध का वर्शन. |
paymentIntegratorAccountId |
ज़रूरी है: अनुबंध की शर्तों वाले यूनीक खाते की पहचान करता है. |
टाइमस्टैंप
Unix epoch के बाद से, मिलीसेकंड में ISO टाइमलाइन पर पॉइंट दिखाने वाला टाइमस्टैंप ऑब्जेक्ट.
जेएसओएन के काेड में दिखाना |
---|
{ "epochMillis": string } |
फ़ील्ड | |
---|---|
epochMillis |
ज़रूरी है: Unix epoch के बाद से मिलीसेकंड |
वर्शन
वर्शन ऑब्जेक्ट में, एपीआई का मेजर वर्शन शामिल है. एक ही मेजर वर्शन के सभी वर्शन, इस बात की गारंटी देते हैं कि वे उसके साथ काम करेंगे. इंटिग्रेटर को एक ही मेजर वर्शन के सभी अनुरोधों के साथ काम करना चाहिए.
जेएसओएन के काेड में दिखाना |
---|
{ "major": integer } |
फ़ील्ड | |
---|---|
major |
ज़रूरी: मेजर वर्शन. इसे अलग-अलग वर्शन के साथ कम्पैटबिलटी रिक्वेस्ट के लिए मार्क किया जाता है. इसकी कोई गारंटी नहीं है कि इसके साथ काम करने की सुविधा मिलेगी. |
PaymentLookupCriteria
शर्तों के हिसाब से कंटेनर, जो किसी पेमेंट को खास तरीके से देख सकता है. सदस्य के एक (और सिर्फ़ एक) फ़ील्ड में जानकारी भरी जानी चाहिए.
जेएसओएन के काेड में दिखाना |
---|
{ // Union field |
फ़ील्ड | |
---|---|
यूनियन फ़ील्ड
|
|
arnCriteria |
ज़रूरी नहीं: ऐक्वायरर रेफ़रंस नंबर (एआरएन) के आधार पर लुकअप. |
googleTransactionReferenceNumberCriteria |
ज़रूरी नहीं: Google लेन-देन रेफ़रंस नंबर के आधार पर लुकअप. |
captureRequestCriteria |
ज़रूरी नहीं: कैप्चर करने के मूल अनुरोध के आधार पर लुकअप. |
ArnCriteria
ऐक्क्वायरर रेफ़रंस नंबर (एआरएन) पर आधारित पेमेंट लुकअप.
जेएसओएन के काेड में दिखाना |
---|
{ "acquirerReferenceNumber": string, "authorizationCode": string } |
फ़ील्ड | |
---|---|
acquirerReferenceNumber |
ज़रूरी: एक्क्वायरर रेफ़रंस नंबर (ARN) जिससे पेमेंट की खास पहचान होती है. कोड में 23 अंक होने चाहिए. |
authorizationCode |
ज़रूरी: लेन-देन के लिए अनुमति कोड. |
GoogleTransactionReferenceNumberCriteria
Google के जनरेट किए गए ट्रांज़ैक्शन रेफ़रंस नंबर पर आधारित पेमेंट लुकअप.
जेएसओएन के काेड में दिखाना |
---|
{ "googleTransactionReferenceNumber": string, "authorizationCode": string } |
फ़ील्ड | |
---|---|
googleTransactionReferenceNumber |
ज़रूरी: Google का जनरेट किया गया ट्रांज़ैक्शन रेफ़रंस नंबर, जिससे पेमेंट की खास पहचान होती है. |
authorizationCode |
ज़रूरी: लेन-देन के लिए अनुमति कोड. |
CaptureRequestCriteria
मूल कैप्चर करने के अनुरोध पर आधारित पेमेंट लुकअप.
जेएसओएन के काेड में दिखाना |
---|
{ "captureRequestId": string } |
फ़ील्ड | |
---|---|
captureRequestId |
ज़रूरी है: इस लेन-देन के लिए यूनीक आइडेंटिफ़ायर. यह |
RequestOriginator
यह अनुरोध करने वाले संगठन या संगठन के सब-ग्रुप की जानकारी और वैकल्पिक तौर पर उस कर्मचारी की जानकारी जिससे यह अनुरोध किया गया है. इससे Google, समस्याओं या बुरे बर्ताव का पता लगा पाता है. साथ ही, paymentIntegratorAccountId
के मुकाबले बेहतर तरीके से कंट्रोल लागू कर पाता है. यह खास तौर पर तब अहम होता है, जब कॉल करने वाला एक मध्यस्थ सेवा देने वाला होता है, जो कई बाहरी क्लाइंट से अनुरोध करता है.
जेएसओएन के काेड में दिखाना |
---|
{ "organizationId": string, "organizationDescription": string, "agentId": string } |
फ़ील्ड | |
---|---|
organizationId |
ज़रूरी: उस कंपनी, संगठन या संगठन के ग्रुप का आइडेंटिफ़ायर जिससे यह अनुरोध किया गया है. इस |
organizationDescription |
ज़रूरी है: संगठन का ऐसा नाम या ब्यौरा जिसे कोई भी व्यक्ति आसानी से पढ़ सके. इसका इस्तेमाल, Google के कर्मचारियों और उस संगठन के इंटिग्रेटर के बीच कम्यूनिकेशन को आसान बनाने के लिए किया जा सकता है. |
agentId |
ज़रूरी नहीं: संगठन के उस खास एजेंट (कर्मचारी) के लिए यूनीक आइडेंटिफ़ायर जिसकी पहचान |
GetDisputeInquiryReportResponse
getDisputeInquiryReport
तरीके के लिए रिस्पॉन्स पेलोड.
जेएसओएन के काेड में दिखाना |
---|
{ "responseHeader": { object ( |
फ़ील्ड | |
---|---|
responseHeader |
ज़रूरी: सभी जवाबों के लिए सामान्य हेडर. |
result |
ज़रूरी: इस कॉल का नतीजा. |
ResponseHeader
हेडर ऑब्जेक्ट, जो सर्वर से भेजे गए सभी रिस्पॉन्स पर तय होता है.
जेएसओएन के काेड में दिखाना |
---|
{
"responseTimestamp": {
object ( |
फ़ील्ड | |
---|---|
responseTimestamp |
ज़रूरी है: इस जवाब का टाइमस्टैंप. रिसीवर को यह पुष्टि करनी होगी कि यह टाइमस्टैंप 'अभी' का ± 60 सेकंड का है. अगर ऐसा नहीं है, तो जवाब को अस्वीकार कर दें. |
GetDisputeInquiryReportResult
जेएसओएन के काेड में दिखाना |
---|
{ // Union field |
फ़ील्ड | |
---|---|
यूनियन फ़ील्ड
|
|
success |
पेमेंट की जानकारी मिल गई है और शिकायत भी दे दी गई है. |
paymentNotFound |
जिस पेमेंट का अनुरोध किया गया था वह नहीं मिला. |
paymentTooOld |
अनुरोध किया गया पेमेंट मिल गया है, लेकिन पेमेंट करने की उम्र की वजह से रिपोर्ट नहीं दी गई है. |
orderCannotBeReturned |
अनुरोध किया गया पेमेंट किसी ऐसे ऑर्डर का है जो मौजूद है, लेकिन उसे वापस नहीं किया जा सकता. इसकी वजहों में, वे मामले शामिल होते हैं जिनमें मालिक के अनुरोध पर ऑर्डर हटा दिया गया था. |
noAdditionalDetails |
अनुरोध किया गया पेमेंट मिल गया है, लेकिन रिपोर्ट नहीं है. |
SuccessDetails
जेएसओएन के काेड में दिखाना |
---|
{
"googleClaimId": string,
"report": {
object ( |
फ़ील्ड | |
---|---|
googleClaimId |
ज़रूरी: Google की जनरेट की गई ऐसी स्ट्रिंग जो इस ग्राहक विवाद को खास तौर पर पहचानती है. अगर अनुरोध में |
report |
ज़रूरी: अनुरोध में बताए गए पेमेंट के विवाद से जुड़ी सही जानकारी. |
PurchaseReport
एक रिपोर्ट जिसमें अनुरोध किए गए पेमेंट से जुड़ी खरीदारी की ज़रूरी जानकारी शामिल होती है.
जेएसओएन के काेड में दिखाना |
---|
{ "customerAccount": { object ( |
फ़ील्ड | |
---|---|
customerAccount |
ज़रूरी है: ग्राहक और उसके खाते के बारे में जानकारी. |
order |
ज़रूरी नहीं: उस ऑर्डर की जानकारी जिस पर पेमेंट किया गया था. यह सुविधा, खरीदारी की सभी रिपोर्ट के लिए उपलब्ध नहीं है. |
payment |
ज़रूरी है: पेमेंट के बारे में जानकारी. ध्यान दें: एक ही ऑर्डर के लिए एक से ज़्यादा पेमेंट किए जा सकते हैं. हालांकि, इसमें सिर्फ़ उस पेमेंट की जानकारी शामिल होगी जिसके बारे में मूल अनुरोध में बताया गया था. |
CustomerAccount
ग्राहक के खाते की जानकारी.
जेएसओएन के काेड में दिखाना |
---|
{ "customerEmail": string, "customerName": string } |
फ़ील्ड | |
---|---|
customerEmail |
ज़रूरी नहीं: ग्राहक के Google खाते से जुड़ा ईमेल पता. |
customerName |
ज़रूरी: ग्राहक का नाम. |
क्रम
ऑर्डर के बारे में जानकारी.
जेएसओएन के काेड में दिखाना |
---|
{ "timestamp": { object ( |
फ़ील्ड | |
---|---|
timestamp |
ज़रूरी है: ऑर्डर देने का टाइमस्टैंप. |
orderId |
ज़रूरी: इस ऑर्डर की खास तरह से पहचान करने वाली स्ट्रिंग. |
subTotalAmount |
ज़रूरी: टैक्स से पहले इस ऑर्डर की कुल रकम. |
totalAmount |
ज़रूरी: इस ऑर्डर की कुल रकम, जिसमें टैक्स शामिल है. |
shippingAddress |
ज़रूरी नहीं: इस ऑर्डर में मौजूद सामान के लिए शिपिंग का पता. |
items[] |
ज़रूरी: उन आइटम की सूची जो इस ऑर्डर में शामिल थे. |
taxes[] |
ज़रूरी: उन टैक्स की सूची जो इस ऑर्डर का हिस्सा थे. यह सूची खाली हो सकती है. |
रकम
माइक्रो कोड के साथ रकम को माइक्रो कोड में जोड़ता है.
जेएसओएन के काेड में दिखाना |
---|
{ "amountMicros": string, "currencyCode": string } |
फ़ील्ड | |
---|---|
amountMicros |
ज़रूरी है: माइक्रो में कोई रकम. |
currencyCode |
ज़रूरी है: ISO 4217 का तीन अक्षर वाला मुद्रा कोड |
पता
सिस्टम में घर या ऑफ़िस के पते की जानकारी होती है.
जेएसओएन के काेड में दिखाना |
---|
{ "addressLine": [ string ], "localityName": string, "administrativeAreaName": string, "postalCodeNumber": string, "countryCode": string } |
फ़ील्ड | |
---|---|
addressLine[] |
ज़रूरी नहीं: इसमें पते का ऐसा टेक्स्ट होता है जिसे स्ट्रक्चर नहीं किया गया होता. |
localityName |
ज़रूरी नहीं: यह अस्पष्ट शब्द है, लेकिन आम तौर पर इसका मतलब किसी पते के शहर/कस्बे वाले हिस्से से होता है. दुनिया के उन इलाकों में जहां इलाके तय नहीं हैं या इस स्ट्रक्चर में सही से फ़िट नहीं होते (उदाहरण के लिए, जापान और चीन), localityName खाली छोड़ें और addressLine का इस्तेमाल करें. उदाहरण: अमेरिका का शहर, आईटी कम्यून, यूके पोस्ट टाउन. |
administrativeAreaName |
ज़रूरी नहीं: इस देश का टॉप लेवल प्रशासनिक उपविभाग" उदाहरण: अमेरिका का राज्य, आईटी क्षेत्र, सीएन प्रांत, जेपी प्रांत." |
postalCodeNumber |
ज़रूरी नहीं: नाम होने के बावजूद, postalCodeNumber की वैल्यू अक्सर अक्षर और अंक होती हैं. जैसे: "94043", "SW1W", "SW1W 9TQ". |
countryCode |
ज़रूरी नहीं: ग्राहक के पते का देश कोड, ISO-3166-1 Alpha-2 होना चाहिए. |
आइटम
ऑर्डर में मौजूद किसी आइटम की जानकारी.
जेएसओएन के काेड में दिखाना |
---|
{
"description": string,
"merchant": string,
"quantity": string,
"totalPrice": {
object ( |
फ़ील्ड | |
---|---|
description |
ज़रूरी: खरीदे गए आइटम की जानकारी. |
merchant |
ज़रूरी है: आइटम बेचने वाला, कलाकार या निर्माता. |
quantity |
ज़रूरी नहीं: ऑर्डर की गई इस आइटम की संख्या. अगर प्रॉडक्ट के लिए पूर्णांकों की संख्या लागू नहीं होती है, तो इस फ़ील्ड को छोड़ दिया जाएगा. उदाहरण के लिए, मीटर वाले प्रॉडक्ट में दशमलव वाली संख्या हो सकती है. |
totalPrice |
ज़रूरी: इस आइटम की कुल कीमत. |
googleProductName |
ज़रूरी: आइटम के लिए Google प्रॉडक्ट सेवा का नाम. |
टैक्स
इस ऑर्डर पर लागू होने वाले टैक्स की जानकारी.
जेएसओएन के काेड में दिखाना |
---|
{
"description": string,
"amount": {
object ( |
फ़ील्ड | |
---|---|
description |
ज़रूरी: टैक्स का ब्यौरा. |
amount |
ज़रूरी है: टैक्स की रकम. |
पेमेंट
पेमेंट के बारे में जानकारी.
जेएसओएन के काेड में दिखाना |
---|
{ "billingAddress": { object ( |
फ़ील्ड | |
---|---|
billingAddress |
ज़रूरी: इस पेमेंट के लिए बिलिंग पता. |
amount |
ज़रूरी है: इस पेमेंट की रकम. |
refunds[] |
ज़रूरी: इस पेमेंट के लिए किए गए रिफ़ंड की सूची. यह सूची खाली हो सकती है. |
यूनियन फ़ील्ड
|
|
cardDetails |
ज़रूरी नहीं: क्रेडिट और डेबिट कार्ड के एफ़ओपी से जुड़े पेमेंट की जानकारी. |
रिफ़ंड
पैसे चुकाने पर किए गए रिफ़ंड की जानकारी.
जेएसओएन के काेड में दिखाना |
---|
{ "amount": { object ( |
फ़ील्ड | |
---|---|
amount |
ज़रूरी है: रिफ़ंड की गई रकम. |
initiatedTimestamp |
ज़रूरी है: रिफ़ंड कब किया गया, इसका टाइमस्टैंप. |
PaymentCardDetails
क्रेडिट और डेबिट कार्ड से जुड़ी पेमेंट की जानकारी.
जेएसओएन के काेड में दिखाना |
---|
{
"authResult": enum ( |
फ़ील्ड | |
---|---|
authResult |
ज़रूरी: पेमेंट की पुष्टि का नतीजा. |
AuthResult
पेमेंट की पुष्टि के नतीजे.
Enums | |
---|---|
UNKNOWN_RESULT |
इस डिफ़ॉल्ट वैल्यू को कभी सेट न करें. |
APPROVED |
अनुमति देने का अनुरोध स्वीकार किया गया. |
DENIED |
अनुमति नहीं दी गई. |
NOT_ATTEMPTED |
अनुमति देने की कोशिश नहीं की गई. |
खाली
इस टाइप के लिए कोई फ़ील्ड नहीं है.
इस ऑब्जेक्ट का इस्तेमाल एक्सटेंसिबलिटी के लिए किया जाता है, क्योंकि बूलियन और गिनती को अक्सर अतिरिक्त डेटा के साथ बढ़ाने की ज़रूरत होती है. लागू करने वाला टूल, मौजूदगी का पता लगाने के लिए इसका इस्तेमाल करता है. इसके आधार पर दिखने वाली गिनती को आगे के वर्शन के डेटा के लिए बढ़ाया जा सकता है.
Empty
के लिए JSON फ़ॉर्मैट, JSON ऑब्जेक्ट {}
खाली है.
ErrorResponse
सभी तरीकों के लिए गड़बड़ी रिस्पॉन्स ऑब्जेक्ट.
जेएसओएन के काेड में दिखाना |
---|
{ "responseHeader": { object ( |
फ़ील्ड | |
---|---|
responseHeader |
ज़रूरी: सभी जवाबों के लिए सामान्य हेडर. |
errorDescription |
ज़रूरी नहीं: सहायता प्रतिनिधियों को गड़बड़ियों को डीबग करने के लिए, इस स्थिति की जानकारी दें. ध्यान दें कि यह तरीका लोगों को कभी नहीं दिखाया जाता. इसमें डीबग करने के लिए इस्तेमाल किया जाने वाला, जानकारी देने वाला और गैर-संवेदनशील टेक्स्ट शामिल हो सकता है. ध्यान दें कि इस फ़ील्ड मेंErrorResponseCode की कुछ वैल्यू के साथ और जानकारी भी होनी चाहिए. चेतावनी: इस मैसेज में तब तक कोई टोकन शामिल न करें, जब तक उसे सार्वजनिक के तौर पर सेट न किया गया हो. |
paymentIntegratorErrorIdentifier |
ज़रूरी नहीं: यह आइडेंटिफ़ायर खास तौर पर इंटिग्रेटर के लिए होता है और इसे इंटिग्रेटर जनरेट करता है. इसका इस्तेमाल, सिर्फ़ डीबग करने के लिए किया जाता है, ताकि इस कॉल की पहचान की जा सके. यह वह आइडेंटिफ़ायर है जिससे इंटिग्रेटर इस कॉल को जानता है. |
errorResponseResult |
ज़रूरी नहीं: एक कोड जो होने वाली गड़बड़ी के टाइप को कैप्चर करता है. |
ErrorResponseResult
गड़बड़ी कोड
जेएसओएन के काेड में दिखाना |
---|
{ // Union field |
फ़ील्ड | |
---|---|
यूनियन फ़ील्ड
|
|
invalidApiVersion |
इसका इस्तेमाल तब किया जाता है, जब अनुरोध का एपीआई वर्शन काम नहीं करता हो. सुझाया गया एचटीटीपी कोड: 400 |
invalidPayloadSignature |
इसका इस्तेमाल तब किया जाता है, जब पेलोड का सिग्नेचर किसी अनजान या बंद कुंजी के लिए होता है. सुझाया गया एचटीटीपी कोड: 401 |
invalidPayloadEncryption |
इसका इस्तेमाल तब किया जाता है, जब पेलोड को एन्क्रिप्ट (सुरक्षित) करने के लिए किसी अनजान या बंद कुंजी का इस्तेमाल किया गया हो. सुझाया गया एचटीटीपी कोड: 400 |
requestTimestampOutOfRange |
इसका इस्तेमाल तब किया जाता है, जब अनुरोध टाइमस्टैंप अभी के ± 60 सेकंड से ज़्यादा न हो. सुझाया गया एचटीटीपी कोड: 400 |
invalidIdentifier |
इसका इस्तेमाल तब किया जाता है, जब अनुरोध में भेजा गया कोई आइडेंटिफ़ायर अमान्य या अज्ञात हो. इसमें PIAID, CaptureRequestId, Google Payment Token वगैरह शामिल हो सकते हैं. सुझाया गया एचटीटीपी कोड: 404 |
idempotencyViolation |
इसका इस्तेमाल तब किया जाता है, जब अनुरोध, अनुरोध के लिए तय आईडी से जुड़ी ज़रूरी शर्तों का उल्लंघन करता हो. सुझाया गया एचटीटीपी कोड: 412 |
invalidFieldValue |
इसका इस्तेमाल तब किया जाता है, जब अनुरोध में ऐसे फ़ील्ड के लिए ऐसी वैल्यू शामिल हो जो इस्तेमाल की जा सकने वाली वैल्यू के सेट में नहीं है. सुझाया गया एचटीटीपी कोड: 400 |
missingRequiredField |
इसका इस्तेमाल तब किया जाता है, जब अनुरोध में ज़रूरी फ़ील्ड को सेट नहीं किया जाता है. सुझाया गया एचटीटीपी कोड: 400 |
preconditionViolation |
इसका इस्तेमाल तब किया जाता है जब कार्रवाई में रुकावट का उल्लंघन होता है (उदाहरण के लिए, जब रिफ़ंड की रकम का अनुरोध लेन-देन में बची हुई रकम से ज़्यादा हो जाता है). सुझाया गया एचटीटीपी कोड: 400 |
userActionInProgress |
इसका इस्तेमाल तब किया जाता है जब अनुरोध को अभी प्रोसेस नहीं किया जा सकता. इसकी वजह यह है कि इससे उपयोगकर्ता की उन कार्रवाइयों में रुकावट आ सकती है जो सिस्टम लॉक के तौर पर काम करती है. इस कोड का इस्तेमाल, यह बताने के लिए नहीं किया जाना चाहिए कि लागू करने से जुड़ी खास इंटरनल एक ही मुद्रा में होने वाली गड़बड़ियों की वजह से गड़बड़ियां हो रही हैं. सुझाया गया एचटीटीपी कोड: 423 |
invalidDecryptedRequest |
इसका इस्तेमाल तब किया जाता है, जब अनुरोध पेलोड को डिक्रिप्ट किया जा सकता था. हालांकि, इससे मिलने वाले मैसेज को पार्स नहीं किया जा सका. सुझाया गया एचटीटीपी कोड: 400 |
forbidden |
अनुरोध किए गए संसाधन को ऐक्सेस करने की अनुमति नहीं है. सुझाया गया Http कोड: 403 |
InvalidApiVersion
जेएसओएन के काेड में दिखाना |
---|
{ "requestVersion": { object ( |
फ़ील्ड | |
---|---|
requestVersion |
ज़रूरी: अनुरोध का अमान्य वर्शन. |
expectedVersion |
ज़रूरी: उम्मीद के मुताबिक वर्शन. |
InvalidPayloadSignature
इस टाइप के लिए कोई फ़ील्ड नहीं है.
फ़िलहाल, यह मैसेज जान-बूझकर खाली किया गया है. आने वाले समय में नए फ़ील्ड जोड़े जा सकते हैं.
InvalidPayloadEncryption
इस टाइप के लिए कोई फ़ील्ड नहीं है.
फ़िलहाल, यह मैसेज जान-बूझकर खाली किया गया है. आने वाले समय में नए फ़ील्ड जोड़े जा सकते हैं.
RequestTimestampOutOfRange
जेएसओएन के काेड में दिखाना |
---|
{ "requestTimestamp": { object ( |
फ़ील्ड | |
---|---|
requestTimestamp |
ज़रूरी है: अनुरोध में दिया गया टाइमस्टैंप |
serverTimestampAtReceipt |
ज़रूरी: रसीद पर सर्वर का समय, जिसका इस्तेमाल तुलना करने के लिए किया जाता है |
InvalidIdentifier
जेएसओएन के काेड में दिखाना |
---|
{ "invalidIdentifierType": string } |
फ़ील्ड | |
---|---|
invalidIdentifierType |
ज़रूरी: अमान्य आइडेंटिफ़ायर टाइप. जैसे, PIAID, CaptureRequestId वगैरह. |
IdempotencyViolation
इस टाइप के लिए कोई फ़ील्ड नहीं है.
फ़िलहाल, यह मैसेज जान-बूझकर खाली किया गया है. आने वाले समय में नए फ़ील्ड जोड़े जा सकते हैं.
InvalidFieldValue
जेएसओएन के काेड में दिखाना |
---|
{ "invalidFieldName": string } |
फ़ील्ड | |
---|---|
invalidFieldName |
ज़रूरी: अमान्य फ़ील्ड का नाम. |
MissingRequiredField
जेएसओएन के काेड में दिखाना |
---|
{ "missingFieldNames": [ string ] } |
फ़ील्ड | |
---|---|
missingFieldNames[] |
ज़रूरी: उन फ़ील्ड के नाम जो मौजूद नहीं हैं. |
PreconditionViolation
इस टाइप के लिए कोई फ़ील्ड नहीं है.
फ़िलहाल, यह मैसेज जान-बूझकर खाली किया गया है. आने वाले समय में नए फ़ील्ड जोड़े जा सकते हैं.
UserActionInProgress
इस टाइप के लिए कोई फ़ील्ड नहीं है.
फ़िलहाल, यह मैसेज जान-बूझकर खाली किया गया है. आने वाले समय में नए फ़ील्ड जोड़े जा सकते हैं.
InvalidDecryptedRequest
इस टाइप के लिए कोई फ़ील्ड नहीं है.
फ़िलहाल, यह मैसेज जान-बूझकर खाली किया गया है. आने वाले समय में नए फ़ील्ड जोड़े जा सकते हैं.
अनुमति नहीं है
इस टाइप के लिए कोई फ़ील्ड नहीं है.
फ़िलहाल, यह मैसेज जान-बूझकर खाली किया गया है. आने वाले समय में नए फ़ील्ड जोड़े जा सकते हैं.