Method: remittanceStatementDetails

Zwraca informacje o szczegółach transakcji dotyczące wyciągu.

To jest interfejs API podzielony na strony. Liczbę zdarzeń transakcji na stronę można określić za pomocą numberOfEvents. Jeśli nie określono inaczej, na stronie będzie zwracanych maksymalnie 1000 zdarzeń. Każde żądanie tego interfejsu API zwróci kod nextEventOffset wskazujący następne zdarzenie transakcji w wyciągu oraz totalEvents z łączną liczbą transakcji w wyciągu. Jeśli pobrana aktualnie strona zawiera ostatnie transakcje z wyciągu, w odpowiedzi nie będzie tagu nextEventOffset.

Wartość statementId to requestId z parametru remittanceStatementNotificationRequest

Jeśli podczas przetwarzania żądania punkt końcowy napotka błąd, odpowiedź z tego punktu końcowego będzie typu ErrorResponse.

Jeśli ta metoda nie zwraca kodu HTTP 200, odpowiedzi na to zapytanie mogą być puste. Treść odpowiedzi jest pusta w sytuacjach, gdy można wykorzystać pole ErrorResponse z jasnym opisem, aby ułatwić osobie przeprowadzającej atak rozpoznanie identyfikatora konta integratora płatności innych integratorów. W takich sytuacjach, gdy klucz podpisywania nie pasuje, nie znaleziono identyfikatora integratora płatności lub klucz szyfrowania jest nieznany, ta metoda zwróci błąd HTTP 404 z pustą treścią. Jeśli podpis żądania można zweryfikować, dodatkowe informacje dotyczące błędu zostaną zwrócone w treści odpowiedzi.

Przykładowe żądanie wygląda tak:


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

Przykładowa odpowiedź wygląda tak:


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

Żądanie HTTP

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

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "statementId": string,
  "eventOffset": integer,
  "numberOfEvents": integer
}
Pola
requestHeader

object (RequestHeader)

WYMAGANE: wspólny nagłówek dla wszystkich żądań.

paymentIntegratorAccountId

string

WYMAGANE: identyfikator konta integratora płatności określa ograniczenia umowne związane z tym wyciągiem.

statementId

string

WYMAGANE: identyfikator żądania powiadomienia o wyciągu.

eventOffset

integer

OPCJONALNIE: zwraca zdarzenia zaczynające się od tego przesunięcia. Należy ustawić wartość nextEventOffset, jeśli żądanie zostało zwrócone, lub być nieokreślone, jeśli jest to pierwsze żądanie. Jeśli eventOffset ma wartość 0, wydarzenia będą zwracane od pierwszego. Jeśli jest to 2, wydarzenia będą zwracane od trzeciego. Jeśli wartość nie została określona, przyjmuje się, że pole eventOffset ma wartość 0.

.

numberOfEvents

integer

OPCJONALNIE: liczba zdarzeń do wyświetlenia na stronę. Jeśli wartość nie jest określona lub większa niż 1000, zobaczysz 1000.

Treść odpowiedzi

Obiekt odpowiedzi dla metody szczegółów wyciągu.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "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)
    }
  ]
}
Pola
responseHeader

object (ResponseHeader)

WYMAGANE: wspólny nagłówek wszystkich odpowiedzi.

remittanceStatementSummary

object (RemittanceStatementSummary)

WYMAGANE: podsumowanie tego rachunku.

eventOffset

integer

WYMAGANE: przesunięcie zdarzenia dla tej odpowiedzi.

nextEventOffset

integer

OPCJONALNIE: przesunięcie następnego zdarzenia do zwrócenia. Jeśli nie określono więcej zdarzeń, nie będzie więcej zdarzeń do pobrania dla tej instrukcji.

totalEvents

integer

WYMAGANE: łączna liczba zdarzeń w tym wyciągu.

totalWithholdingTaxes

string (Int64Value format)

WYMAGANE: suma wszystkich podatków pobranych u źródła w przypadku tego wyciągu.

Ta wartość jest podana w parametrze micros.

captureEvents[]

object (Event)

WYMAGANE: zbiór zdarzeń przechwytywania.

refundEvents[]

object (Event)

WYMAGANE: zbiór zdarzeń refund.

reverseRefundEvents[]

object (Event)

OPCJONALNIE: zestaw zdarzeń cofania zwrotu.

chargebackEvents[]

object (Event)

OPCJONALNIE: zbiór zdarzeń obciążenia zwrotnego.

reverseChargebackEvents[]

object (Event)

OPCJONALNE: zbiór zdarzeń odwrotnego obciążenia zwrotnego.

adjustmentEvents[]

object (Event)

OPCJONALNE: zbiór zdarzeń korekty. Google może według własnego uznania dodawać zdarzenia korygujące w celu uzgodnienia rozbieżności w rozliczeniach. Na przykład, jeśli opłaty za wcześniejsze transakcje zostały obliczone za niskie, można użyć korekty, aby uzupełnić integratora.

RemittanceStatementSummary

Obiekt podsumowania dotyczący wyciągu.

Zapis JSON
{
  "statementDate": string,
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": string,
  "currencyCode": string,
  "totalDueByIntegrator": string,
  "remittanceInstructions": {
    object (RemittanceInstructions)
  }
}
Pola
statementDate

string (int64 format)

WYMAGANE: data (w Ameryce/Los Angeles) utworzenia tego oświadczenia.

billingPeriod

object (BillingPeriod)

WYMAGANE: okres rozliczeniowy uwzględniony na tym wyciągu.

dateDue

string (int64 format)

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 totalDueByIntegrator ma wartość większą niż 0.

currencyCode

string

WYMAGANE: trzyliterowy kod waluty w standardzie ISO 4217,

totalDueByIntegrator

string (Int64Value format)

WYMAGANE: ta wartość jest wyrażona w mikro i walucie currencyCode. Ta wartość jest zawsze dodatnia.

remittanceInstructions

object (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

string (int64 format)

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

string (int64 format)

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

string

WYMAGANE: identyfikator, który należy umieścić w notatce, aby dokonać płatności.

Zdarzenie

Struktura reprezentująca pojedyncze zdarzenie uwzględnione w rachunku przelewu.

Zapis JSON
{
  "eventRequestId": string,
  "paymentIntegratorEventId": string,
  "eventCharge": string,
  "eventFee": string,
  "presentmentChargeAmount": string,
  "presentmentCurrencyCode": string,
  "exchangeRate": string,
  "nanoExchangeRate": string
}
Pola
eventRequestId

string

WYMAGANE: w przypadku zdarzeń przechwytywania lub zwrotu środków będzie to requestId wysyłany przez Google z żądaniem. W przypadku zdarzeń dotyczących zwrotu środków, obciążenia zwrotnego i odwrotnego obciążenia zwrotnego jest to wartość requestId wysłana przez integratora płatności z powiadomieniem o tym zdarzeniu. W przypadku korekt będzie to unikalny identyfikator przypisany przez Google do zdarzenia korekty.

paymentIntegratorEventId

string

WYMAGANE: określ, jaki integrator płatności zwrócił to zdarzenie. W przypadku zapisu jest to paymentIntegratorTransactionId z odpowiedzi na wywołanie capture. Jeśli chodzi o zwrot środków, jest to paymentIntegratorRefundId z odpowiedzi na wywołanie refund.

To pole ma zmienną długość. Będzie on widoczny w tym miejscu jako identyfikator podany przez Ciebie dla tego zdarzenia przez integratora. Jeśli integrator nie podał wartości dla odpowiedniego zdarzenia, to pole będzie zawierać tę samą wartość co pole eventRequestId.

W przypadku zdarzeń wycofania zwrotu środków, obciążenia zwrotnego i obciążeń zwrotnych jest to requestId wysłana przez integratora płatności z powiadomieniem o zdarzeniu.

Długość i format tego pola zależy od pola źródłowego każdego identyfikatora. Szczegółowe informacje o wymaganiach dotyczących długości i zestawu znaków znajdziesz w dokumentacji poszczególnych pól źródłowych. W szczególności pamiętaj, że to pole może czasami zawierać identyfikatory wygenerowane przez Google, które mogą mieć inne wymagania dotyczące maksymalnej długości niż identyfikatory wygenerowane przez integratora.

eventCharge

string (Int64Value format)

WYMAGANE: w kodzie waluty zdefiniowanym w wyciągu. Jeśli ta wartość jest ujemna, jest to wartość pieniężna przeniesiona z Google do integratora płatności. Jeśli wynik będzie pozytywny, to pieniądze od integratora płatności na rzecz Google.

Na przykład transakcje przechwytywania zawsze będą dodatnie, a zwroty środków będą zawsze ujemne. Zdarzenia cofania zwrotu środków i odwrotnego obciążenia zwrotnego zawsze będą miały wartość dodatnią. Obciążenia zwrotne będą zawsze miały wartość ujemną.

Ta wartość jest podana w parametrze micros.

eventFee

string (Int64Value format)

WYMAGANE: w kodzie waluty zdefiniowanym w wyciągu. Jeśli ta wartość jest ujemna, jest to wartość pieniężna przeniesiona z Google do integratora płatności. Jeśli wynik będzie pozytywny, to pieniądze od integratora płatności na rzecz Google.

Jeśli na przykład umowa stanowi, że Google przekaże integratorowi płatności 1% kwoty transactionCharge i cofnie tę kwotę po zwróceniu tej transakcji, opłata za pobranie będzie ujemna, a po zwrocie opłata za zwrot będzie dodatnia.

Ta wartość jest podana w parametrze micros.

presentmentChargeAmount

string (Int64Value format)

OPCJONALNIE: kwota transakcji w walucie bieżącej (czyli transakcji) przed wymianą walut. To pole jest zgodne z tą samą konwencją znaków co pole eventCharge.

Ta wartość jest podana w parametrze micros.

presentmentCurrencyCode

string

OPCJONALNIE: 3-literowy kod waluty w formacie ISO 4217 określający walutę prezentacji (transakcji).

exchangeRate

string (Int64Value format)

OPCJONALNIE: kurs wymiany użyty do przeliczenia kwoty prezentu na kwotę rozliczenia (fakturę).

Wartość jest podawana w mikropunktach bazowych (1 punkt podstawy = 0,0001 = 0,01%). Aby uzyskać kurs wymiany, podziel to pole przez 10^10.

nanoExchangeRate

string (Int64Value format)

OPCJONALNIE: kurs wymiany użyty do przeliczenia kwoty prezentu na kwotę rozliczenia (fakturę) wyrażoną w nanopunktach bazowych.

Wartość jest podawana w punktach bazowych nano (1 punkt podstawy = 0,0001 = 0,01%). Aby uzyskać kurs wymiany, podziel to pole przez 10^13.

Zarówno to pole, jak i ExchangeRate zostaną wypełnione. Są to równoważne kursy wymiany wyrażone z różną precyzją. W przyszłych wersjach parametr ExchangeRate zostanie usunięty i zastąpiony wartością nanoExchangeRate.