Method: remittanceStatementDetails

Gibt Transaktionsdetailinformationen zu einer Überweisung zurück.

Dies ist eine API mit Seitenumbruch. Die Anzahl der Transaktionsereignisse pro Seite kann mit numberOfEvents angegeben werden. Wenn Sie nichts angeben, wird die maximale Anzahl von 1.000 Ereignissen pro Seite zurückgegeben. Bei jeder Anfrage an diese API wird ein nextEventOffset zurückgegeben, das auf das nächste Transaktionsereignis in der Anweisung verweist, sowie totalEvents für die Gesamtzahl der Transaktionen in der Anweisung. Wenn die aktuell abgerufene Seite die letzten Transaktionen der Anweisung enthält, ist nextEventOffset nicht in der Antwort enthalten.

Der Wert für statementId ist der requestId aus der remittanceStatementNotificationRequest

Wenn beim Verarbeiten der Anfrage ein Fehler auftritt, hat die Antwort vom Endpunkt ErrorResponse.

Die Antworten auf diese Abfrage können leer sein, wenn die Methode kein HTTP 200 zurückgibt. Der Antworttext ist leer, wenn ein ErrorResponse mit einer klaren Beschreibung verwendet werden könnte, um einem Angreifer die Identifizierung des Zahlungsintegrators mit anderen Integratoren zu erleichtern. Wenn der Signaturschlüssel nicht übereinstimmt, die Zahlungsintegrations-ID nicht gefunden wurde oder der Verschlüsselungsschlüssel unbekannt ist, gibt diese Methode einen HTTP 404-Code mit leerem Text zurück. Wenn die Anfragesignatur verifiziert werden kann, werden zusätzliche Informationen zum Fehler im Antworttext zurückgegeben.

Eine Beispielanfrage sieht so aus:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "statement_detail_request_139932019",
    "requestTimestamp": "1502551332087"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "statementId": "0123434-statement-abc",
  "numberOfEvents": 4
}

Eine Beispielantwort sieht so aus:


{
  "responseHeader": {
    "responseTimestamp": "1481900013178"
  },
  "eventOffset": 0,
  "nextEventOffset": 4,
  "totalEvents": 15,
  "remittanceStatementSummary": {
    "statementDate": "1502521200000",
    "billingPeriod": {
      "startDate": "1502434800000",
      "endDate": "1502434800000"
    },
    "dateDue": "1502348400000",
    "currencyCode": "INR",
    "totalDueByIntegrator": "1076000000",
    "remittanceInstructions": {
      "memoLineId": "stmt-1AB-pp0-invisi"
    }
  },
  "captureEvents": [
    {
      "eventRequestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
      "paymentIntegratorEventId": "ioj32SOIjf23oijSDfoij",
      "eventCharge": "700000000",
      "eventFee": "-28000000"
    },
    {
      "eventRequestId": "Ggghvh78200PQ3Yrpb",
      "paymentIntegratorEventId": "iasdf23dSdfijSDfoij",
      "eventCharge": "800000000",
      "eventFee": "-32000000"
    }
  ],
  "refundEvents": [
    {
      "eventRequestId": "liUrreQY233839dfFFb24gaQM",
      "paymentIntegratorEventId": "asd3SDf3f3oijSDfoij",
      "eventCharge": "-200000000",
      "eventFee": "8000000"
    },
    {
      "eventRequestId": "IIghhhUrreQY233839II9qM==",
      "paymentIntegratorEventId": "DFjidoso12FSDFSDE",
      "eventCharge": "-150000000",
      "eventFee": "6000000"
    }
  ]
}

HTTP-Anfrage

POST https://vgw.googleapis.com/secure-serving/gsp/v1/remittanceStatementDetails/:PIAID

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "statementId": string,
  "eventOffset": integer,
  "numberOfEvents": integer
}
Felder
requestHeader

object (RequestHeader)

REQUIRED: Allgemeiner Header für alle Anfragen.

paymentIntegratorAccountId

string

ERFORDERLICH: Das ist die Kennung des Zahlungsintegrators, mit der vertragliche Einschränkungen für diese Abrechnung identifiziert werden.

statementId

string

ERFORDERLICH: Die ID der Benachrichtigung zur Abrechnung.

eventOffset

integer

OPTIONAL: Ereignisse werden ab diesem Offset zurückgegeben. Dieser Wert sollte auf nextEventOffset gesetzt sein, wenn eines zurückgegeben wurde oder nicht angegeben wurde, falls dies die erste Anfrage ist. Wenn eventOffset auf null gesetzt ist, werden Ereignisse zurückgegeben, die mit dem ersten Ereignis beginnen. Wenn es sich um zwei handelt, werden Ereignisse zurückgegeben, die mit dem dritten Ereignis beginnen. Wenn Sie keine angeben, wird für eventOffset „0“ angenommen.

numberOfEvents

integer

OPTIONAL: Anzahl der Ereignisse, die pro Seite angezeigt werden sollen Ist kein Wert angegeben oder größer als 1.000, ist der Wert 1.000.

Antworttext

Antwortobjekt für die Detailmethode der Überweisungsabrechnung.

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

JSON-Darstellung
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  },
  "eventOffset": integer,
  "nextEventOffset": integer,
  "totalEvents": integer,
  "totalWithholdingTaxes": string,
  "captureEvents": [
    {
      object (Event)
    }
  ],
  "refundEvents": [
    {
      object (Event)
    }
  ],
  "reverseRefundEvents": [
    {
      object (Event)
    }
  ],
  "chargebackEvents": [
    {
      object (Event)
    }
  ],
  "reverseChargebackEvents": [
    {
      object (Event)
    }
  ],
  "adjustmentEvents": [
    {
      object (Event)
    }
  ]
}
Felder
responseHeader

object (ResponseHeader)

REQUIRED: Allgemeiner Header für alle Antworten.

remittanceStatementSummary

object (RemittanceStatementSummary)

ERFORDERLICH: Zusammenfassung dieser Überweisungsabrechnung

eventOffset

integer

REQUIRED: Der Ereignis-Offset dieser Antwort.

nextEventOffset

integer

OPTIONAL: Der Offset des nächsten Ereignisses, das zurückgegeben werden soll Wenn keine Angabe erfolgt, sind keine weiteren Ereignisse für diese Anweisung abrufbar.

totalEvents

integer

REQUIRED: Gesamtzahl der Ereignisse in dieser Anweisung.

totalWithholdingTaxes

string (Int64Value format)

ERFORDERLICH: Die Summe aller für diese Abrechnung einbehaltenen Steuern.

Dieser Wert ist in Mikros angegeben.

captureEvents[]

object (Event)

ERFORDERLICH: Eine Reihe von Erfassungsereignissen

refundEvents[]

object (Event)

ERFORDERLICH: Gruppe von Erstattungsereignissen.

reverseRefundEvents[]

object (Event)

OPTIONAL: Reihe von Reverse-Erstattungsereignissen

chargebackEvents[]

object (Event)

OPTIONAL: Gruppe von Rückbuchungen.

reverseChargebackEvents[]

object (Event)

OPTIONAL: Satz von Reverse-Rückbuchungsereignissen

adjustmentEvents[]

object (Event)

OPTIONAL: Eine Reihe von Anpassungsereignissen Korrekturereignisse können nach Ermessen von Google hinzugefügt werden, um Abrechnungsdiskrepanzen auszugleichen. Wenn beispielsweise die Gebühren für eine Reihe von vorherigen Transaktionen zu wenig berechnet wurden, kann eine Korrektur verwendet werden, um den Integrationspartner zu vergrößern.

Überweisungsübersicht

Zusammenfassungsobjekt für eine Überweisung.

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

string (int64 format)

ERFORDERLICH: Das Datum, an dem diese Anweisung erstellt wurde (in Amerika/Los Angeles).

billingPeriod

object (BillingPeriod)

ERFORDERLICH: Der Abrechnungszeitraum, der in dieser Abrechnung enthalten ist.

dateDue

string (int64 format)

OPTIONAL: Datum, an dem die Überweisung fällig ist Dies wird in Millisekunden seit Epoche dargestellt. Es handelt sich dabei um ein Datum, das immer zur ersten Millisekunde des Tages in der Zeitzone der Abrechnung beginnt.

Dies wird festgelegt, solange totalDueByIntegrator größer als 0 ist.

currencyCode

string

ERFORDERLICH: Der dreistellige Währungscode nach ISO 4217.

totalDueByIntegrator

string (Int64Value format)

REQUIRED: Dieser Wert ist in Micros in der Währung currencyCode angegeben. Dieser Wert ist immer positiv.

remittanceInstructions

object (RemittanceInstructions)

ERFORDERLICH: Details zur Überweisung

Abrechnungszeitraum

Abrechnungszeitraum dieses Kontoauszugs

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

string (int64 format)

ERFORDERLICH: Das Startdatum des Abrechnungszeitraums. Dies wird in Millisekunden seit Epoche dargestellt. Es handelt sich dabei um ein Datum, das immer zur ersten Millisekunde des Tages in der Zeitzone der Abrechnung beginnt.

Das ist die erste Millisekunde des Tages im Abrechnungszeitraum, 00:00:00.000.

endDate

string (int64 format)

ERFORDERLICH: Das Enddatum des Abrechnungszeitraums. Dies wird in Millisekunden seit Epoche dargestellt.

Das ist die letzte Millisekunde des letzten Tages des Abrechnungszeitraums, 23:59:59.999

Überweisungsanleitung

Struktur der Holdinginformationen zur Zahlung dieser Überweisung.

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

string

ERFORDERLICH: Die Kennung, die für die Identifizierung von Zahlungen als Lastschriftmandat angegeben werden muss.

Veranstaltung

Struktur eines einzelnen Ereignisses, das in einer Überweisungsabrechnung enthalten ist.

JSON-Darstellung
{
  "eventRequestId": string,
  "paymentIntegratorEventId": string,
  "eventCharge": string,
  "eventFee": string,
  "presentmentChargeAmount": string,
  "presentmentCurrencyCode": string,
  "exchangeRate": string,
  "nanoExchangeRate": string
}
Felder
eventRequestId

string

ERFORDERLICH: Bei Ereignissen zur Erfassung oder Erstattung ist dies der requestId, den Google mit der Anfrage sendet. Bei Reverse-Rückbuchungen sowie Rückbuchungs- und Reverse-Rückbuchungsereignissen ist dies der requestId, den der Zahlungsintegrator zusammen mit der Benachrichtigung über dieses Ereignis sendet. Bei Anpassungen ist dies eine eindeutige ID, die Google dem Anpassungsereignis zugewiesen hat.

paymentIntegratorEventId

string

REQUIRED: ID, die der Zahlungsintegrator für dieses Ereignis zurückgegeben hat. Bei einer Aufnahme ist dies die paymentIntegratorTransactionId aus der Antwort auf einen capture-Aufruf, bei einer Erstattung ist dies die paymentIntegratorRefundId aus der Antwort auf einen refund-Aufruf.

Dieses Feld ist variabel, da die Integration für die ID steht, die Sie für dieses Ereignis angeben. Wenn der Integrator für das entsprechende Ereignis keinen Wert angegeben hat, enthält dieses Feld denselben Wert wie das Feld eventRequestId.

Bei Reverse-Rückbuchungen sowie Rückbuchungs- und Reverse-Rückbuchungsereignissen ist dies der requestId, den der Zahlungsintegrator zusammen mit der Benachrichtigung über das Ereignis gesendet hat.

Die Länge und das Format dieses Felds sind vom Quellfeld der jeweiligen ID abhängig. Weitere Informationen zu den Anforderungen an Länge und Zeichensatz finden Sie in der Dokumentation zu den einzelnen Quellfeldern. Beachten Sie insbesondere, dass dieses Feld manchmal von Google generierte IDs enthalten kann, die andere Anforderungen an die maximale Länge haben als von Integrations-IDs.

eventCharge

string (Int64Value format)

REQUIRED: in der Währung angegebener Währungscode Wenn dieser Wert negativ ist, stellt er einen Geldwert dar, der von Google zum Zahlungsintegrator verschoben wird. Wenn dies positiv ist, handelt es sich dabei um Geld des Zahlungsintegrators aufgrund von Google.

Erfasste Transaktionen sind beispielsweise immer positiv und Erstattungen sind immer negativ. Ereignisse mit umgekehrter Erstattung und umgekehrter Rückbuchungen sind immer positiv. Ereignisse für Rückbuchungen sind immer negativ.

Dieser Wert ist in Mikros angegeben.

eventFee

string (Int64Value format)

REQUIRED: in der Währung angegebener Währungscode Wenn dieser Wert negativ ist, stellt er einen Geldwert dar, der von Google zum Zahlungsintegrator verschoben wird. Wenn dies positiv ist, handelt es sich dabei um Geld des Zahlungsintegrators aufgrund von Google.

Wenn beispielsweise in einer Vereinbarung angegeben ist, dass Google 1% des Betrags von transactionCharge an den Zahlungsintegrator sendet und dieser Betrag bei der Erstattung um 1% zurückerstattet wird, ist die Erfassungsgebühr negativ und nach der Erstattung ist die Erstattungsgebühr positiv.

Dieser Wert ist in Mikros angegeben.

presentmentChargeAmount

string (Int64Value format)

OPTIONAL: Transaktionsbetrag in der aktuellen Währung vor der Devise Dieses Feld folgt derselben Zeichenkonvention wie das Feld eventCharge.

Dieser Wert ist in Mikros angegeben.

presentmentCurrencyCode

string

OPTIONAL: Der aus drei Buchstaben bestehende Währungscode nach ISO 4217 für die Währung der aktuellen Transaktion (Transaktion).

exchangeRate

string (Int64Value format)

OPTIONAL: Der Wechselkurs, der für die Umrechnung des aktuellen Betrags in den Abrechnungsbetrag (Rechnungsbetrag) verwendet wurde

Dieser Wert liegt in Mikro-Basispunkten (1 Basispunkt = 0,0001 = 0,01%). Um den Wechselkurs zu erhalten, müssen Sie dieses Feld durch 10^10 dividieren.

nanoExchangeRate

string (Int64Value format)

OPTIONAL: Der Wechselkurs, der beim Umrechnen des aktuellen Betrags in den Abrechnungsbetrag (Rechnungsbetrag) verwendet wurde, ausgedrückt in Nanobasispunkten

Dieser Wert liegt in Nano-Basispunkten (1 Basispunkt = 0,0001 = 0,01%). Um den Wechselkurs zu erhalten, müssen Sie dieses Feld durch 10^13 dividieren.

Sowohl dieses Feld als auch „exchangeRate“ werden ausgefüllt. Sie sind äquivalente Wechselkurse mit unterschiedlicher Accuracy. In zukünftigen Versionen wird ExchangeRate zugunsten von nanoExchangeRate entfernt.