- Richiesta HTTP
- Corpo della richiesta
- Corpo della risposta
- RemittanceStatementSummary
- BillingPeriod
- RemittanceInstructions
- StatementNotificationResultCode
Informa l'integratore di una nuova distinta di versamento.
Le notifiche relative agli estratti conto vengono inviate ogni volta che viene generato un nuovo estratto conto che rappresenta l'importo che Google pagherà all'integratore o l'importo dovuto a Google.
Se l'integratore restituisce un risultato positivo, si presume che l'istruzione sia stata accettata e verrà pagata.
requestId
è anche l'ID dell'istruzione (utilizzato altrove). La combinazione di requestId
nell'intestazione e paymentIntegratorAccountId
è la chiave di idempotenza e identifica in modo univoco questa affermazione.
Se l'endpoint rileva un errore durante l'elaborazione della richiesta, il corpo della risposta da questo endpoint deve essere di tipo
.ErrorResponse
Ecco un esempio di richiesta:
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 0,
"revision": 0
},
"requestId": "0123434-statement-abc",
"requestTimestamp": "1502632800000"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD",
"remittanceStatementSummary": {
"statementDate": "1502607600000",
"billingPeriod": {
"startDate": "1502434800000",
"endDate": "1502521199000"
},
"dateDue": "1503212400000",
"currencyCode": "INR",
"totalDueByIntegrator": "1076000000",
"remittanceInstructions": {
"memoLineId": "stmt-1AB-pp0-invisi"
}
}
}
Ecco un esempio di risposta:
{
"responseHeader": {
"responseTimestamp": "1502632802000"
},
"paymentIntegratorStatementId": "334a",
"result": "ACCEPTED"
}
Richiesta HTTP
POST https://www.integratorhost.example.com/v1/remittanceStatementNotification
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "requestHeader": { object ( |
Campi | |
---|---|
requestHeader |
REQUIRED: intestazione comune per tutte le richieste. |
paymentIntegratorAccountId |
REQUIRED: si tratta dell'identificatore dell'account dell'integratore pagamenti che identifica i vincoli contrattuali relativi a questa dichiarazione. |
remittanceStatementSummary |
REQUIRED: riepilogo di questa distinta di versamento. |
Corpo della risposta
Oggetto della risposta per il metodo di notifica della distinta.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "responseHeader": { object ( |
Campi | |
---|---|
responseHeader |
REQUIRED: intestazione comune per tutte le risposte. |
paymentIntegratorStatementId |
REQUIRED: identificatore con cui l'integratore conosce questa istruzione. Questo è stato generato dall'integratore. |
result |
REQUIRED: il risultato della notifica della dichiarazione. |
RemittanceStatementSummary
Oggetto di riepilogo relativo a una dichiarazione di versamento.
Rappresentazione JSON |
---|
{ "statementDate": string, "billingPeriod": { object ( |
Campi | |
---|---|
statementDate |
REQUIRED: data (in America/Los Angeles) di creazione della dichiarazione. |
billingPeriod |
OBBLIGATORIO: il periodo di fatturazione coperto da questo estratto conto. |
dateDue |
FACOLTATIVO: la data di scadenza del versamento. rappresentato in millisecondi da epoca. Si tratta di una data (e pertanto inizierà sempre al primo millisecondo del giorno nel fuso orario di fatturazione). Questo valore viene impostato purché il valore |
currencyCode |
OBBLIGATORIO: codice valuta ISO 4217 di tre lettere. |
totalDueByIntegrator |
REQUIRED: questo valore è espresso in micro nella valuta |
remittanceInstructions |
REQUIRED: dettagli su come effettuare il pagamento |
BillingPeriod
Periodo di fatturazione di questo estratto conto.
Rappresentazione JSON |
---|
{ "startDate": string, "endDate": string } |
Campi | |
---|---|
startDate |
REQUIRED: la data di inizio del periodo di fatturazione. rappresentato in millisecondi da epoca. Si tratta di una data (e pertanto inizierà sempre al primo millisecondo del giorno nel fuso orario di fatturazione). Questo è il primo millisecondo del giorno del periodo di fatturazione, 00:00:00.000 |
endDate |
REQUIRED: la data di fine del periodo di fatturazione. rappresentato in millisecondi da epoca. Ultimo millisecondo dell'ultimo giorno del periodo di fatturazione, 23:59:59.999 |
RemittanceInstructions
Strutturare le informazioni in conservazione su come pagare questa notifica di versamento.
Rappresentazione JSON |
---|
{ "memoLineId": string } |
Campi | |
---|---|
memoLineId |
REQUIRED: identificatore obbligatorio da inserire nella riga della nota per il pagamento ai fini dell'identificazione del versamento. |
StatementNotificationResultCode
Codici dei risultati per la notifica dell'estratto conto.
Enum | |
---|---|
UNKNOWN_RESULT |
Non impostare mai questo valore predefinito. |
ACCEPTED |
L'integratore ha accettato questa dichiarazione. |