Method: remittanceStatementNotification

Notifica al integrador de una nueva declaración de remesa.

Las notificaciones de estado se generan cada vez que se genera un nuevo resumen, que representa el dinero que Google le pagará al integrador o el dinero que debe.

Si el integrador muestra un resultado correcto, se supone que se aceptó la declaración y se pagará.

El requestId también es el ID de la declaración (se usa en otro lugar). La combinación de requestId dentro del encabezado y paymentIntegratorAccountId es la clave de idempotencia que identifica de forma única esta declaración.

Si el extremo encuentra un error mientras se procesa la solicitud, el cuerpo de la respuesta de este extremo debe ser del tipo ErrorResponse.

Una solicitud de ejemplo se ve de la siguiente manera:


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

Una respuesta de ejemplo se ve de la siguiente manera:


{
  "responseHeader": {
    "responseTimestamp": "1502632802000"
  },
  "paymentIntegratorStatementId": "334a",
  "result": "ACCEPTED"
}

Solicitud HTTP

POST https://www.integratorhost.example.com/v1/remittanceStatementNotification

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  }
}
Campos
requestHeader

object (RequestHeader)

OBLIGATORIO: Es un encabezado común para todas las solicitudes.

paymentIntegratorAccountId

string

OBLIGATORIO: Este es el identificador de la cuenta del integrador de pagos que identifica restricciones contractuales en torno a esta declaración.

remittanceStatementSummary

object (RemittanceStatementSummary)

OBLIGATORIO: Es un resumen de esta declaración de remesa.

Cuerpo de la respuesta

Objeto de respuesta para el método de notificación de la declaración de remesa

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorStatementId": string,
  "result": enum (StatementNotificationResultCode)
}
Campos
responseHeader

object (ResponseHeader)

OBLIGATORIO: Es el encabezado común para todas las respuestas.

paymentIntegratorStatementId

string

OBLIGATORIO: Identificador que el integrador conoce esta sentencia. Esto lo genera el integrador.

result

enum (StatementNotificationResultCode)

OBLIGATORIO: Resultado de esta notificación.

Resumen del estado de remesa

Objeto de resumen sobre una declaración de remesa

Representación JSON
{
  "statementDate": string,
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": string,
  "currencyCode": string,
  "totalDueByIntegrator": string,
  "remittanceInstructions": {
    object (RemittanceInstructions)
  }
}
Campos
statementDate

string (int64 format)

OBLIGATORIO: Es la fecha (en América/Los Ángeles) en la que se creó esta declaración.

billingPeriod

object (BillingPeriod)

OBLIGATORIO: Es el período de facturación que abarca este resumen.

dateDue

string (int64 format)

OPCIONAL: Es la fecha en la que vence la remesa. Se representa como milisegundos del ciclo de entrenamiento. Es una fecha (y, por lo tanto, siempre comenzará en el primer milisegundo del día en la zona horaria de facturación).

Se establece si totalDueByIntegrator es mayor que 0.

currencyCode

string

OBLIGATORIO: Código de moneda ISO 4217 de 3 letras.

totalDueByIntegrator

string (Int64Value format)

OBLIGATORIO: Este valor se indica en micros en la moneda currencyCode. Este valor es siempre positivo.

remittanceInstructions

object (RemittanceInstructions)

OBLIGATORIO: Detalles sobre cómo remitir pagos

Período de facturación

Período de facturación de este resumen.

Representación JSON
{
  "startDate": string,
  "endDate": string
}
Campos
startDate

string (int64 format)

OBLIGATORIO: La fecha de inicio del período de facturación. Se representa como milisegundos del ciclo de entrenamiento. Es una fecha (y, por lo tanto, siempre comenzará en el primer milisegundo del día en la zona horaria de facturación).

Este es el primer milisegundo del día del período de facturación, 00:00:00.000

endDate

string (int64 format)

OBLIGATORIO: La fecha de finalización del período de facturación. Se representa como milisegundos del ciclo de entrenamiento.

Este es el último milisegundo del último día del período de facturación, 23:59:59.999

Instrucciones de pago

Estructura con información sobre cómo pagar esta notificación de remesa

Representación JSON
{
  "memoLineId": string
}
Campos
memoLineId

string

OBLIGATORIO: Es el identificador obligatorio que se debe incluir en la línea de la nota para el pago de la identificación del pago.

Código de notificación de notificación

Códigos de resultado para la notificación de instrucciones

Enumeradores
UNKNOWN_RESULT No establezcas este valor predeterminado.
ACCEPTED El integrador aceptó esta declaración.