Method: remittanceStatementNotification

पैसों के लेन-देन के नए स्टेटमेंट के इंटिग्रेटर को सूचना देता है.

हर बार नया स्टेटमेंट आने पर, स्टेटमेंट की सूचनाएं भेजी जाती हैं. यह स्टेटमेंट तब दिखता है, जब कोई नया स्टेटमेंट जनरेट होता है, जो इंटिग्रेटर को Google चुकाता है या वह रकम जो इंटिग्रेटर को चुकानी होती है.

अगर इंटिग्रेटर की पुष्टि हो जाती है, तो यह स्वीकार करता है कि स्टेटमेंट मिल गया है.

requestId, स्टेटमेंट आईडी भी है (इसका इस्तेमाल कहीं और किया जाता है). हेडर में requestId का कॉम्बिनेशन और paymentIntegratorAccountId, आईडीएम्पॉेंसी कुंजी है और यह इस स्टेटमेंट की खास तौर पर पहचान करता है.

अगर अनुरोध को प्रोसेस करते समय एंडपॉइंट किसी गड़बड़ी का सामना करता है, तो इस एंडपॉइंट से मिलने वाले रिस्पॉन्स का मुख्य हिस्सा ErrorResponse का होना चाहिए.

अनुरोध का एक उदाहरण ऐसा दिखता है:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "0123434-statement-abc",
    "requestTimestamp": "1502632800000"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "remittanceStatementSummary": {
    "statementDate": "1502607600000",
    "billingPeriod": {
      "startDate": "1502434800000",
      "endDate": "1502521199000"
    },
    "dateDue": "1503212400000",
    "currencyCode": "INR",
    "totalDueByIntegrator": "1076000000",
    "remittanceInstructions": {
      "memoLineId": "stmt-1AB-pp0-invisi"
    }
  }
}

जवाब का एक उदाहरण ऐसा दिखता है:


{
  "responseHeader": {
    "responseTimestamp": "1502632802000"
  },
  "paymentIntegratorStatementId": "334a",
  "result": "ACCEPTED"
}

एचटीटीपी अनुरोध

POST https://www.integratorhost.example.com/v1/remittanceStatementNotification

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में इस तरह का डेटा शामिल होता है:

जेएसओएन के काेड में दिखाना 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  }
}
फ़ील्ड
requestHeader

object (RequestHeader)

ज़रूरी: सभी अनुरोधों के लिए सामान्य हेडर.
paymentIntegratorAccountId

string

ज़रूरी: यह पेमेंट इंटिग्रेटर खाता आइडेंटिफ़ायर है, जो इस स्टेटमेंट से जुड़ी अनुबंध की शर्तों की पहचान करता है.
remittanceStatementSummary

object (RemittanceStatementSummary)

ज़रूरी है: भेजे गए पैसे के स्टेटमेंट की खास जानकारी.

जवाब का मुख्य भाग

भेजे गए पैसे के स्टेटमेंट की सूचना के तरीके के लिए रिस्पॉन्स ऑब्जेक्ट.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorStatementId": string,
  "result": enum (StatementNotificationResultCode)
}
फ़ील्ड
responseHeader

object (ResponseHeader)

ज़रूरी: सभी जवाबों के लिए सामान्य हेडर.
paymentIntegratorStatementId

string

ज़रूरी है: वह आइडेंटिफ़ायर जिसके लिए इंटिग्रेटर इस स्टेटमेंट को जानता है. यह इंटिग्रेटर से जनरेट किया गया है.
result

enum (StatementNotificationResultCode)

ज़रूरी: स्टेटमेंट के बारे में सूचना का नतीजा.

RequestHeader

हेडर ऑब्जेक्ट, जो सर्वर को भेजे गए सभी अनुरोधों पर तय होता है.

जेएसओएन के काेड में दिखाना 
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
फ़ील्ड
requestId

string

ज़रूरी है: इस अनुरोध का यूनीक आइडेंटिफ़ायर.

यह स्ट्रिंग ज़्यादा से ज़्यादा 100 वर्णों की होती है. साथ ही, इसमें सिर्फ़ "a-z", "A-Z", "0-9", -->, "-", और "_" वर्ण शामिल हैं.
requestTimestamp

string (int64 format)

ज़रूरी है: इस अनुरोध का टाइमस्टैंप, epoch के बाद के मिलीसेकंड के तौर पर दिखाया जाता है. रिसीवर को यह पुष्टि करनी चाहिए कि यह टाइमस्टैंप 'अभी' के ± 60 सेकंड का है. बार-बार कोशिश करने पर, अनुरोध के इस टाइमस्टैंप का पता नहीं चलता.
userLocale
(deprecated)

string

रोक दिया गया: दो या तीन अक्षर का ISO 639-2 Alpha 3 भाषा कोड. इसके बाद हाइफ़न और ISO 3166-1 Alpha-2 देश का कोड डालें, उदाहरण के लिए, 'pt', 'pt-BR', 'fil' या 'fil-PH'. जवाब में, userMessage फ़ील्ड को चलाने के लिए इसका इस्तेमाल करें.
protocolVersion

object (Version)

ज़रूरी: इस अनुरोध का वर्शन.

वर्शन

वर्शन ऑब्जेक्ट, जो a.b.c के क्लासिक वर्शन के स्ट्रक्चर का स्ट्रक्चर है. इस बात की गारंटी है कि एक ही नंबर वाले मुख्य वर्शन, सभी के साथ काम करेंगे. ध्यान दें कि मामूली और बदलाव, बिना किसी सूचना के बार-बार बदल सकते हैं. इंटिग्रेटर को एक ही मेजर वर्शन के सभी अनुरोधों के साथ काम करना चाहिए.

जेएसओएन के काेड में दिखाना 
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
फ़ील्ड
major

integer

ज़रूरी: मेजर वर्शन. इसे अलग-अलग वर्शन के साथ कम्पैटबिलटी रिक्वेस्ट के लिए मार्क किया जाता है. इसकी कोई गारंटी नहीं है कि इसके साथ काम करने की सुविधा मिलेगी.
minor

integer

ज़रूरी: माइनर वर्शन. यह अहम गड़बड़ियां ठीक करता है.
revision

integer

ज़रूरी: माइनर वर्शन. यह छोटी गड़बड़ियों को ठीक करने के बारे में बताता है.

RemittanceStatementSummary

भेजे गए पैसे के स्टेटमेंट के बारे में खास जानकारी.

जेएसओएन के काेड में दिखाना 
{
  "statementDate": string,
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": string,
  "currencyCode": string,
  "totalDueByIntegrator": string,
  "remittanceInstructions": {
    object (RemittanceInstructions)
  }
}
फ़ील्ड
statementDate

string (int64 format)

REQUIRED: इस स्टेटमेंट को बनाने की तारीख (अमेरिका/लॉस एंजेलिस में).
billingPeriod

object (BillingPeriod)

ज़रूरी: इस स्टेटमेंट में शामिल बिलिंग अवधि.
dateDue

string (int64 format)

ज़रूरी नहीं: वह तारीख जब पेमेंट करना है. इसे epoch से मिलीसेकंड के रूप में दिखाया जाता है. यह एक तारीख है. इसलिए, यह बिलिंग टाइमज़ोन में हमेशा दिन के पहले मिलीसेकंड से शुरू होगी.

यह तब तक सेट किया जाता है, जब तक totalDueByIntegrator की वैल्यू 0 से ज़्यादा हो.
currencyCode

string

ज़रूरी है: ISO 4217 तीन अक्षर वाला मुद्रा कोड.
totalDueByIntegrator

string (Int64Value format)

ज़रूरी: यह वैल्यू, currencyCode की मुद्रा में माइक्रो में है. यह वैल्यू हमेशा पॉज़िटिव होती है.
remittanceInstructions

object (RemittanceInstructions)

ज़रूरी: पैसे चुकाने के तरीके की जानकारी

BillingPeriod

इस स्टेटमेंट की बिलिंग अवधि.

जेएसओएन के काेड में दिखाना 
{
  "startDate": string,
  "endDate": string
}
फ़ील्ड
startDate

string (int64 format)

ज़रूरी: बिलिंग अवधि शुरू होने की तारीख. इसे epoch से मिलीसेकंड के रूप में दिखाया जाता है. यह एक तारीख है. इसलिए, यह बिलिंग टाइमज़ोन में हमेशा दिन के पहले मिलीसेकंड से शुरू होगी.

यह बिलिंग अवधि के दिन का पहला मिलीसेकंड है, 00:00:00.000
endDate

string (int64 format)

ज़रूरी: बिलिंग अवधि खत्म होने की तारीख. इसे epoch से मिलीसेकंड के रूप में दिखाया जाता है.

यह बिलिंग अवधि के आखिरी दिन का आखिरी मिलीसेकंड है, 23:59:59.999

RemittanceInstructions

प्रोसेस में, इनवॉइस भेजे जाने की सूचना का पेमेंट करने के तरीके की जानकारी होती है.

जेएसओएन के काेड में दिखाना 
{
  "memoLineId": string
}
फ़ील्ड
memoLineId

string

ज़रूरी है: वह आइडेंटिफ़ायर जिसे मेमो लाइन पर रखना ज़रूरी है, ताकि भेजे गए पैसे की पहचान की जा सके.

ResponseHeader

हेडर ऑब्जेक्ट, जो सर्वर से भेजे गए सभी रिस्पॉन्स पर तय होता है.

जेएसओएन के काेड में दिखाना 
{
  "responseTimestamp": string
}
फ़ील्ड
responseTimestamp

string (int64 format)

ज़रूरी है: इस जवाब का टाइमस्टैंप, epoch के बाद के मिलीसेकंड के तौर पर दिखाया जाता है. रिसीवर को यह पुष्टि करनी चाहिए कि यह टाइमस्टैंप 'अभी' के ± 60 सेकंड का है.

StatementNotificationResultCode

स्टेटमेंट की सूचना के लिए नतीजों के कोड.

Enums
UNKNOWN_RESULT कभी भी यह डिफ़ॉल्ट वैल्यू सेट न करें!
ACCEPTED इंटिग्रेटर ने इस स्टेटमेंट को स्वीकार कर लिया है.