- درخواست HTTP
- درخواست بدن
- بدن پاسخگو
- RemittanceStatementSummary
- دوره صورتحساب
- دستورالعمل حواله
- StatementNotification ResultCode
ادغام کننده را از یک صورت حواله جدید مطلع می کند.
هر زمانی که بیانیه جدیدی مطرح می شود که نشان دهنده پولی است که 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 | الزامی : این شناسه حساب یکپارچهکننده پرداخت است که محدودیتهای قراردادی پیرامون این بیانیه را مشخص میکند. |
remittanceStatementSummary | مورد نیاز : خلاصه این بیانیه حواله. |
بدن پاسخگو
شی پاسخ برای روش اطلاع رسانی صورتحواله.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "responseHeader": { object ( |
زمینه های | |
---|---|
responseHeader | مورد نیاز : هدر مشترک برای همه پاسخ ها. |
paymentIntegratorStatementId | مورد نیاز : شناسه ادغام کننده این عبارت را به عنوان می شناسد. این یکپارچه ساز تولید شده است. |
result | الزامی : نتیجه این اطلاعیه بیانیه. |
RemittanceStatementSummary
موضوع خلاصه در مورد بیانیه حواله.
نمایندگی JSON |
---|
{ "statementDate": string, "billingPeriod": { object ( |
زمینه های | |
---|---|
statementDate | مورد نیاز : تاریخ (در آمریکا / لس آنجلس) که این بیانیه ایجاد شده است. |
billingPeriod | مورد نیاز : دوره صورتحساب این بیانیه را پوشش می دهد. |
dateDue | اختیاری : تاریخی که حواله سررسید است. این به صورت میلی ثانیه از دوران نمایش داده می شود. این یک تاریخ است (و بنابراین همیشه در اولین میلی ثانیه روز در منطقه زمانی صورتحساب شروع میشود). این تا زمانی تنظیم می شود که |
currencyCode | مورد نیاز : کد ارز 3 حرفی ISO 4217. |
totalDueByIntegrator | الزامی : این مقدار بر حسب واحد واحد پول ارز |
remittanceInstructions | مورد نیاز : جزئیات نحوه حواله پرداخت |
دوره صورتحساب
دوره صورتحساب این بیانیه.
نمایندگی JSON |
---|
{ "startDate": string, "endDate": string } |
زمینه های | |
---|---|
startDate | مورد نیاز : تاریخ شروع دوره صورتحساب. این به صورت میلی ثانیه از دوران نمایش داده می شود. این یک تاریخ است (و بنابراین همیشه در اولین میلی ثانیه روز در منطقه زمانی صورتحساب شروع میشود). این اولین میلی ثانیه از روز دوره صورتحساب است، 00:00:00.000 |
endDate | مورد نیاز : تاریخ پایان دوره صورتحساب. این به صورت میلی ثانیه از دوران نمایش داده می شود. این آخرین میلیثانیه از آخرین روز دوره صورتحساب است، 23:59:59.999 |
دستورالعمل حواله
ساختاری که اطلاعات مربوط به نحوه پرداخت این اعلان حواله را در اختیار دارد.
نمایندگی JSON |
---|
{ "memoLineId": string } |
زمینه های | |
---|---|
memoLineId | الزامی است : شناسه ای که باید در خط یادداشت برای پرداخت شناسایی حواله قرار داده شود. |
StatementNotification ResultCode
کدهای نتیجه برای اطلاع رسانی بیانیه.
Enums | |
---|---|
UNKNOWN_RESULT | هرگز این مقدار پیش فرض را تنظیم نکنید! |
ACCEPTED | Integrator این گفته را پذیرفته است. |