Method: remittanceStatementNotification

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

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

अगर इंटिग्रेटर की ओर से पुष्टि की प्रोसेस पूरी हो जाती है, तो यह माना जाता है कि स्टेटमेंट स्वीकार कर लिया गया है. इसके बाद, उसे पेमेंट कर दिया जाएगा.

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

अगर अनुरोध को प्रोसेस करते समय एंडपॉइंट को कोई गड़बड़ी मिलती है, तो इस एंडपॉइंट से मिलने वाले रिस्पॉन्स का मुख्य हिस्सा 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

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

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

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

object (RequestHeader)

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

string

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

object (RemittanceStatementSummary)

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

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

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

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

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

object (ResponseHeader)

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

string

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

enum (StatementNotificationResultCode)

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

RemittanceStatementSummary

भेजे गए पैसे के स्टेटमेंट का ऑब्जेक्ट.

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

string (int64 format)

ज़रूरी: वह तारीख (अमेरिका/लॉस एंजेलिस में) जब यह स्टेटमेंट बनाया गया था.
billingPeriod

object (BillingPeriod)

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

string (int64 format)

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

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

string

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

string (Int64Value format)

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

object (RemittanceInstructions)

ज़रूरी: पेमेंट करने के तरीके की जानकारी

BillingPeriod

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

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

string (int64 format)

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

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

string (int64 format)

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

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

RemittanceInstructions

भेजे जाने वाले पैसे की इस सूचना के पेमेंट करने के तरीके के बारे में होल्डिंग की जानकारी.

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

string

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

StatementNotificationResultCode

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

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