Method: remittanceStatementDetails

Restituisce le informazioni dettagliate sulla transazione relative a un estratto conto del versamento.

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

Il valore statementId corrisponde a requestId da remittanceStatementNotificationRequest

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

Le risposte a questa query potrebbero essere vuote se questo metodo non restituisce un codice HTTP 200. Il corpo della risposta è vuoto nel caso in cui un ErrorResponse con una descrizione chiara possa essere utilizzato per aiutare un utente malintenzionato a comprendere l'identificatore di account integratore di pagamento di altri integratori. In questi casi, in cui la chiave di firma non corrisponde, non è stato trovato l'identificatore dell'integratore dei pagamenti o la chiave di crittografia era sconosciuta, questo metodo restituirà un errore HTTP 404 con un corpo vuoto. Se è stato possibile verificare la firma della richiesta, nel corpo della risposta verranno restituite ulteriori informazioni 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
}

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: è l'identificatore dell'account integrato del pagamento che identifica i vincoli contrattuali presenti in questo estratto conto.

statementId

string

REQUIRED: l'ID richiesta della notifica di dichiarazione.

eventOffset

integer

OPTIONAL: restituisce gli eventi a partire da questo offset. Deve essere impostato su nextEventOffset se ne è stato restituito uno o non è stato specificato se è la prima richiesta. Se eventOffset è zero, verranno restituiti eventi a partire dal primo evento. Se questo valore è pari a due, gli eventi verranno restituiti a partire dal terzo evento. Se non viene specificato un valore, si presume che il valore di eventOffset sia zero.

numberOfEvents

integer

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

Corpo della risposta

Oggetto della risposta per il metodo di dettaglio 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)

REQUIRED: riepilogo del presente versamento.

eventOffset

integer

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

nextEventOffset

integer

OPTIONAL: l'offset del successivo evento da restituire. Se il valore non è specificato, non ci sono altri eventi da recuperare per questa istruzione.

totalEvents

integer

REQUIRED: numero totale di eventi in questa istruzione.

totalWithholdingTaxes

string (Int64Value format)

REQUIRED: la somma di tutte le tasse trattenute per questo estratto conto.

Questo valore è in micro.

captureEvents[]

object (Event)

REQUIRED: insieme di eventi di acquisizione.

refundEvents[]

object (Event)

REQUIRED: insieme di eventi per il rimborso.

reverseRefundEvents[]

object (Event)

FACOLTATIVO: un insieme di eventi di rimborso inverso.

chargebackEvents[]

object (Event)

FACOLTATIVO: un insieme di eventi relativi allo storno di addebito.

reverseChargebackEvents[]

object (Event)

FACOLTATIVO: insieme di eventi di storno di addebito.

adjustmentEvents[]

object (Event)

FACOLTATIVO: un insieme di eventi di aggiustamento. Gli eventi di aggiustamento possono essere aggiunti a discrezione di Google per riconciliare le discrepanze relative alla fatturazione, ad esempio se le tariffe sono state sottocalcolate per una serie di transazioni precedenti, è possibile utilizzare un aggiustamento per integrare l'integratore.

RiepilogoRemittanceStatement

Oggetto di riepilogo in 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: la data (in America/Los Angeles) in cui è stata creata questa istruzione.

billingPeriod

object (BillingPeriod)

REQUIRED: il periodo di fatturazione oggetto della dichiarazione.

dateDue

string (int64 format)

OPTIONAL: la data di scadenza del versamento. È rappresentato come millisecondi dall'epoca. È una data (quindi inizia sempre dal primo millisecondo del giorno nel fuso orario di fatturazione).

L'opzione è impostata purché il valore di totalDueByIntegrator sia maggiore di 0.

currencyCode

string

REQUIRED: codice valuta ISO 4217 di tre lettere.

totalDueByIntegrator

string (Int64Value format)

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

remittanceInstructions

object (RemittanceInstructions)

REQUIRED: dettagli su come effettuare il pagamento

Periodo di fatturazione

Periodo di fatturazione del presente estratto conto.

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

string (int64 format)

REQUIRED: la data di inizio del periodo di fatturazione. È rappresentato come millisecondi dall'epoca. È una data (quindi inizia sempre dal primo millisecondo del giorno nel fuso orario di fatturazione).

Questo è il primo millisecondo del giorno del periodo di fatturazione e corrisponde a 00:00:00.000

endDate

string (int64 format)

REQUIRED: la data di fine del periodo di fatturazione. È rappresentato come millisecondi dall'epoca.

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

Istruzioni per il versamento

Struttura contenente informazioni su come pagare questa notifica di versamento.

Rappresentazione JSON
{
  "memoLineId": string
}
Campi
memoLineId

string

OBBLIGATORIO: identificatore obbligatorio da inserire nella riga del promemoria per il pagamento per l'identificazione del versamento.

Evento

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

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, sarà questo il requestId che Google invierà con la richiesta. Per gli eventi relativi a rimborso inverso, storno di addebito e storno di addebito, si tratta del requestId che l'Integratore dei pagamenti invia con la notifica dell'evento. Per gli aggiustamenti, si tratta di un ID univoco assegnato da Google all'evento di aggiustamento.

paymentIntegratorEventId

string

REQUIRED: ID che l'integratore di pagamenti ha restituito per questo evento. Per un'acquisizione, questo è l'paymentIntegratorTransactionId dalla risposta a una chiamata capture, per un rimborso è il paymentIntegratorRefundId dalla risposta a una chiamata refund.

Questo campo ha una lunghezza variabile, quindi come integratore qualsiasi ID fornito per questo evento verrà 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 relativi a rimborso inverso, storno di addebito e storno di addebito, questo valore corrisponderà al requestId che l'Integratore dei pagamenti ha inviato con la notifica dell'evento.

La lunghezza e il formato di questo campo dipendono dal campo di origine per ogni ID. Per informazioni dettagliate sui requisiti di lunghezza e set di caratteri, consulta la documentazione di ciascun campo di origine. In particolare, tieni presente che questo campo contiene a volte ID generati da Google, che possono avere requisiti di lunghezza massima diversi rispetto agli ID generati dagli integratori.

eventCharge

string (Int64Value format)

REQUIRED: nel codice valuta definito dall'estratto conto. Se questo valore è negativo, si tratta di un valore monetario che passa da Google all'integratore dei pagamenti. Se questo è positivo, significa che si tratta di denaro dell'integratore di pagamenti dovuto a Google.

Ad esempio, le transazioni relative alle acquisizioni saranno sempre positive, mentre le transazioni relative ai rimborsi saranno sempre negative. Gli eventi di rimborso inverso e storno di addebito saranno sempre positivi. Gli eventi di storno di addebito saranno sempre negativi.

Questo valore è in micro.

eventFee

string (Int64Value format)

REQUIRED: nel codice valuta definito dall'estratto conto. Se questo valore è negativo, si tratta di un valore monetario che passa da Google all'integratore dei pagamenti. Se questo è positivo, significa che si tratta di denaro dell'integratore di pagamenti dovuto a Google.

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

Questo valore è in micro.

presentmentChargeAmount

string (Int64Value format)

OPTIONAL: importo della transazione nella valuta di presentazione (nota anche come transazione) prima del cambio. Questo campo segue la stessa convenzione del segno del campo eventCharge.

Questo valore è in micro.

presentmentCurrencyCode

string

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

exchangeRate

string (Int64Value format)

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

Questo valore è 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 applicato per convertire l'importo della presentazione nell'importo della liquidazione (fatturazione), espresso in punti nanobase.

Questo valore è 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.

Questo campo e il valore ExchangeRate verranno completati. Si tratta di tassi di cambio equivalenti espressi con precisione diversa. Nelle versioni future, ExchangeRate verrà rimosso a favore di nanoExchangeRate.