Method: remittanceStatementNotification

Benachrichtigt den Integrator einer neuen Überweisungsbescheinigung.

Auszugsbenachrichtigungen werden immer dann angezeigt, wenn eine neue Abrechnung vorliegt, die aussagt, dass Google den Integrator oder den Rechnungsbetrag an den Integrator schuldet.

Wenn der Integrator einen Erfolg zurückgibt, bestätigt er den Erhalt der Anweisung.

requestId ist auch die Anweisungs-ID, die an anderer Stelle verwendet wird. Die Kombination aus requestId im Header und paymentIntegratorAccountId ist der Idempotenzschlüssel und identifiziert diese Anweisung eindeutig.

Wenn am Endpunkt bei der Verarbeitung der Anfrage ein Fehler auftritt, sollte der Antworttext dieses Endpunkts vom Typ ErrorResponse sein.

Eine Beispielanfrage sieht so aus:


{
  "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"
    }
  }
}

Eine Beispielantwort sieht so aus:


{
  "responseHeader": {
    "responseTimestamp": "1502632802000"
  },
  "paymentIntegratorStatementId": "334a",
  "result": "ACCEPTED"
}

HTTP-Anfrage

POST https://www.integratorhost.example.com/v1/remittanceStatementNotification

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  }
}
Felder
requestHeader

object (RequestHeader)

ERFORDERLICH: Allgemeiner Header für alle Anfragen.
paymentIntegratorAccountId

string

ERFORDERLICH: Dies ist die Zahlungsintegrationskonto-ID, die vertragliche Einschränkungen für diese Abrechnung angibt.
remittanceStatementSummary

object (RemittanceStatementSummary)

REQUIRED: Zusammenfassung dieses Überweisungsscheins.

Antworttext

Antwortobjekt für die Benachrichtigungsmethode der Zahlungsanweisung.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorStatementId": string,
  "result": enum (StatementNotificationResultCode)
}
Felder
responseHeader

object (ResponseHeader)

REQUIRED: Allgemeiner Header für alle Antworten.
paymentIntegratorStatementId

string

REQUIRED: Kennung, unter der diese Anweisung dem Integrator bekannt ist. Dies wurde vom Integrator generiert.
result

enum (StatementNotificationResultCode)

REQUIRED: Ergebnis dieser Benachrichtigung.

RequestHeader

Header-Objekt, das für alle an den Server gesendeten Anfragen definiert wird.

JSON-Darstellung 
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
Felder
requestId

string

REQUIRED: Die eindeutige ID der Anfrage.

Dies ist ein String mit maximal 100 Zeichen, der nur die Zeichen „a–z“, „A–Z“, „0–9“, ":", „-“ und „_“ enthält.
requestTimestamp

string (int64 format)

REQUIRED: Zeitstempel dieser Anfrage in Millisekunden seit der Epoche. Der Empfänger sollte überprüfen, ob dieser Zeitstempel ± 60 Sekunden von „jetzt“ ist. Dieser Anfragezeitstempel ist bei Wiederholungen nicht idempotent.
userLocale
(deprecated)

string

EINGESTELLT: Ein aus zwei oder drei Buchstaben bestehender ISO 639-2 Alpha 3-Sprachcode, optional gefolgt von einem Bindestrich und einem Ländercode gemäß ISO 3166-1 Alpha-2, z.B."pt", "pt-BR", "fil" oder "fil-PH". Verwenden Sie dies, um die userMessage-Felder in der Antwort zu verarbeiten.
protocolVersion

object (Version)

REQUIRED: Die Version dieser Anfrage.

Version

Versionsobjekt, das eine strukturierte Form der klassischen a.b.c-Versionsstruktur ist. Für Hauptversionen derselben Nummer wird garantiert, dass sie kompatibel sind. Beachten Sie, dass kleinere und überarbeitete Versionen häufig und ohne Vorankündigung geändert werden können. Der Integrator muss alle Anfragen für dieselbe Hauptversion unterstützen.

JSON-Darstellung 
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
Felder
major

integer

ERFORDERLICH: Hauptversion. Dies ist für Kompatibilitätsanfragen mit unterschiedlichen Versionen gekennzeichnet, bei denen nicht garantiert wird, dass sie kompatibel sind.
minor

integer

REQUIRED: Nebenversion. Dies weist auf erhebliche Fehlerkorrekturen hin.
revision

integer

REQUIRED: Nebenversion. Dies weist auf kleinere Fehlerkorrekturen hin.

RemittanceStatementSummary

Zusammenfassungsobjekt für eine Überweisungsanweisung.

JSON-Darstellung 
{
  "statementDate": string,
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": string,
  "currencyCode": string,
  "totalDueByIntegrator": string,
  "remittanceInstructions": {
    object (RemittanceInstructions)
  }
}
Felder
statementDate

string (int64 format)

REQUIRED: Datum (in Amerika/Los Angeles), an dem dieser Bericht erstellt wurde.
billingPeriod

object (BillingPeriod)

ERFORDERLICH: Der Abrechnungszeitraum, für den diese Abrechnung gilt.
dateDue

string (int64 format)

OPTIONAL: Datum, an dem die Überweisung fällig ist. Sie werden in Millisekunden seit der Epoche angegeben. Es handelt sich um ein Datum. Daher beginnt es immer mit der ersten Millisekunde des Tages in der Zeitzone der Abrechnung.

Dieser Wert ist festgelegt, solange totalDueByIntegrator größer als 0 ist.
currencyCode

string

ERFORDERLICH: Dreistelliger Währungscode gemäß ISO 4217.
totalDueByIntegrator

string (Int64Value format)

ERFORDERLICH: Dieser Wert wird in Mikros und in der Währung currencyCode angegeben. Dieser Wert ist immer positiv.
remittanceInstructions

object (RemittanceInstructions)

ERFORDERLICH: Details zum Ausführen der Zahlung

BillingPeriod

Abrechnungszeitraum für diese Abrechnung.

JSON-Darstellung 
{
  "startDate": string,
  "endDate": string
}
Felder
startDate

string (int64 format)

REQUIRED: Startdatum des Abrechnungszeitraums. Sie werden in Millisekunden seit der Epoche angegeben. Es handelt sich um ein Datum. Daher beginnt es immer mit der ersten Millisekunde des Tages in der Zeitzone der Abrechnung.

Dies ist die erste Millisekunde des Tages des Abrechnungszeitraums, 00:00:00.000
endDate

string (int64 format)

REQUIRED: Enddatum des Abrechnungszeitraums. Sie werden in Millisekunden seit der Epoche angegeben.

Dies ist die letzte Millisekunde des letzten Tages des Abrechnungszeitraums (23:59:59.999).

RemittanceInstructions

Gebäude mit Informationen zum Bezahlen dieser Überweisungsbenachrichtigung.

JSON-Darstellung 
{
  "memoLineId": string
}
Felder
memoLineId

string

ERFORDERLICH: Identifizierungsnummer für Überweisungen, die auf der Zahlungszeile für die Zahlung angegeben werden muss.

ResponseHeader

Header-Objekt, das für alle vom Server gesendeten Antworten definiert ist.

JSON-Darstellung 
{
  "responseTimestamp": string
}
Felder
responseTimestamp

string (int64 format)

REQUIRED: Zeitstempel dieser Antwort, angegeben in Millisekunden seit der Epoche. Der Empfänger sollte überprüfen, ob dieser Zeitstempel ± 60 Sekunden von „jetzt“ ist.

StatementNotificationResultCode

Ergebniscodes für Anweisungsbenachrichtigungen.

Enums
UNKNOWN_RESULT Legen Sie diesen Standardwert niemals fest!
ACCEPTED Der Integrator hat diese Aussage akzeptiert.