- طلب HTTP
- نص الطلب
- نص الاستجابة
- RequestHeader
- الإصدار
- RemittanceStatementSummary
- BillingPeriod
- RemittanceInstructions
- ResponseHeader
- StatementNotificationResultCode
لإعلام المسؤول عن عملية الدمج ببيان الحوالات المالية الجديد
يتم إرسال إشعارات كشف الحساب في كل مرة يتمّ فيها تقديم كشف جديد يمثِّل الأموال التي ستدفعها Google لشركة الدمج أو الأموال التي تدين بها شركة الدمج إلى 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"
}
طلب HTTP
POST https://www.integratorhost.example.com/v1/remittanceStatementNotification
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "requestHeader": { object ( |
الحقول | |
---|---|
requestHeader |
مطلوب: العنوان المشترك لجميع الطلبات. |
paymentIntegratorAccountId |
مطلوب: هذا هو معرّف حساب تكامل الدفعات الذي يحدد القيود التعاقدية حول هذا الكشف. |
remittanceStatementSummary |
مطلوب: ملخّص عن كشف التحويل المالي هذا. |
نص الاستجابة
عنصر الردّ الخاص بطريقة إرسال الإشعارات في كشف حساب الحوالة المالية
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "responseHeader": { object ( |
الحقول | |
---|---|
responseHeader |
مطلوب: عنوان مشترك لجميع الردود. |
paymentIntegratorStatementId |
مطلوب: المعرِّف الذي تعرِف شركة الدمج هذا البيان به. تم إنشاء هذا النموذج من خلال عملية الدمج. |
result |
مطلوب: نتيجة الإشعار الخاص ببيان الحساب هذا. |
RequestHeader
كائن العنوان المحدَّد في جميع الطلبات المُرسَلة إلى الخادم.
تمثيل JSON |
---|
{
"requestId": string,
"requestTimestamp": string,
"userLocale": string,
"protocolVersion": {
object ( |
الحقول | |
---|---|
requestId |
مطلوب: المعرّف الفريد لهذا الطلب. هذه سلسلة يبلغ الحد الأقصى للطول 100 حرف، وتحتوي فقط على الأحرف "a-z" و"A-Z" و"0-9" و"":" و"-" و"_". |
requestTimestamp |
مطلوب: الطابع الزمني لهذا الطلب الذي تم تمثيله بالمللي ثانية منذ البداية. يجب أن يتحقّق المستلِم من أنّ الطابع الزمني هذا هو ± 60 ثانية من "الآن". إنّ الطابع الزمني لهذا الطلب غير ثابت عند إعادة المحاولة. |
userLocale |
غير مفعَّلة: يتم اختيار رمز لغة مكوّن من حرفَين أو ثلاثة أحرف بتنسيق ISO 639-2 Alpha 3 متبوعًا بواصلة ورمز بلد بتنسيق ISO 3166-1 Alpha-2، مثل "pt" أو "pt-BR" أو "fil" أو "fil-PH". يمكنك استخدام هذه المعلومات للمساعدة في توجيه حقول |
protocolVersion |
مطلوب: نسخة هذا الطلب. |
الإصدار
كائن الإصدار الذي هو شكل منظَّم لبنية إصدار a.b.c
الكلاسيكي. وتضمن توافق الإصدارات الرئيسية من الرقم نفسه. لاحظ أنه قد يتم تغيير القاصرين والمراجعات بشكل متكرر وبدون إشعار. يجب أن تقدّم شركة الدمج طلبات للإصدار الرئيسي نفسه.
تمثيل JSON |
---|
{ "major": integer, "minor": integer, "revision": integer } |
الحقول | |
---|---|
major |
مطلوب: رقم الإصدار الرئيسي. يتم وضع علامة على هذا الطلب توافقًا مع طلبات التوافق مع الإصدارات المختلفة. |
minor |
مطلوب: إصدار ثانوي. يشير هذا إلى أنه تم إصلاح أخطاء كبيرة. |
revision |
مطلوب: إصدار ثانوي. ويدل ذلك على إصلاح أخطاء بسيطة. |
RemittanceStatementSummary
عنصر ملخّص حول كشف الحوالة المالية
تمثيل JSON |
---|
{ "statementDate": string, "billingPeriod": { object ( |
الحقول | |
---|---|
statementDate |
مطلوب: تاريخ إنشاء هذا البيان (في أمريكا/لوس أنجلوس). |
billingPeriod |
مطلوب: المدة الزمنية للفوترة التي يغطيها هذا البيان. |
dateDue |
اختياري: تاريخ استحقاق الحوالة المالية يتم تمثيل ذلك بالمللي ثانية من الحقبة. إنه تاريخ (وبالتالي سيبدأ دائمًا عند أول مللي ثانية من اليوم في المنطقة الزمنية للفوترة). ويتم ضبط ذلك طالما أنّ قيمة |
currencyCode |
مطلوب: رمز العملة المكوَّن من 3 أحرف بتنسيق ISO 4217. |
totalDueByIntegrator |
مطلوبة: هذه القيمة بالمايكرو بعملة |
remittanceInstructions |
مطلوب: تفاصيل عن كيفية سداد الدفعة |
BillingPeriod
المدة الزمنية للفوترة في كشف الحساب هذا
تمثيل JSON |
---|
{ "startDate": string, "endDate": string } |
الحقول | |
---|---|
startDate |
مطلوب: تاريخ بدء المدة الزمنية للفوترة. يتم تمثيل ذلك بالمللي ثانية من الحقبة. إنه تاريخ (وبالتالي سيبدأ دائمًا عند أول مللي ثانية من اليوم في المنطقة الزمنية للفوترة). هذه هي المللي ثانية الأولى من يوم المدة الزمنية للفوترة، 00:00:00.000 |
endDate |
مطلوب: تاريخ انتهاء المدة الزمنية للفوترة. يتم تمثيل ذلك بالمللي ثانية من الحقبة. هذه هي المللي ثانية الأخيرة من آخر يوم من المدة الزمنية للفوترة، 23:59:59.999 |
RemittanceInstructions
هيكل معلومات الاحتفاظ بمعلومات حول كيفية دفع إشعار الحوالة المالية هذه.
تمثيل JSON |
---|
{ "memoLineId": string } |
الحقول | |
---|---|
memoLineId |
مطلوب: المعرّف الذي يجب وضعه على سطر المذكرة للدفعة من أجل تحديد الحوالة المالية. |
ResponseHeader
كائن العنوان الذي يتم تحديده على جميع الاستجابات المُرسَلة من الخادم
تمثيل JSON |
---|
{ "responseTimestamp": string } |
الحقول | |
---|---|
responseTimestamp |
مطلوب: الطابع الزمني لهذا الرد ممثلاً بالمللي ثانية منذ البداية. يجب أن يتحقّق المستلِم من أنّ الطابع الزمني هذا هو ± 60 ثانية من "الآن". |
StatementNotificationResultCode
رموز النتائج لإشعار كشف الحساب
عمليات التعداد | |
---|---|
UNKNOWN_RESULT |
لا تضبط هذه القيمة التلقائية مطلقًا. |
ACCEPTED |
وافقت مسؤول عملية الدمج على هذا البيان. |