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