- एचटीटीपी अनुरोध
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- RemittanceStatementsummary
- BillingPeriod
- पैसे चुकाने के निर्देश
- इवेंट
भेजे गए पैसों की जानकारी देने वाली जानकारी.
यह कई पेजों में बंटा एपीआई है. numberOfEvents
से, हर पेज पर लेन-देन वाले इवेंट की संख्या तय की जा सकती है. अगर इसे तय नहीं किया गया है, तो हर पेज पर ज़्यादा से ज़्यादा 1,000 इवेंट दिखाए जाएंगे. इस एपीआई को भेजा गया हर अनुरोध, स्टेटमेंट में अगले लेन-देन इवेंट की जानकारी देने वाला nextEventOffset
दिखाएगा. साथ ही, इस स्टेटमेंट में totalEvents
लेन-देन की कुल संख्या भी दिखाएगा. अगर मौजूदा बार में फ़ेच किए गए पेज में स्टेटमेंट का आखिरी लेन-देन शामिल है, तो जवाब में nextEventOffset
मौजूद नहीं होगा.
statementId
की वैल्यू remittanceStatementNotificationRequest
का requestId
है
अगर अनुरोध प्रोसेस करते समय एंडपॉइंट को गड़बड़ी मिलती है, तो इस एंडपॉइंट से मिला रिस्पॉन्स
तरह का होगा.ErrorResponse
अगर यह तरीका, एचटीटीपी 200 का इस्तेमाल नहीं करता है, तो इस क्वेरी के जवाब खाली दिख सकते हैं. रिस्पॉन्स का मुख्य हिस्सा खाली होता है. इसमें,
के बारे में सटीक जानकारी होती है. इससे, हमलावर को अन्य इंटिग्रेटर के पेमेंट इंटिग्रेटर खाते के आइडेंटिफ़ायर को समझने में मदद मिलती है. इन मामलों में, अगर साइनिंग कुंजी मेल नहीं खाती, तो पेमेंट इंटिग्रेटर आइडेंटिफ़ायर नहीं मिलता या एन्क्रिप्ट (सुरक्षित) करने की कुंजी के बारे में कोई जानकारी नहीं होती, लेकिन इस तरीके से एचटीटीपी 404 गड़बड़ी के साथ दिखेगा. अगर अनुरोध हस्ताक्षर की पुष्टि की जा सकती है, तो जवाब के मुख्य भाग में गड़बड़ी के बारे में अतिरिक्त जानकारी दिखाई जाएगी.ErrorResponse
अनुरोध का उदाहरण ऐसा दिखता है:
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 0,
"revision": 0
},
"requestId": "statement_detail_request_139932019",
"requestTimestamp": "1502551332087"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD",
"statementId": "0123434-statement-abc",
"numberOfEvents": 4
}
उदाहरण के तौर पर दिया गया जवाब कुछ इस तरह दिखता है:
{
"responseHeader": {
"responseTimestamp": "1481900013178"
},
"eventOffset": 0,
"nextEventOffset": 4,
"totalEvents": 15,
"remittanceStatementSummary": {
"statementDate": "1502521200000",
"billingPeriod": {
"startDate": "1502434800000",
"endDate": "1502434800000"
},
"dateDue": "1502348400000",
"currencyCode": "INR",
"totalDueByIntegrator": "1076000000",
"remittanceInstructions": {
"memoLineId": "stmt-1AB-pp0-invisi"
}
},
"captureEvents": [
{
"eventRequestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
"paymentIntegratorEventId": "ioj32SOIjf23oijSDfoij",
"eventCharge": "700000000",
"eventFee": "-28000000"
},
{
"eventRequestId": "Ggghvh78200PQ3Yrpb",
"paymentIntegratorEventId": "iasdf23dSdfijSDfoij",
"eventCharge": "800000000",
"eventFee": "-32000000"
}
],
"refundEvents": [
{
"eventRequestId": "liUrreQY233839dfFFb24gaQM",
"paymentIntegratorEventId": "asd3SDf3f3oijSDfoij",
"eventCharge": "-200000000",
"eventFee": "8000000"
},
{
"eventRequestId": "IIghhhUrreQY233839II9qM==",
"paymentIntegratorEventId": "DFjidoso12FSDFSDE",
"eventCharge": "-150000000",
"eventFee": "6000000"
}
]
}
एचटीटीपी अनुरोध
POST https://vgw.googleapis.com/secure-serving/gsp/v1/remittanceStatementDetails/:PIAID
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, नीचे दिए गए स्ट्रक्चर का डेटा शामिल है:
जेएसओएन के काेड में दिखाना |
---|
{
"requestHeader": {
object ( |
फ़ील्ड | |
---|---|
requestHeader |
ज़रूरी: सभी अनुरोधों के लिए सामान्य हेडर. |
paymentIntegratorAccountId |
ज़रूरी है: यह 'पेमेंट इंटिग्रेटर खाता आइडेंटिफ़ायर' है, जो इस स्टेटमेंट के लिए, समझौते की शर्तों की पहचान करता है. |
statementId |
ज़रूरी: स्टेटमेंट की सूचना का अनुरोध आईडी. |
eventOffset |
ज़रूरी नहीं: इस ऑफ़सेट से शुरू होने वाले इवेंट दिखाएं. अगर |
numberOfEvents |
ज़रूरी नहीं: हर पेज पर दिखाने के लिए इवेंट की संख्या. अगर इस बारे में जानकारी न दी गई हो या 1,000 से ज़्यादा हो, तो यह संख्या 1,000 होगी. |
जवाब का मुख्य भाग
भेजे गए पैसे की जानकारी देने के तरीके के लिए जवाब ऑब्जेक्ट.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
जेएसओएन के काेड में दिखाना |
---|
{ "responseHeader": { object ( |
फ़ील्ड | |
---|---|
responseHeader |
ज़रूरी: सभी जवाबों के लिए सामान्य हेडर. |
remittanceStatementSummary |
ज़रूरी है: भेजे गए पैसों की जानकारी की खास जानकारी. |
eventOffset |
ज़रूरी है: इस रिस्पॉन्स का इवेंट ऑफ़सेट. |
nextEventOffset |
ज़रूरी नहीं: दिखाए जाने वाले अगले इवेंट का ऑफ़सेट. अगर यह जानकारी उपलब्ध न हो, तो इस स्टेटमेंट के लिए कोई और इवेंट नहीं मिलता. |
totalEvents |
ज़रूरी है: इस स्टेटमेंट में इवेंट की कुल संख्या. |
totalWithholdingTaxes |
ज़रूरी: इस स्टेटमेंट के लिए रोके गए सभी टैक्स का योग. यह वैल्यू माइक्रो में होती है. |
captureEvents[] |
ज़रूरी है: कैप्चर इवेंट का सेट. |
refundEvents[] |
ज़रूरी है: रिफ़ंड इवेंट का सेट. |
reverseRefundEvents[] |
ज़रूरी नहीं: रिवर्स रिफ़ंड इवेंट का सेट. |
chargebackEvents[] |
ज़रूरी नहीं: चार्जबैक इवेंट का सेट. |
reverseChargebackEvents[] |
ज़रूरी नहीं: रिवर्स चार्जबैक (पैसे खाते में वापस आना) इवेंट का सेट. |
adjustmentEvents[] |
ज़रूरी नहीं: अडजस्टमेंट इवेंट का सेट. बिलिंग में अंतर का मिलान करने के लिए, Google अपने विवेक के आधार पर, अडजस्टमेंट इवेंट जोड़ सकता है. उदाहरण के लिए, अगर पहले किए गए लेन-देन के किसी सेट के लिए शुल्क कम लिया गया था, तो इंटिग्रेटर को पूरा करने के लिए अडजस्टमेंट का इस्तेमाल किया जा सकता है. |
भेजे गए पैसों की जानकारी की खास जानकारी
भेजे गए पैसे के बारे में खास जानकारी देने वाला ऑब्जेक्ट.
जेएसओएन के काेड में दिखाना |
---|
{ "statementDate": string, "billingPeriod": { object ( |
फ़ील्ड | |
---|---|
statementDate |
ज़रूरी है: वह तारीख (अमेरिका/लॉस एंजेलिस में) जब यह स्टेटमेंट बनाया गया था. |
billingPeriod |
ज़रूरी है: इस स्टेटमेंट में बिलिंग की अवधि शामिल है. |
dateDue |
ज़रूरी नहीं: पेमेंट की आखिरी तारीख. इसे Epoch के हिसाब से मिलीसेकंड के तौर पर दिखाया जाता है. यह एक तारीख है (और इसलिए यह हमेशा बिलिंग के समय क्षेत्र में दिन के पहले मिलीसेकंड में शुरू होगी). इसे |
currencyCode |
ज़रूरी है: ISO 4217 का तीन अक्षर वाला मुद्रा कोड. |
totalDueByIntegrator |
ज़रूरी है: यह वैल्यू |
remittanceInstructions |
ज़रूरी: पेमेंट करने के तरीके के बारे में जानकारी |
बिलिंग अवधि
इस स्टेटमेंट की बिलिंग अवधि.
जेएसओएन के काेड में दिखाना |
---|
{ "startDate": string, "endDate": string } |
फ़ील्ड | |
---|---|
startDate |
ज़रूरी: बिलिंग अवधि शुरू होने की तारीख. इसे Epoch के हिसाब से मिलीसेकंड के तौर पर दिखाया जाता है. यह एक तारीख है (और इसलिए यह हमेशा बिलिंग के समय क्षेत्र में दिन के पहले मिलीसेकंड में शुरू होगी). बिलिंग अवधि का दिन का पहला मिलीसेकंड, 00:00:00.000 |
endDate |
ज़रूरी: बिलिंग अवधि के खत्म होने की तारीख. इसे Epoch के हिसाब से मिलीसेकंड के तौर पर दिखाया जाता है. यह बिलिंग अवधि के आखिरी दिन का आखिरी मिलीसेकंड है, 23:59:59.999 |
भेजे गए पैसे से जुड़े निर्देश
इस भेजे गए पैसे की सूचना के तरीके के बारे में जानकारी देने वाला स्ट्रक्चर.
जेएसओएन के काेड में दिखाना |
---|
{ "memoLineId": string } |
फ़ील्ड | |
---|---|
memoLineId |
ज़रूरी है: भेजे गए पैसे की पहचान करने के लिए, मेमो लाइन में डाले जाने वाले आइडेंटिफ़ायर का इस्तेमाल करना. |
इवेंट
भेजे गए पैसे को शामिल करने वाला स्ट्रक्चर.
जेएसओएन के काेड में दिखाना |
---|
{ "eventRequestId": string, "paymentIntegratorEventId": string, "eventCharge": string, "eventFee": string, "presentmentChargeAmount": string, "presentmentCurrencyCode": string, "exchangeRate": string, "nanoExchangeRate": string } |
फ़ील्ड | |
---|---|
eventRequestId |
ज़रूरी: कैप्चर या रिफ़ंड इवेंट के लिए, यह |
paymentIntegratorEventId |
ज़रूरी है: इस इवेंट के लिए मिला पेमेंट इंटिग्रेटर का आईडी. कैप्चर करने के लिए, यह यह फ़ील्ड अलग-अलग अवधि वाला होता है. इस इवेंट के लिए जो भी आईडी दिया जाएगा वह यहां दिखेगा. अगर इंटिग्रेटर ने मिलते-जुलते इवेंट के लिए कोई वैल्यू नहीं दी है, तो इस फ़ील्ड में वही वैल्यू शामिल होगी जो रिफ़ंड की सुविधा, चार्जबैक (पैसे खाते में वापस आना) और रिवर्स चार्जबैक (पैसे खाते में वापस आना) के लिए, यह इस फ़ील्ड की लंबाई और फ़ॉर्मैट, हर आईडी के लिए सोर्स फ़ील्ड पर निर्भर करता है. लंबाई और वर्ण सेट करने से जुड़ी ज़रूरी शर्तों के बारे में जानने के लिए, हर सोर्स फ़ील्ड के दस्तावेज़ देखें. खास तौर पर, इस फ़ील्ड में कभी-कभी Google के जनरेट किए गए आईडी शामिल हो सकते हैं. इन आईडी की लंबाई, इंटिग्रेटर के जनरेट किए गए आईडी से ज़्यादा हो सकती है. |
eventCharge |
ज़रूरी है: स्टेटमेंट में तय किए गए मुद्रा कोड के हिसाब से. अगर यह नेगेटिव वैल्यू है, तो यह Google से पेमेंट इंटिग्रेटर में ट्रांसफ़र होने वाली मॉनेटरी वैल्यू दिखाता है. अगर यह पॉज़िटिव है, तो यह Google की वजह से पेमेंट इंटिग्रेटर का पैसा है. उदाहरण के लिए, कैप्चर लेन-देन हमेशा पॉज़िटिव होंगे. साथ ही, रिफ़ंड के लेन-देन हमेशा नेगेटिव होंगे. रिफ़ंड और रिवर्स चार्जबैक के इवेंट हमेशा पॉज़िटिव होंगे. चार्जबैक (पैसे खाते में वापस आना) के इवेंट हमेशा नेगेटिव होंगे. यह वैल्यू माइक्रो में होती है. |
eventFee |
ज़रूरी है: स्टेटमेंट में तय किए गए मुद्रा कोड के हिसाब से. अगर यह नेगेटिव वैल्यू है, तो यह Google से पेमेंट इंटिग्रेटर में ट्रांसफ़र होने वाली मॉनेटरी वैल्यू दिखाता है. अगर यह पॉज़िटिव है, तो यह Google की वजह से पेमेंट इंटिग्रेटर का पैसा है. उदाहरण के लिए, अगर किसी कानूनी समझौते में बताया गया है कि Google, इंटिग्रेटर को यह वैल्यू माइक्रो में होती है. |
presentmentChargeAmount |
ज़रूरी नहीं: विदेशी मुद्रा बदलने से पहले, लेन-देन की मौजूदा रकम (यानी कि लेन-देन) बताने वाली मुद्रा. यह फ़ील्ड उसी साइन कन्वेंशन का पालन करता है जिस पर यह वैल्यू माइक्रो में होती है. |
presentmentCurrencyCode |
ज़रूरी नहीं: ISO 4217 का तीन अक्षर का मुद्रा कोड, जो प्रज़ेंटेशन (लेन-देन) की मुद्रा को दर्शाता है. |
exchangeRate |
ज़रूरी नहीं: प्रज़ेंटेशन की रकम को सेटलमेंट (इनवॉइस) की रकम में बदलने के लिए इस्तेमाल किया जाने वाला एक्सचेंज रेट. यह वैल्यू माइक्रो बेस पॉइंट (1 आधार पॉइंट = .0001 = .01%) में है. इसका मतलब है कि एक्सचेंज रेट पाने के लिए, इस फ़ील्ड को 10^10 से भाग दें. |
nanoExchangeRate |
ज़रूरी नहीं: प्रज़ेंटेशन की रकम को सेटलमेंट (इनवॉइस) की रकम में बदलने के लिए इस्तेमाल किया जाने वाला एक्सचेंज रेट, नैनो के हिसाब से बताया गया है. यह वैल्यू नैनो आधारित पॉइंट (1 आधार पॉइंट = .0001 = .01%) में है. इसका मतलब है, एक्सचेंज रेट पाने के लिए, इस फ़ील्ड को 10^13 से भाग दें. इस फ़ील्ड और ExchangeRate दोनों में जानकारी भरी जाएगी. ये दोनों अलग-अलग सटीक दरें हैं, जिन्हें अलग-अलग सटीक तरीकों से दिखाया जाता है. आने वाले वर्शन में, nanoExchangeRate के पक्ष में ExchangeRate हटा दिया जाएगा. |