- एचटीटीपी अनुरोध
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- RemittanceStatementSummary
- BillingPeriod
- RemittanceInstructions
- इवेंट
भेजे गए पैसे के स्टेटमेंट के बारे में लेन-देन की जानकारी दिखाता है.
यह कई पेजों वाला एपीआई है. प्रति पेज लेन-देन इवेंट की संख्या 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
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:
JSON के काेड में दिखाना |
---|
{
"requestHeader": {
object ( |
फ़ील्ड | |
---|---|
requestHeader |
ज़रूरी: सभी अनुरोधों के लिए सामान्य हेडर. |
paymentIntegratorAccountId |
ज़रूरी: यह पेमेंट इंटिग्रेटर खाता आइडेंटिफ़ायर है, जो इस स्टेटमेंट से जुड़ी अनुबंध की सीमाओं की पहचान करता है. |
statementId |
ज़रूरी: स्टेटमेंट की सूचना के लिए अनुरोध आईडी. |
eventOffset |
ज़रूरी नहीं: इस ऑफ़सेट से शुरू होने वाले इवेंट दिखाएं. अगर यह पहला अनुरोध है, तो इसे |
numberOfEvents |
ज़रूरी नहीं: हर पेज पर दिखाए जाने वाले इवेंट की संख्या. अगर तय नहीं है या 1,000 से ज़्यादा है, तो यह 1000 होगा. |
जवाब का मुख्य भाग
भेजे गए पैसे के स्टेटमेंट की जानकारी के तरीके के लिए रिस्पॉन्स ऑब्जेक्ट.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
JSON के काेड में दिखाना |
---|
{ "responseHeader": { object ( |
फ़ील्ड | |
---|---|
responseHeader |
ज़रूरी: सभी जवाबों के लिए सामान्य हेडर. |
remittanceStatementSummary |
ज़रूरी: भेजे गए पैसे के स्टेटमेंट की खास जानकारी. |
eventOffset |
ज़रूरी है: इस रिस्पॉन्स का इवेंट ऑफ़सेट. |
nextEventOffset |
ज़रूरी नहीं: दिखाए जाने वाले अगले इवेंट का ऑफ़सेट. अगर जानकारी नहीं है, तो इस स्टेटमेंट को वापस पाने के लिए कोई और इवेंट नहीं है. |
totalEvents |
ज़रूरी: इस स्टेटमेंट में इवेंट की कुल संख्या. |
totalWithholdingTaxes |
ज़रूरी: इस स्टेटमेंट के लिए, रोके गए सभी टैक्स का योग. यह वैल्यू माइक्रो में होती है. |
captureEvents[] |
ज़रूरी: कैप्चर इवेंट का सेट. |
refundEvents[] |
ज़रूरी: रिफ़ंड इवेंट का सेट. |
reverseRefundEvents[] |
ज़रूरी नहीं: रिवर्स रिफ़ंड इवेंट का सेट. |
chargebackEvents[] |
ज़रूरी नहीं: चार्जबैक (पैसे खाते में वापस आना) इवेंट का सेट. |
reverseChargebackEvents[] |
ज़रूरी नहीं: रिवर्स चार्जबैक इवेंट का सेट. |
adjustmentEvents[] |
ज़रूरी नहीं: अडजस्टमेंट इवेंट का सेट. बिलिंग की गड़बड़ियों को ठीक करने के लिए, Google अपने हिसाब से अडजस्टमेंट इवेंट जोड़ सकता है. उदाहरण के लिए, अगर पिछले लेन-देन के किसी सेट के लिए शुल्क का हिसाब कम लगाया गया था, तो इंटिग्रेटर को पूरा बनाने के लिए अडजस्टमेंट का इस्तेमाल किया जा सकता है. |
RemittanceStatementSummary
भेजे गए पैसे के स्टेटमेंट का ऑब्जेक्ट.
JSON के काेड में दिखाना |
---|
{ "statementDate": string, "billingPeriod": { object ( |
फ़ील्ड | |
---|---|
statementDate |
ज़रूरी: वह तारीख (अमेरिका/लॉस एंजेलिस में) जब यह स्टेटमेंट बनाया गया था. |
billingPeriod |
ज़रूरी: इस स्टेटमेंट में दी गई बिलिंग अवधि. |
dateDue |
ज़रूरी नहीं: पैसे भेजने की आखिरी तारीख. इसे epoch से मिलीसेकंड के तौर पर दिखाया जाता है. यह एक तारीख है (इसलिए, बिलिंग टाइमज़ोन में यह हमेशा दिन के पहले मिलीसेकंड में शुरू होगी). यह तब तक सेट रहता है, जब तक |
currencyCode |
ज़रूरी: ISO 4217 वाला तीन अक्षर वाला मुद्रा कोड. |
totalDueByIntegrator |
ज़रूरी: यह मान |
remittanceInstructions |
ज़रूरी: पेमेंट करने के तरीके की जानकारी |
BillingPeriod
इस स्टेटमेंट की बिलिंग अवधि.
JSON के काेड में दिखाना |
---|
{ "startDate": string, "endDate": string } |
फ़ील्ड | |
---|---|
startDate |
ज़रूरी: बिलिंग अवधि शुरू होने की तारीख. इसे epoch से मिलीसेकंड के तौर पर दिखाया जाता है. यह एक तारीख है (इसलिए, बिलिंग टाइमज़ोन में यह हमेशा दिन के पहले मिलीसेकंड में शुरू होगी). यह बिलिंग अवधि के दिन का पहला मिलीसेकंड है, 00:00:00.000 |
endDate |
ज़रूरी: बिलिंग अवधि खत्म होने की तारीख. इसे epoch से मिलीसेकंड के तौर पर दिखाया जाता है. यह बिलिंग अवधि के आखिरी दिन का आखिरी मिलीसेकंड है, 23:59:59.999 |
RemittanceInstructions
भेजे जाने वाले पैसे की इस सूचना के पेमेंट करने के तरीके के बारे में होल्डिंग की जानकारी.
JSON के काेड में दिखाना |
---|
{ "memoLineId": string } |
फ़ील्ड | |
---|---|
memoLineId |
ज़रूरी: वह आइडेंटिफ़ायर जिसे भेजे जाने वाले पैसों की पहचान के लिए, मेमो लाइन में डाला जाना ज़रूरी है. |
इवेंट
भेजे जाने वाले पैसे के ब्यौरे में शामिल एक इवेंट दिखाने वाला स्ट्रक्चर.
JSON के काेड में दिखाना |
---|
{ "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 |
ज़रूरी नहीं: प्रज़ेंटेशन की रकम को सेटलमेंट (इनवॉइस) में बदलने के लिए इस्तेमाल किया गया एक्सचेंज रेट, जिसे नैनो आधार पॉइंट में बताया जाता है. यह वैल्यू nano बेसिस पॉइंट में है (1 आधार पॉइंट = .0001 = .01%). इसका मतलब है कि एक्सचेंज रेट पाने के लिए, इस फ़ील्ड को 10^13 से भाग करें. यह फ़ील्ड और Exchangeरेट, दोनों अपने-आप भर जाएंगे. ये कन्वर्ज़न रेट के बराबर होते हैं और इन्हें अलग-अलग सटीक तरीके से दिखाया जाता है. आने वाले वर्शन में, ExchangeRate को nanoExchangeRate के पक्ष में हटा दिया जाएगा. |