Method: remittanceStatementNotification

ادغام کننده را از یک صورت حواله جدید مطلع می کند.

هر زمانی که بیانیه جدیدی مطرح می شود که نشان دهنده پولی است که Google به ادغام کننده می پردازد یا پولی که ادغام کننده به Google بدهکار است، اعلان های صورت وضعیت ارائه می شود.

اگر ادغام کننده یک موفقیت را برگرداند، آنگاه دریافت بیانیه را تأیید می کند.

requestId نیز عبارت Id است (در جاهای دیگر استفاده می شود). ترکیبی از requestId در هدر و paymentIntegratorAccountId کلید idempotency است و به طور منحصر به فرد این عبارت را شناسایی می کند.

اگر نقطه پایانی هنگام پردازش درخواست با خطا مواجه شود، بدنه پاسخ از این نقطه پایانی باید از نوع 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 کاراکتر است و فقط شامل کاراکترهای "az"، "AZ"، "0-9"، ":"، "-"، و "_" است.

requestTimestamp

string ( int64 format)

الزامی است : مهر زمانی این درخواست به عنوان میلی ثانیه از آن دوره نشان داده شده است. گیرنده باید تأیید کند که این مُهر زمانی ± 60 ثانیه «اکنون» است. این مهر زمانی درخواست پس از تلاش مجدد بی تاثیر نیست.

userLocale
(deprecated)

string

منسوخ شده : کد زبان ISO 639-2 آلفا 3 دو یا سه حرفی که به صورت اختیاری با خط فاصله و کد کشور ISO 3166-1 آلفا-2، به عنوان مثال، «pt-BR»، «fil» یا 'fil-PH'. از این برای کمک به هدایت فیلدهای userMessage در پاسخ استفاده کنید.

protocolVersion

object ( Version )

مورد نیاز : نسخه این درخواست.

نسخه

شئ نسخه که شکلی ساختار یافته از ساختار نسخه کلاسیک abc است. نسخه‌های اصلی همین تعداد تضمین می‌شوند که سازگار باشند. توجه داشته باشید که اصلاحات جزئی و جزئی می توانند اغلب و بدون اطلاع قبلی تغییر کنند. یکپارچه کننده باید از همه درخواست ها برای یک نسخه اصلی پشتیبانی کند.

نمایندگی 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 )

مورد نیاز : جزئیات نحوه حواله پرداخت

دوره صورتحساب

دوره صورتحساب این بیانیه.

نمایندگی JSON
{
  "startDate": string,
  "endDate": string
}
زمینه های
startDate

string ( int64 format)

مورد نیاز : تاریخ شروع دوره صورتحساب. این به صورت میلی ثانیه از دوران نمایش داده می شود. این یک تاریخ است (و بنابراین همیشه در اولین میلی ثانیه روز در منطقه زمانی صورت‌حساب شروع می‌شود).

این اولین میلی ثانیه از روز دوره صورتحساب است، 00:00:00.000

endDate

string ( int64 format)

مورد نیاز : تاریخ پایان دوره صورتحساب. این به صورت میلی ثانیه از دوران نمایش داده می شود.

این آخرین میلی‌ثانیه از آخرین روز دوره صورت‌حساب است، 23:59:59.999

دستورالعمل حواله

ساختاری که اطلاعات مربوط به نحوه پرداخت این اعلان حواله را در اختیار دارد.

نمایندگی JSON
{
  "memoLineId": string
}
زمینه های
memoLineId

string

الزامی است : شناسه ای که باید در خط یادداشت برای پرداخت شناسایی حواله قرار داده شود.

ResponseHeader

شی هدر که روی تمام پاسخ های ارسال شده از سرور تعریف می شود.

نمایندگی JSON
{
  "responseTimestamp": string
}
زمینه های
responseTimestamp

string ( int64 format)

الزامی : مهر زمانی این پاسخ به عنوان میلی ثانیه از دوره نشان داده شده است. گیرنده باید تأیید کند که این مُهر زمانی ± 60 ثانیه «اکنون» است.

StatementNotification ResultCode

کدهای نتیجه برای اطلاع رسانی بیانیه.

Enums
UNKNOWN_RESULT هرگز این مقدار پیش فرض را تنظیم نکنید!
ACCEPTED Integrator این گفته را پذیرفته است.