Method: remittanceStatementDetails

Muestra información detallada de la transacción sobre una declaración de remesa.

Esta es una API paginada. La cantidad de eventos de transacción por página se puede especificar con numberOfEvents. Si no se especifica, se mostrará un máximo de 1,000 eventos por página. Cada solicitud a esta API mostrará un nextEventOffset que apunta al siguiente evento de transacción en la sentencia, así como totalEvents que especifica la cantidad total de transacciones en la sentencia. Si la página recuperada actual contiene las últimas transacciones de la sentencia, nextEventOffset no estará presente en la respuesta.

El valor statementId es el requestId de remittanceStatementNotificationRequest

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

Es posible que las respuestas a esta consulta estén vacías si este método no muestra un HTTP 200. El cuerpo de la respuesta está vacío en los casos en que se pueda usar un elemento ErrorResponse con una descripción clara para ayudar a un atacante a comprender el identificador de la cuenta del integrador de pagos de otros integradores. En estos casos, en los que la clave de firma no coincide, no se encontró el identificador del integrador de pago o la clave de encriptación es desconocida, este método mostrará un HTTP 404 con un cuerpo vacío. Si se pudo verificar la firma de la solicitud, se mostrará información adicional sobre el error en el cuerpo de la respuesta.

Una solicitud de ejemplo se ve de la siguiente manera:


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

Una respuesta de ejemplo se ve de la siguiente manera:


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

Solicitud HTTP

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

Cuerpo de la solicitud

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

Representación JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "statementId": string,
  "eventOffset": integer,
  "numberOfEvents": integer
}
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.
statementId

string

OBLIGATORIO: Indica el ID de solicitud de la notificación de declaración.
eventOffset

integer

OPCIONAL: Muestra los eventos a partir de este desplazamiento. Debe establecerse en nextEventOffset si se muestra uno o se deja sin especificar si esta es la primera solicitud. Si eventOffset es cero, los eventos se mostrarán a partir del primer evento. Si es dos, los eventos se mostrarán a partir del tercer evento. Si no se especifica, se supone que eventOffset es cero.

numberOfEvents

integer

OPCIONAL: Es la cantidad de eventos que se muestran por página. Si no se especifica o es mayor que 1,000, será 1,000.

Cuerpo de la respuesta

Objeto de respuesta para el método de detalles 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)
  },
  "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)
    }
  ]
}
Campos
responseHeader

object (ResponseHeader)

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

object (RemittanceStatementSummary)

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

integer

OBLIGATORIO: Es el desplazamiento de evento de esta respuesta.
nextEventOffset

integer

OPCIONAL: El desplazamiento del próximo evento que se mostrará. Si no se especifica, no hay más eventos para recuperar en esta sentencia.
totalEvents

integer

OBLIGATORIO: Indica la cantidad total de eventos de esta declaración.
totalWithholdingTaxes

string (Int64Value format)

OBLIGATORIO: Es la suma de todos los impuestos retenidos para este resumen.

Este valor se encuentra en micros.
captureEvents[]

object (Event)

OBLIGATORIO: Es un conjunto de eventos de captura.
refundEvents[]

object (Event)

OBLIGATORIO: Es un conjunto de eventos de reembolso.
reverseRefundEvents[]

object (Event)

OPCIONAL: Es un conjunto de eventos de reembolso inverso.
chargebackEvents[]

object (Event)

OPCIONAL: Es un conjunto de eventos de devolución del cargo.
reverseChargebackEvents[]

object (Event)

OPCIONAL: Es un conjunto de eventos de contracargos inversos.
adjustmentEvents[]

object (Event)

OPCIONAL: Es un conjunto de eventos de ajuste. Es posible que se agreguen eventos de ajuste a discreción de Google para conciliar discrepancias de facturación; por ejemplo, si las tarifas no se procesaron en el conjunto de transacciones anteriores, es posible que se utilice un ajuste para integrar al integrador.

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.

Evento

Estructura que representa un solo evento incluido en una declaración de remesa.

Representación JSON 
{
  "eventRequestId": string,
  "paymentIntegratorEventId": string,
  "eventCharge": string,
  "eventFee": string,
  "presentmentChargeAmount": string,
  "presentmentCurrencyCode": string,
  "exchangeRate": string,
  "nanoExchangeRate": string
}
Campos
eventRequestId

string

OBLIGATORIO: Este parámetro corresponde a la requestId que envía Google con la solicitud. Para los eventos de reembolso, reintegro y reintegro, este será el requestId que el integrador de pagos envía con la notificación de ese evento. En el caso de los ajustes, será un ID único asignado por Google al evento de ajuste.
paymentIntegratorEventId

string

OBLIGATORIO: ID del integrador de pagos que se mostró para este evento. Para una captura, esta es la paymentIntegratorTransactionId de la respuesta a una llamada a capture. Para un reembolso, es el paymentIntegratorRefundId de la respuesta a una llamada a refund.

Este campo tiene una longitud variable, como integrador, el ID que proporciones para este evento se reflejará aquí. Si el integrador no proporcionó un valor para el evento correspondiente, este campo contendrá el mismo valor que el campo eventRequestId.

Para los eventos de reembolso y reintegro, este será el requestId que el integrador de pagos envió con la notificación del evento.

La longitud y el formato de este campo depende del campo de origen para cada ID. Consulta la documentación de cada uno de los campos de origen para obtener detalles sobre los requisitos de longitud y grupos de caracteres. En particular, tenga en cuenta que, en ocasiones, este campo puede contener IDs generados por Google, que pueden tener diferentes requisitos de longitud máxima que los ID generados por el integrador.
eventCharge

string (Int64Value format)

OBLIGATORIO: En código de moneda definido por la declaración. Si este valor es negativo, representa el valor monetario que pasa de Google al integrador de pagos. Si esto es positivo, se debe al dinero del integrador de pagos debido a Google.

Por ejemplo, las transacciones de captura siempre serán positivas y las de reembolso siempre serán negativas. Los eventos de reintegro y reembolso revertidos siempre serán positivos. Los eventos de contracargos siempre serán negativos.

Este valor se encuentra en micros.
eventFee

string (Int64Value format)

OBLIGATORIO: En código de moneda definido por la declaración. Si este valor es negativo, representa el valor monetario que pasa de Google al integrador de pagos. Si esto es positivo, se debe al dinero del integrador de pagos debido a Google.

Por ejemplo, si un acuerdo indica que Google pagará el 1% del transactionCharge al integrador de pagos y lo revertirá al momento de reembolsar esa transacción, la tarifa de captura será negativa y la tarifa de reembolso será positiva.

Este valor se encuentra en micros.
presentmentChargeAmount

string (Int64Value format)

OPCIONAL: Importe de la transacción en la moneda de presentación (también conocida como transacción) antes del cambio de moneda. Este campo sigue la misma convención de signos que el campo eventCharge.

Este valor se encuentra en micros.

presentmentCurrencyCode

string

OPCIONAL: Es el código de moneda de 3 letras ISO 4217 que denomina la moneda de presentación (transacción).

exchangeRate

string (Int64Value format)

OPCIONAL: Es la tasa de cambio que se usa para convertir el importe de la presentación en el importe de la liquidación (factura).

Este valor se expresa en micro puntos base (1 punto base = 0 .0001 = 0 .01%). Es decir, para obtener el tipo de cambio, divide este campo por 10^10.
nanoExchangeRate

string (Int64Value format)

OPCIONAL: Es la tasa de cambio que se usa para convertir el importe de la presentación al importe de la liquidación (factura), expresado en puntos nano.

Este valor se expresa en base (1 punto base = 0 .0001 = 0 .01%). Es decir, para obtener el tipo de cambio, divide este campo por 10^13.

Estos campos y exchangeRate se propagarán. Son tasas de cambio equivalentes expresadas con una precisión diferente. En versiones futuras, se quitará exchangeRate Favorito a nanoExchangeRate.