Method: remittanceStatementNotification

لإعلام المسؤول عن عملية الدمج ببيان الحوالات المالية الجديد

يتم إرسال إشعارات كشف الحساب في كل مرة يتمّ فيها تقديم كشف جديد يمثِّل الأموال التي ستدفعها 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": 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)

مطلوب: نتيجة الإشعار الخاص ببيان الحساب هذا.

RequestHeader

كائن العنوان المحدَّد في جميع الطلبات المُرسَلة إلى الخادم.

تمثيل JSON 
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
الحقول
requestId

string

مطلوب: المعرّف الفريد لهذا الطلب.

هذه سلسلة يبلغ الحد الأقصى للطول 100 حرف، وتحتوي فقط على الأحرف "a-z" و"A-Z" و"0-9" و"":" و"-" و"_".
requestTimestamp

string (int64 format)

مطلوب: الطابع الزمني لهذا الطلب الذي تم تمثيله بالمللي ثانية منذ البداية. يجب أن يتحقّق المستلِم من أنّ الطابع الزمني هذا هو ± 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 الكلاسيكي. وتضمن توافق الإصدارات الرئيسية من الرقم نفسه. لاحظ أنه قد يتم تغيير القاصرين والمراجعات بشكل متكرر وبدون إشعار. يجب أن تقدّم شركة الدمج طلبات للإصدار الرئيسي نفسه.

تمثيل JSON 
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
الحقول
major

integer

مطلوب: رقم الإصدار الرئيسي. يتم وضع علامة على هذا الطلب توافقًا مع طلبات التوافق مع الإصدارات المختلفة.
minor

integer

مطلوب: إصدار ثانوي. يشير هذا إلى أنه تم إصلاح أخطاء كبيرة.
revision

integer

مطلوب: إصدار ثانوي. ويدل ذلك على إصلاح أخطاء بسيطة.

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)

اختياري: تاريخ استحقاق الحوالة المالية يتم تمثيل ذلك بالمللي ثانية من الحقبة. إنه تاريخ (وبالتالي سيبدأ دائمًا عند أول مللي ثانية من اليوم في المنطقة الزمنية للفوترة).

ويتم ضبط ذلك طالما أنّ قيمة totalDueByIntegrator أكبر من 0.
currencyCode

string

مطلوب: رمز العملة المكوَّن من 3 أحرف بتنسيق ISO 4217.
totalDueByIntegrator

string (Int64Value format)

مطلوبة: هذه القيمة بالمايكرو بعملة currencyCode. وتكون هذه القيمة موجبة دائمًا.
remittanceInstructions

object (RemittanceInstructions)

مطلوب: تفاصيل عن كيفية سداد الدفعة

BillingPeriod

المدة الزمنية للفوترة في كشف الحساب هذا

تمثيل JSON 
{
  "startDate": string,
  "endDate": string
}
الحقول
startDate

string (int64 format)

مطلوب: تاريخ بدء المدة الزمنية للفوترة. يتم تمثيل ذلك بالمللي ثانية من الحقبة. إنه تاريخ (وبالتالي سيبدأ دائمًا عند أول مللي ثانية من اليوم في المنطقة الزمنية للفوترة).

هذه هي المللي ثانية الأولى من يوم المدة الزمنية للفوترة، 00:00:00.000
endDate

string (int64 format)

مطلوب: تاريخ انتهاء المدة الزمنية للفوترة. يتم تمثيل ذلك بالمللي ثانية من الحقبة.

هذه هي المللي ثانية الأخيرة من آخر يوم من المدة الزمنية للفوترة، 23:59:59.999

RemittanceInstructions

هيكل معلومات الاحتفاظ بمعلومات حول كيفية دفع إشعار الحوالة المالية هذه.

تمثيل JSON 
{
  "memoLineId": string
}
الحقول
memoLineId

string

مطلوب: المعرّف الذي يجب وضعه على سطر المذكرة للدفعة من أجل تحديد الحوالة المالية.

ResponseHeader

كائن العنوان الذي يتم تحديده على جميع الاستجابات المُرسَلة من الخادم

تمثيل JSON 
{
  "responseTimestamp": string
}
الحقول
responseTimestamp

string (int64 format)

مطلوب: الطابع الزمني لهذا الرد ممثلاً بالمللي ثانية منذ البداية. يجب أن يتحقّق المستلِم من أنّ الطابع الزمني هذا هو ± 60 ثانية من "الآن".

StatementNotificationResultCode

رموز النتائج لإشعار كشف الحساب

عمليات التعداد
UNKNOWN_RESULT لا تضبط هذه القيمة التلقائية مطلقًا.
ACCEPTED وافقت مسؤول عملية الدمج على هذا البيان.