Method: remittanceStatementDetails

Gibt Transaktionsdetailinformationen zu einer Überweisungsanweisung zurück.

Dies ist eine API mit Seitenzahlen. Die Anzahl der Transaktionsereignisse pro Seite kann mit numberOfEvents angegeben werden. Wenn Sie nichts angeben, werden pro Seite maximal 1.000 Ereignisse zurückgegeben. Bei jeder Anfrage an diese API werden ein nextEventOffset zurückgegeben, das auf das nächste Transaktionsereignis in der Abrechnung verweist, sowie totalEvents, die die Gesamtzahl der Transaktionen in der Abrechnung angeben. Wenn die aktuell abgerufene Seite die letzten Transaktionen der Abrechnung enthält, ist nextEventOffset nicht in der Antwort vorhanden.

Der Wert von statementId ist der requestId aus remittanceStatementNotificationRequest

Wenn am Endpunkt bei der Verarbeitung der Anfrage ein Fehler auftritt, ist die Antwort dieses Endpunkts vom Typ ErrorResponse.

Die Antworten auf diese Abfrage sind möglicherweise leer, wenn diese Methode keinen HTTP 200-Fehler zurückgibt. Der Antworttext ist leer, wenn ein ErrorResponse mit einer eindeutigen Beschreibung verwendet werden könnte, um einem Angreifer zu helfen, die Kennung des Zahlungsintegrators anderer Integratoren zu verstehen. In Situationen, in denen der Signaturschlüssel nicht übereinstimmt, die Zahlungsintegrator-ID nicht gefunden wurde oder der Verschlüsselungsschlüssel unbekannt war, gibt diese Methode einen HTTP 404-Fehler mit einem leeren Text zurück. Wenn die Anfragesignatur verifiziert 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 Zahlungsintegrators, die vertragliche Einschränkungen für diese Anweisung angibt.

statementId

string

ERFORDERLICH: Anfrage-ID der Benachrichtigung über den Kontoauszug.

eventOffset

integer

OPTIONAL: Gibt Ereignisse zurück, die bei diesem Offset beginnen. Dies sollte auf nextEventOffset gesetzt werden, wenn eine zurückgegeben wurde, oder nicht angegeben, wenn dies die erste Anfrage ist. Wenn eventOffset null ist, werden Ereignisse beginnend mit dem ersten Ereignis zurückgegeben. Falls es sich um zwei handelt, werden Ereignisse beginnend mit dem dritten Ereignis zurückgegeben. Wenn keine Angabe erfolgt, wird für eventOffset angenommen, dass sie null ist.

numberOfEvents

integer

OPTIONAL: Anzahl der Ereignisse, die pro Seite angezeigt werden sollen. Wenn nicht angegeben oder größer als 1.000, ist dies 1.000.

Antworttext

Antwortobjekt für die Methode mit Details zur Ü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)

ERFORDERLICH: Gemeinsamer Header für alle Antworten.

remittanceStatementSummary

object (RemittanceStatementSummary)

ERFORDERLICH: Zusammenfassung dieses Überweisungsauftrags.

eventOffset

integer

ERFORDERLICH: Der Ereignisversatz der Antwort.

nextEventOffset

integer

OPTIONAL: Der Versatz des nächsten Ereignisses, das zurückgegeben werden soll. Wenn kein Wert angegeben ist, können für diese Anweisung keine weiteren Ereignisse abgerufen werden.

totalEvents

integer

ERFORDERLICH: Gesamtzahl der Ereignisse in dieser Anweisung.

totalWithholdingTaxes

string (Int64Value format)

ERFORDERLICH: Die Summe aller für diesen Kontoauszug einbehaltenen Steuern.

Dieser Wert wird in micros angegeben.

captureEvents[]

object (Event)

ERFORDERLICH: Reihe von Erfassungsereignissen.

refundEvents[]

object (Event)

ERFORDERLICH: Reihe von Erstattungsereignissen.

reverseRefundEvents[]

object (Event)

OPTIONAL: Gruppe von Ereignissen für umgekehrte Erstattungen.

chargebackEvents[]

object (Event)

OPTIONAL: Gruppe von Rückbuchungsereignissen.

reverseChargebackEvents[]

object (Event)

OPTIONAL: Gruppe von Ereignissen für umgekehrte Rückbuchungen.

adjustmentEvents[]

object (Event)

OPTIONAL: Gruppe von Anpassungsereignissen. Google kann nach eigenem Ermessen Anpassungsereignisse hinzufügen, um Abrechnungsdiskrepanzen auszugleichen. Wenn beispielsweise die Gebühren für eine Reihe früherer Transaktionen zu niedrig berechnet wurden, kann eine Anpassung verwendet werden, um den Integrator zu kompensieren.

RemittanceStatementSummary

Zusammenfassungsobjekt zu einem Überweisungsbescheid.

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

string (int64 format)

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

billingPeriod

object (BillingPeriod)

ERFORDERLICH: Der Abrechnungszeitraum, der sich auf diesen Abrechnungszeitraum bezieht.

dateDue

string (int64 format)

OPTIONAL: Das Datum, an dem die Überweisung fällig ist. Dies wird als Millisekunden ab Epoche angegeben. Es handelt sich um ein Datum und beginnt daher immer zur ersten Millisekunde des Tages in der Abrechnungszeitzone.

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

currencyCode

string

ERFORDERLICH: Der dreistellige Währungscode gemäß ISO 4217.

totalDueByIntegrator

string (Int64Value format)

ERFORDERLICH: Dieser Wert wird in „micros“, Mikros und in der Währung currencyCode angegeben. Dieser Wert ist immer positiv.

remittanceInstructions

object (RemittanceInstructions)

ERFORDERLICH: Hier erhalten Sie detaillierte Informationen zur Überweisung.

BillingPeriod

Abrechnungszeitraum dieses Kontoauszugs.

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

string (int64 format)

ERFORDERLICH: Das Startdatum des Abrechnungszeitraums. Dies wird als Millisekunden ab Epoche angegeben. Es handelt sich um ein Datum und beginnt daher immer zur ersten Millisekunde des Tages in der Abrechnungszeitzone.

Dies 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 ab Epoche angegeben.

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

RemittanceInstructions

Struktur, die Informationen zur Zahlung dieser Überweisungsbenachrichtigung enthält.

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

string

ERFORDERLICH: Kennzeichnung, die in der Gutschriftzeile für die Zahlung zur Identifikationsnummer angegeben werden muss.

Ereignis

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 rückseitigen Rückerstattungen, Rückbuchungen und umgekehrten Rückbuchungen ist dies die requestId, die der Zahlungsintegrator mit der Benachrichtigung über dieses Ereignis sendet. Bei Anpassungen ist dies eine eindeutige ID, die Google dem Anpassungsereignis zugewiesen hat.

paymentIntegratorEventId

string

ERFORDERLICH: ID, die der Zahlungsintegrator für dieses Ereignis zurückgegeben hat. Für eine Aufnahme ist dies das paymentIntegratorTransactionId aus der Antwort auf einen capture-Aufruf, im Falle einer Erstattung die paymentIntegratorRefundId aus der Antwort auf einen refund-Aufruf.

Die Länge dieses Felds ist variabel. Als Integrator wird die ID, die Sie für dieses Ereignis angeben, hier angegeben. Wenn der Integrator für das entsprechende Ereignis keinen Wert angegeben hat, enthält dieses Feld denselben Wert wie das Feld eventRequestId.

Bei rückseitigen Rückerstattungen, Rückbuchungen und umgekehrten Rückbuchungen ist dies die requestId, die der Zahlungsintegrator mit der Benachrichtigung über das Ereignis gesendet hat.

Die Länge und das Format dieses Feldes 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 andere Anforderungen an die maximale Länge gelten als für vom Integrator generierte IDs.

eventCharge

string (Int64Value format)

ERFORDERLICH: wird im Währungscode angegeben, der in der Anweisung definiert wurde. Wenn dieser Wert negativ ist, steht er für einen Geldwert, der von Google an den Zahlungsintegrator gesendet wird. Wenn dieser Wert positiv ist, erhält Google Geld vom Zahlungsintegrator.

So sind beispielsweise erfasste Transaktionen immer positiv und Erstattungstransaktionen immer negativ. Umgekehrte Rückerstattungen und umgekehrte Rückbuchungen sind immer positiv. Rückbuchungsereignisse sind immer negativ.

Dieser Wert wird in micros angegeben.

eventFee

string (Int64Value format)

ERFORDERLICH: wird im Währungscode angegeben, der in der Anweisung definiert wurde. Wenn dieser Wert negativ ist, steht er für einen Geldwert, der von Google an den Zahlungsintegrator gesendet wird. Wenn dieser Wert positiv ist, erhält Google Geld vom Zahlungsintegrator.

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

Dieser Wert wird in micros angegeben.

presentmentChargeAmount

string (Int64Value format)

OPTIONAL: Transaktionsbetrag in Präsentationswährung vor dem Wechselkurs. Für dieses Feld gilt dieselbe Vorzeichenkonvention wie für das Feld eventCharge.

Dieser Wert wird in micros angegeben.

presentmentCurrencyCode

string

OPTIONAL: Dreistelliger Währungscode gemäß ISO 4217, der die Währung des aktuellen Betrags (Transaktionswährung) angibt.

exchangeRate

string (Int64Value format)

OPTIONAL: Wechselkurs, der zur Umrechnung des Anzeigebetrags in den Abrechnungsbetrag (Rechnungsbetrag) verwendet wird.

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

nanoExchangeRate

string (Int64Value format)

OPTIONAL: Wechselkurs, der zur Umrechnung des Umrechnungsbetrags in den Abrechnungsbetrag (Rechnungsbetrag) verwendet wird, ausgedrückt in Nano-Basispunkten.

Dieser Wert wird in nano-Basispunkten angegeben (1 Basispunkt = 0,0001 = 0,01%). Teilen Sie also dieses Feld durch 10^13, um den Wechselkurs zu erhalten.

Sowohl dieses Feld als auch „wechselkurs“ werden ausgefüllt. Sie sind gleichwertige Wechselkurse, die unterschiedlich genau angegeben sind. In zukünftigen Versionen wird „wechselkurs“ zugunsten von „nanoExchangeRate“ entfernt.