- Żądanie HTTP
- Treść żądania
- Treść odpowiedzi
- RemittanceStatementSummary
- BillingPeriod
- RemittanceInstructions
- StatementNotificationResultCode
Powiadamia integratora o nowym wyciągu.
Powiadomienia o wyciągach pojawiają się za każdym razem, gdy zostaną wygenerowane nowe wyciągi reprezentujące pieniądze, które Google zapłaci integratorowi, lub pieniądze, które integrator należy do Google.
Jeśli integrator zwróci wynik pomyślnie, zakładamy, że deklaracja została zaakceptowana i zostanie zapłacona.
Parametr requestId
jest również identyfikatorem elementu (używanym w innych miejscach). Kombinacja elementu requestId
w nagłówku i elementu paymentIntegratorAccountId
stanowi klucz idempotentności i jednoznacznie identyfikuje tę instrukcję.
Jeśli podczas przetwarzania żądania punkt końcowy napotka błąd, treść odpowiedzi z tego punktu końcowego powinna być typu
.ErrorResponse
Przykładowe żądanie wygląda tak:
{
"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"
}
}
}
Przykładowa odpowiedź wygląda tak:
{
"responseHeader": {
"responseTimestamp": "1502632802000"
},
"paymentIntegratorStatementId": "334a",
"result": "ACCEPTED"
}
Żądanie HTTP
POST https://www.integratorhost.example.com/v1/remittanceStatementNotification
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "requestHeader": { object ( |
Pola | |
---|---|
requestHeader |
WYMAGANE: wspólny nagłówek dla wszystkich żądań. |
paymentIntegratorAccountId |
WYMAGANE: identyfikator konta integratora płatności określa ograniczenia umowne związane z tym wyciągiem. |
remittanceStatementSummary |
WYMAGANE: podsumowanie tego rachunku. |
Treść odpowiedzi
Obiekt odpowiedzi dla metody powiadomienia z zestawieniem przelewu.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "responseHeader": { object ( |
Pola | |
---|---|
responseHeader |
WYMAGANE: wspólny nagłówek wszystkich odpowiedzi. |
paymentIntegratorStatementId |
WYMAGANE: identyfikator, który integrator zna to instrukcję. Wygenerowano go przez integratora. |
result |
WYMAGANE: wynik tego powiadomienia z instrukcjami. |
RemittanceStatementSummary
Obiekt podsumowania dotyczący wyciągu.
Zapis JSON |
---|
{ "statementDate": string, "billingPeriod": { object ( |
Pola | |
---|---|
statementDate |
WYMAGANE: data (w Ameryce/Los Angeles) utworzenia tego oświadczenia. |
billingPeriod |
WYMAGANE: okres rozliczeniowy uwzględniony na tym wyciągu. |
dateDue |
OPCJONALNIE: termin płatności. Wynik podany w milisekundach od początku epoki. Jest to data (dlatego rozpoczyna się zawsze w pierwszej milisekundy dnia w strefie czasowej rozliczeń). To ustawienie jest skonfigurowane, jeśli |
currencyCode |
WYMAGANE: trzyliterowy kod waluty w standardzie ISO 4217, |
totalDueByIntegrator |
WYMAGANE: ta wartość jest wyrażona w mikro i walucie |
remittanceInstructions |
WYMAGANE: szczegóły dotyczące sposobu płatności. |
BillingPeriod
Okres rozliczeniowy podany na wyciągu.
Zapis JSON |
---|
{ "startDate": string, "endDate": string } |
Pola | |
---|---|
startDate |
WYMAGANE: data rozpoczęcia okresu rozliczeniowego. Wynik podany w milisekundach od początku epoki. Jest to data (dlatego rozpoczyna się zawsze w pierwszej milisekundy dnia w strefie czasowej rozliczeń). To jest pierwsza milisekunda dnia okresu rozliczeniowego (00:00:00.000). |
endDate |
WYMAGANE: data zakończenia okresu rozliczeniowego. Wynik podany w milisekundach od początku epoki. To jest ostatnia milisekunda ostatniego dnia okresu rozliczeniowego: 23:59:59.999. |
RemittanceInstructions
Struktura z informacjami o sposobie dokonania tego powiadomienia o płatności.
Zapis JSON |
---|
{ "memoLineId": string } |
Pola | |
---|---|
memoLineId |
WYMAGANE: identyfikator, który należy umieścić w notatce, aby dokonać płatności. |
StatementNotificationResultCode
Kody wyników dla powiadomień dotyczących instrukcji.
Wartości w polu enum | |
---|---|
UNKNOWN_RESULT |
Nigdy nie ustawiaj tej wartości domyślnej. |
ACCEPTED |
Integrator zaakceptował to oświadczenie. |