Method: remittanceStatementDetails

Restituisce informazioni sui dettagli della transazione su un estratto conto.

Questa è un'API impaginata. Il numero di eventi di transazione per pagina può essere specificato con numberOfEvents. Se non specificato, verrà restituito il massimo di 1000 eventi per pagina. Ogni richiesta a questa API restituirà un nextEventOffset che rimanda all'evento di transazione successivo nell'estratto conto, oltre a totalEvents che specifica il numero totale di transazioni nell'estratto conto. Se la pagina recuperata corrente contiene le ultime transazioni dell'istruzione, nextEventOffset non sarà presente nella risposta.

Il valore statementId è requestId del valore di remittanceStatementNotificationRequest

Se l'endpoint rileva un errore durante l'elaborazione della richiesta, la risposta da questo endpoint sarà di tipo ErrorResponse.

Le risposte a questa query potrebbero essere vuote se questo metodo non restituisce un HTTP 200. Il corpo della risposta è vuoto nelle situazioni in cui è possibile utilizzare un ErrorResponse con una descrizione chiara per aiutare un utente malintenzionato a comprendere l'identificatore dell'account dell'integratore dei pagamenti di altri integratori. In queste situazioni, in cui la chiave di firma non corrisponde, l'identificatore dell'integratore dei pagamenti non è stato trovato o la chiave di crittografia non era nota, questo metodo restituirà un errore HTTP 404 con un corpo vuoto. Se è possibile verificare la firma della richiesta, nel corpo della risposta verranno restituite informazioni aggiuntive sull'errore.

Una richiesta di esempio ha il seguente aspetto:


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

Ecco un esempio di risposta:


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

Richiesta HTTP

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

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

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

object (RequestHeader)

REQUIRED: intestazione comune per tutte le richieste.
paymentIntegratorAccountId

string

REQUIRED: questo è l'identificatore dell'account dell'integratore dei pagamenti che identifica i vincoli contrattuali relativi a questa affermazione.
statementId

string

OBBLIGATORIO: ID richiesta della notifica dell'estratto conto.
eventOffset

integer

FACOLTATIVO: restituisce gli eventi che iniziano da questo offset. Deve essere impostato su nextEventOffset se una è stata restituita o non è stata specificata se si tratta della prima richiesta. Se eventOffset è pari a zero, verranno restituiti eventi a partire dal primo evento. Se è pari a due, verranno restituiti eventi a partire dal terzo evento. Se non viene specificato, si presume che il valore di eventOffset sia zero.

numberOfEvents

integer

FACOLTATIVO: numero di eventi da mostrare per pagina. Se non specificato o maggiore di 1000, il valore sarà 1000.

Corpo della risposta

Oggetto della risposta per il metodo dei dettagli della dichiarazione di versamento.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione 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)
    }
  ]
}
Campi
responseHeader

object (ResponseHeader)

REQUIRED: intestazione comune per tutte le risposte.
remittanceStatementSummary

object (RemittanceStatementSummary)

OBBLIGATORIO: riepilogo di questa dichiarazione di pagamento.
eventOffset

integer

REQUIRED: l'offset dell'evento di questa risposta.
nextEventOffset

integer

FACOLTATIVO: l'offset dell'evento successivo da restituire. Se il criterio non è specificato, non sono presenti altri eventi da recuperare per questa istruzione.
totalEvents

integer

REQUIRED: numero totale di eventi in questo estratto conto.
totalWithholdingTaxes

string (Int64Value format)

OBBLIGATORIO: la somma di tutte le imposte trattenute per questo estratto conto.

Questo valore è espresso in micro.
captureEvents[]

object (Event)

OBBLIGATORIO: insieme di eventi di acquisizione.
refundEvents[]

object (Event)

REQUIRED: insieme di eventi di rimborso.
reverseRefundEvents[]

object (Event)

FACOLTATIVO: insieme di eventi di rimborso inverso.
chargebackEvents[]

object (Event)

FACOLTATIVO: insieme di eventi di storno di addebito.
reverseChargebackEvents[]

object (Event)

FACOLTATIVO: insieme di eventi di storno di addebito.
adjustmentEvents[]

object (Event)

FACOLTATIVO: insieme di eventi di aggiustamento. Gli eventi di aggiustamento possono essere aggiunti a discrezione di Google per riconciliare le discrepanze di fatturazione. Ad esempio, se le tariffe erano sottocalcolate per un insieme di transazioni precedenti, potrebbe essere utilizzato un aggiustamento per rendere completo l'integratore.

RemittanceStatementSummary

Oggetto di riepilogo su una dichiarazione di versamento.

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

string (int64 format)

REQUIRED: data (in America/Los Angeles) in cui è stata creata l'istruzione.
billingPeriod

object (BillingPeriod)

OBBLIGATORIO: il periodo di fatturazione coperto dal presente estratto conto.
dateDue

string (int64 format)

FACOLTATIVO: la data di scadenza del versamento. Questo valore è espresso in millisecondi dall'epoca. Si tratta di una data, pertanto inizierà sempre al primo millisecondo della giornata nel fuso orario di fatturazione.

Questo campo viene impostato se il valore di totalDueByIntegrator è maggiore di 0.
currencyCode

string

OBBLIGATORIO: codice valuta ISO 4217 di tre lettere.
totalDueByIntegrator

string (Int64Value format)

REQUIRED: questo valore è in micro nella valuta currencyCode. Questo valore è sempre positivo.
remittanceInstructions

object (RemittanceInstructions)

OBBLIGATORIO: dettagli su come effettuare il pagamento

BillingPeriod

Periodo di fatturazione del presente estratto conto.

Rappresentazione JSON 
{
  "startDate": string,
  "endDate": string
}
Campi
startDate

string (int64 format)

OBBLIGATORIO: la data di inizio del periodo di fatturazione. Questo valore è espresso in millisecondi dall'epoca. Si tratta di una data, pertanto inizierà sempre al primo millisecondo della giornata nel fuso orario di fatturazione.

Si tratta del primo millisecondo del giorno del periodo di fatturazione, ovvero 00:00:00.000
endDate

string (int64 format)

OBBLIGATORIO: la data di fine del periodo di fatturazione. Questo valore è espresso in millisecondi dall'epoca.

Si tratta dell'ultimo millisecondo dell'ultimo giorno del periodo di fatturazione, 23:59:59.999

RemittanceInstructions

La struttura conserva informazioni sulle modalità di pagamento di questa notifica di versamento.

Rappresentazione JSON 
{
  "memoLineId": string
}
Campi
memoLineId

string

REQUIRED: identificatore obbligatorio da inserire nella riga delle note per il pagamento ai fini dell'identificazione del versamento.

Evento

Struttura che rappresenta un singolo evento incluso in una dichiarazione di pagamento.

Rappresentazione JSON 
{
  "eventRequestId": string,
  "paymentIntegratorEventId": string,
  "eventCharge": string,
  "eventFee": string,
  "presentmentChargeAmount": string,
  "presentmentCurrencyCode": string,
  "exchangeRate": string,
  "nanoExchangeRate": string
}
Campi
eventRequestId

string

REQUIRED: per gli eventi di acquisizione o rimborso, questo valore è il requestId che Google invia con la richiesta. Per gli eventi di storno di addebito, storno di addebito e storno di addebito, questo sarà il requestId che l'integratore dei pagamenti invia con la notifica di tale evento. Per gli aggiustamenti, si tratta di un ID univoco assegnato da Google all'evento di aggiustamento.
paymentIntegratorEventId

string

REQUIRED: ID dell'integratore dei pagamenti restituito per questo evento. Per uno screenshot, questo è il paymentIntegratorTransactionId della risposta a una chiamata capture. Per un rimborso, questo è il paymentIntegratorRefundId della risposta a una chiamata refund.

Questo campo ha lunghezza variabile, come integratore qualsiasi ID da te fornito per questo evento sarà riportato qui. Se l'integratore non ha fornito un valore per l'evento corrispondente, questo campo conterrà lo stesso valore del campo eventRequestId.

Per gli eventi di storno di addebito, storno di addebito e storno di addebito, questo sarà il requestId che l'integratore dei pagamenti ha inviato con la notifica dell'evento.

La lunghezza e il formato di questo campo dipendono dal campo origine per ciascun ID. Per informazioni dettagliate sui requisiti relativi a lunghezza e set di caratteri, consulta la documentazione relativa a ogni campo di origine. In particolare, tieni presente che questo campo a volte può contenere ID generati da Google che potrebbero avere requisiti di lunghezza massima diversi rispetto agli ID generati dall'integratore.
eventCharge

string (Int64Value format)

REQUIRED: nel codice valuta definito dall'istruzione. Se questo valore è negativo, rappresenta il valore monetario che passa da Google all'integratore dei pagamenti. In caso positivo, si tratta di denaro proveniente dall'integratore dei pagamenti a favore di Google.

Ad esempio, le transazioni di acquisizione saranno sempre positive, mentre quelle di rimborso saranno sempre negative. Gli eventi di rimborso e storno di addebito saranno sempre positivi. Gli eventi di storno di addebito saranno sempre negativi.

Questo valore è espresso in micro.
eventFee

string (Int64Value format)

REQUIRED: nel codice valuta definito dall'istruzione. Se questo valore è negativo, rappresenta il valore monetario che passa da Google all'integratore dei pagamenti. In caso positivo, si tratta di denaro proveniente dall'integratore dei pagamenti a favore di Google.

Ad esempio, se un contratto indica che Google pagherà l'1% di transactionCharge all'integratore dei pagamenti e lo annullerà al momento del rimborso della transazione, la commissione di acquisizione sarà negativa, mentre al momento del rimborso la commissione di rimborso sarà positiva.

Questo valore è espresso in micro.
presentmentChargeAmount

string (Int64Value format)

FACOLTATIVO: l'importo della transazione è nella valuta di presentazione (ovvero la transazione) prima del cambio in valuta estera. Questo campo segue la stessa convenzione di firma del campo eventCharge.

Questo valore è espresso in micro.

presentmentCurrencyCode

string

FACOLTATIVO: codice valuta ISO 4217 di tre lettere che denomina la valuta di presentazione (transazione).

exchangeRate

string (Int64Value format)

FACOLTATIVO: il tasso di cambio utilizzato per convertire l'importo della presentazione in importo di liquidazione (fattura).

Questo valore è espresso in micro punti base (1 punto base = 0,0001 = 0,01%). In altre parole, per ottenere il tasso di cambio, dividi questo campo per 10^10.
nanoExchangeRate

string (Int64Value format)

FACOLTATIVO: il tasso di cambio utilizzato per convertire l'importo della presentazione nell'importo di liquidazione (fattura), espresso in nano punti base.

Questo valore è espresso in punti base nano (1 punto base = 0,0001 = 0,01%). In altre parole, per ottenere il tasso di cambio, dividi questo campo per 10^13.

Verranno compilati sia il campo che il tasso di cambio. Si tratta di tassi di cambio equivalenti espressi con precisione diversa. Nelle versioni future, ExchangeRate verrà rimosso a favore di nanoExchangeRate.