Method: remittanceStatementDetails

Gibt Transaktionsdetails zu einer Überweisungsabrechnung zurück.

Dies ist eine paginierte API. Die Anzahl der Transaktionsereignisse pro Seite kann mit numberOfEvents angegeben werden. Wenn nicht angegeben, werden maximal 1.000 Ereignisse pro Seite zurückgegeben. Bei jeder Anfrage an diese API wird ein nextEventOffset zurückgegeben, der auf das nächste Transaktionsereignis im Kontoauszug verweist, sowie totalEvents, das die Gesamtzahl der Transaktionen im Kontoauszug angibt. Wenn die aktuell abgerufene Seite die letzten Transaktionen des Kontoauszugs enthält, ist nextEventOffset nicht in der Antwort enthalten.

Der Wert statementId ist der requestId aus remittanceStatementNotificationRequest.

Wenn beim Verarbeiten der Anfrage ein Fehler auftritt, ist die Antwort von diesem Endpunkt vom Typ ErrorResponse.

Antworten auf diese Anfrage können leer sein, wenn diese Methode keinen HTTP-200-Statuscode zurückgibt. Der Antworttext ist leer, wenn ein ErrorResponse mit einer klaren Beschreibung verwendet werden könnte, um einem Angreifer die Konto-ID des Zahlungsdienstleisters anderer Dienstleister zu zeigen. In diesen Fällen, in denen entweder der Signierschlüssel nicht übereinstimmt, die Zahlungsdienstleister-ID nicht gefunden wurde oder der Verschlüsselungsschlüssel unbekannt war, gibt diese Methode einen HTTP-404-Fehler mit einem leeren Body zurück. Wenn die Anfragesignatur überprüft werden konnte, werden im Antworttext zusätzliche Informationen zum Fehler 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)

ERFORDERLICH: Gemeinsamer Header für alle Anfragen.

paymentIntegratorAccountId

string

ERFORDERLICH: Dies ist die Konto-ID des Zahlungsdienstleisters, mit der vertragliche Einschränkungen in Bezug auf diese Erklärung identifiziert werden.

statementId

string

ERFORDERLICH: Anfrage-ID der Abrechnungsbenachrichtigung.

eventOffset

integer

OPTIONAL: Gibt Rückgabeereignisse zurück, die ab diesem Offset beginnen. Dieser Wert sollte auf nextEventOffset festgelegt werden, wenn einer zurückgegeben wurde. Wenn es sich um die erste Anfrage handelt, sollte er nicht angegeben werden. Wenn eventOffset null ist, werden Ereignisse ab dem ersten Ereignis zurückgegeben. Wenn dieser Wert „2“ ist, werden Ereignisse ab dem dritten Ereignis zurückgegeben. Wenn nicht angegeben, wird eventOffset als null angenommen.

numberOfEvents

integer

OPTIONAL: Anzahl der Ereignisse, die pro Seite angezeigt werden sollen. Wenn nicht angegeben oder größer als 1.000, wird der Wert auf 1.000 gesetzt.

Antworttext

Antwortobjekt für die Methode „remittance statement detail“.

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)

ERFORDERLICH: Gemeinsamer Header für alle Antworten.

remittanceStatementSummary

object (RemittanceStatementSummary)

ERFORDERLICH: Zusammenfassung dieser Überweisungsabrechnung.

eventOffset

integer

ERFORDERLICH: Der Ereignis-Offset dieser Antwort.

nextEventOffset

integer

OPTIONAL: Der Offset des nächsten zurückzugebenden Ereignisses. Wenn nicht angegeben, sind für diese Anweisung keine weiteren Ereignisse abzurufen.

totalEvents

integer

ERFORDERLICH: Gesamtzahl der Ereignisse in dieser Erklärung.

totalWithholdingTaxes

string (Int64Value format)

ERFORDERLICH: Die Summe aller Steuern, die für diese Abrechnung einbehalten wurden.

Dieser Wert wird in Mikrosekunden angegeben.

captureEvents[]

object (Event)

ERFORDERLICH: Eine Reihe von Erfassungsereignissen.

refundEvents[]

object (Event)

ERFORDERLICH: Eine Reihe von Erstattungsereignissen.

reverseRefundEvents[]

object (Event)

OPTIONAL: Eine Reihe von Ereignissen für die Rückerstattung.

chargebackEvents[]

object (Event)

OPTIONAL: Eine Reihe von Rückbuchungsereignissen.

reverseChargebackEvents[]

object (Event)

OPTIONAL: Eine Reihe von Reverse-Chargeback-Ereignissen.

adjustmentEvents[]

object (Event)

OPTIONAL: Eine Reihe von Anpassungsereignissen. Anpassungsereignisse können nach Ermessen von Google hinzugefügt werden, um Abrechnungsabweichungen auszugleichen. Wenn beispielsweise Gebühren für eine Reihe früherer Transaktionen zu niedrig berechnet wurden, kann eine Anpassung verwendet werden, um den Integrator zu entschädigen.

RemittanceStatementSummary

Zusammenfassungsobjekt für eine Überweisungsabrechnung.

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

string (int64 format)

ERFORDERLICH: Das Datum (in America/Los Angeles), an dem diese Erklärung erstellt wurde.

billingPeriod

object (BillingPeriod)

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

dateDue

string (int64 format)

OPTIONAL: Das Datum, an dem die Überweisung fällig ist. Dies wird als Millisekunden seit der Epoche dargestellt. Es ist ein Datum und beginnt daher immer in der Abrechnungszeitzone um 00:00:00.000.

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

currencyCode

string

ERFORDERLICH: ISO 4217-Währungscode mit 3 Buchstaben.

totalDueByIntegrator

string (Int64Value format)

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

remittanceInstructions

object (RemittanceInstructions)

ERFORDERLICH: Details zur Zahlung

BillingPeriod

Abrechnungszeitraum dieser Abrechnung.

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

string (int64 format)

ERFORDERLICH: Das Startdatum des Abrechnungszeitraums. Dies wird als Millisekunden seit der Epoche dargestellt. Es ist ein Datum und beginnt daher immer in der Abrechnungszeitzone um 00:00:00.000.

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

endDate

string (int64 format)

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

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

RemittanceInstructions

Struktur mit Informationen zur Zahlung dieser Überweisungsbenachrichtigung.

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

string

ERFORDERLICH: Kennung, die für die Überweisung zur Identifizierung der Überweisung in der Vermerkzeile angegeben werden muss.

Ereignis

Eine Struktur, die ein einzelnes Ereignis in einer Überweisungsabrechnung darstellt.

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

string

ERFORDERLICH: Bei Erfassungs- oder Erstattungsereignissen ist dies die requestId, die Google mit der Anfrage sendet. Bei Ereignissen für Rückerstattung, Rückbuchung und Rückbuchungs-Storno ist dies die requestId, die der Zahlungsdienstleister mit der Benachrichtigung über dieses Ereignis sendet. Bei Anpassungen ist das eine eindeutige ID, die von Google dem Anpassungsereignis zugewiesen wird.

paymentIntegratorEventId

string

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

Dieses Feld hat eine variable Länge, da hier die ID angegeben wird, die Sie als Integrator für dieses Ereignis bereitstellen. Wenn für das entsprechende Ereignis kein Wert vom Integrator angegeben wurde, enthält dieses Feld denselben Wert wie das Feld eventRequestId.

Bei Ereignissen für Rückerstattung, Rückbuchung und Rückbuchungs-Storno ist dies die requestId, die der Zahlungsdienstleister mit der Benachrichtigung über das Ereignis gesendet hat.

Die Länge und das Format dieses Felds hängen vom Quellfeld für die jeweilige ID ab. 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, für die möglicherweise andere maximale Längen gelten als für von Integratoren generierte IDs.

eventCharge

string (Int64Value format)

ERFORDERLICH: Im Währungscode, der im Kontoauszug definiert ist. Wenn dieser Wert negativ ist, wird der Geldwert von Google an den Zahlungsdienstleister übertragen. Wenn dieser Wert positiv ist, handelt es sich um Geld, das der Zahlungsdienstleister Google schuldet.

Erfassungs-Transaktionen sind beispielsweise immer positiv und Erstattungs-Transaktionen immer negativ. Ereignisse für die Rückerstattung und Rückbuchungs-Storno sind immer positiv. Rückbuchungsereignisse sind immer negativ.

Dieser Wert wird in Mikrosekunden angegeben.

eventFee

string (Int64Value format)

ERFORDERLICH: Im Währungscode, der im Kontoauszug definiert ist. Wenn dieser Wert negativ ist, wird der Geldwert von Google an den Zahlungsdienstleister übertragen. Wenn dieser Wert positiv ist, handelt es sich um Geld, das der Zahlungsdienstleister Google schuldet.

Wenn in einer Vereinbarung beispielsweise festgelegt ist, dass Google 1% von transactionCharge an den Zahlungsdienstleister zahlt und diese 1% bei einer Erstattung der Transaktion zurückerstattet werden, ist die Erfassungsgebühr negativ und die Erstattungsgebühr bei einer Erstattung positiv.

Dieser Wert wird in Mikrosekunden angegeben.

presentmentChargeAmount

string (Int64Value format)

OPTIONAL: Transaktionsbetrag in der Währung der Darstellung (auch als Transaktionswährung bezeichnet) vor dem Währungstausch. Für dieses Feld gilt dieselbe Vorzeichenkonvention wie für das Feld eventCharge.

Dieser Wert wird in Mikrosekunden angegeben.

presentmentCurrencyCode

string

OPTIONAL: Der dreistellige ISO 4217-Währungscode für die Währung der Darstellung (Transaktion).

exchangeRate
(deprecated)

string (Int64Value format)

VERALTET: Der Wechselkurs, der bei der Umrechnung des Betrags für die Darstellung in den Abrechnungsbetrag (Rechnungsbetrag) verwendet wurde.

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

nanoExchangeRate

string (Int64Value format)

OPTIONAL: Der Wechselkurs, der bei der Umrechnung des Betrags für die Darstellung in den Abrechnungsbetrag (Rechnungsbetrag) verwendet wird, ausgedrückt in Nanobasispunkten.

Dieser Wert wird in Nanobasispunkten angegeben (1 Basispunkt = 0,0001 = 0,01%). Um den Wechselkurs zu erhalten, müssen Sie dieses Feld also durch 10^13 dividieren.

Sowohl dieses Feld als auch „exchangeRate“ werden ausgefüllt. Es handelt sich um gleichwertige Wechselkurse, die mit unterschiedlicher Genauigkeit angegeben werden. In zukünftigen Versionen wird „exchangeRate“ zugunsten von „nanoExchangeRate“ entfernt.