Method: disburseFundsResultNotification

Notifique o Google sobre o resultado de um pagamento depois que a chamada do método disburseFunds for feita.

O valor disburseFundsResult é idempotente para essa disburseFundsRequestId, portanto, o valor precisa ser idêntico ao retornado durante a chamada de disburseFunds e não pode ser alterado por uma chamada subsequente para esse método.

Se o endpoint encontrar um erro ao processar a solicitação, a resposta dele será do tipo ErrorResponse.

As respostas a esta consulta podem ficar vazias se o método não retornar HTTP 200. O corpo da resposta fica vazio em situações em que um ErrorResponse com uma descrição clara pode ser usado para ajudar um invasor a entender o identificador da conta do integrador de pagamentos de outros integradores. Quando a chave de assinatura não corresponde, o identificador do integrador de pagamentos não é encontrado ou a chave de criptografia é desconhecida, esse método vai retornar um HTTP 404 com corpo vazio. Se for possível verificar a assinatura da solicitação, informações adicionais sobre o erro serão retornadas no corpo da resposta.

Um exemplo de solicitação é semelhante a este:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 1,
      "revision": 0
    },
    "requestId": "KcgwSKrV76eVNDUbsZ4UA3",
    "requestTimestamp": "1481852928293"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "disburseFundsRequestId": "awNaC510cefae3IJdNEvW2",
  "disburseFundsResult": {
    "disburseFundsResultCode": "SUCCESS"
  }
}

Veja um exemplo de resposta:


{
  "responseHeader": {
    "responseTimestamp": "1481852928324"
  },
  "result": "SUCCESS"
}

Solicitação HTTP

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

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "disburseFundsRequestId": string,
  "disburseFundsResult": {
    object (DisburseFundsResult)
  }
}
Campos
requestHeader

object (RequestHeader)

OBRIGATÓRIO: cabeçalho comum para todas as solicitações.
paymentIntegratorAccountId

string

OBRIGATÓRIO: o identificador da conta do integrador de pagamentos em que o pagamento ocorreu.
disburseFundsRequestId

string

OBRIGATÓRIO: um identificador exclusivo para esta transação. Esse é o requestId gerado pelo Google durante a chamada disburseFunds a que essa solicitação está associada.

Essa é uma string com comprimento máximo de 100 caracteres e contém apenas os caracteres "a-z", "A-Z", "0-9", ":", "-" e "_".
disburseFundsResult

object (DisburseFundsResult)

OBRIGATÓRIO: resultado da chamada de fundos de desembolso.

Corpo da resposta

Objeto de resposta para o método disburseFundsResultNotification.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": enum (DisburseFundsResultNotificationResultCode)
}
Campos
responseHeader

object (ResponseHeader)

OBRIGATÓRIO: cabeçalho comum para todas as respostas.
result

enum (DisburseFundsResultNotificationResultCode)

OBRIGATÓRIO: resultado da chamada.

DisburseFundsResult

Informações sobre o resultado final de um pagamento.

Representação JSON 
{
  "disburseFundsResultCode": enum (DisburseFundsResultCode),
  "rawResult": {
    object (RawResult)
  },

  // Union field FailureDetail can be only one of the following:
  "transactionMaxLimit": string,
  "transactionMinLimit": string
  // End of list of possible types for union field FailureDetail.
}
Campos
disburseFundsResultCode

enum (DisburseFundsResultCode)

OBRIGATÓRIO: código do resultado do pagamento.
rawResult

object (RawResult)

OPCIONAL: resultado bruto do pagamento. Usado para ajudar a informar o mecanismo de risco e as análises do Google. Em situações de recusa de mapeamento de código, os dados às vezes são perdidos. O integrador pode optar por fornecer um código bruto ao Google. Por exemplo, um gateway de cartão de crédito (o integrador) pode usar esse campo para comunicar ao Google o código de recusa exato recebido da rede VISA. Nesse caso, o valor de scope seria "visto". e rawCode seria o que a rede VISA retornasse.

Esse valor será obrigatório se result não for SUCCESS.

Campo de união FailureDetail.

FailureDetail pode ser apenas de um dos tipos a seguir:
transactionMaxLimit

string (Int64Value format)

OPCIONAL: se disburseFundsResultCode for DISBURSEMENT_EXCEEDS_TRANSACTION_LIMIT, esse será o valor da transação máxima permitida. Isso é usado para análise de taxa de recusa e mensagens estruturadas voltadas ao usuário.

Esse valor é micros da mesma currencyCode da chamada de método original disburseFunds.
transactionMinLimit

string (Int64Value format)

OPCIONAL: se disburseFundsResultCode for DISBURSEMENT_UNDER_TRANSACTION_LIMIT, esse será o valor da transação mínima permitida. Isso é usado para análise de taxa de recusa e mensagens estruturadas voltadas ao usuário.

Esse valor é micros da mesma currencyCode da chamada de método original disburseFunds.

DisburseFundsResultCode

Códigos de resultado de uma chamada de fundos de desembolso.

Enums
UNKNOWN_RESULT Nunca defina esse valor padrão.
SUCCESS Pagamento realizado.
DISBURSEMENT_UNDER_TRANSACTION_LIMIT O valor de pagamento solicitado não atinge o valor mínimo por transação do integrador. Se esse código for usado, preencha o campo transactionMinLimit com o valor mínimo de transação para enviar mensagens aos usuários.
DISBURSEMENT_EXCEEDS_TRANSACTION_LIMIT O valor de pagamento solicitado excede o limite máximo por transação do integrador. Se esse código for usado, preencha o campo transactionMaxLimit com o limite de transações para enviar mensagens aos usuários.
ACCOUNT_CLOSED A conta do usuário mantida no integrador foi encerrada. Esse valor de retorno fará com que o instrumento do usuário seja fechado com o Google. O usuário será forçado a adicionar um novo instrumento.
ACCOUNT_CLOSED_ACCOUNT_TAKEN_OVER A conta do usuário com o integrador foi encerrada e há suspeita de que a conta está sendo assumida. Esse valor de retorno fará com que o instrumento do usuário seja fechado com o Google. O usuário será forçado a adicionar um novo instrumento.
ACCOUNT_CLOSED_FRAUD A conta do usuário retida no integrador foi encerrada devido a uma fraude. Esse valor de retorno fará com que o instrumento do usuário seja fechado com o Google. O usuário será forçado a adicionar um novo instrumento.
ACCOUNT_ON_HOLD A conta do usuário está em espera.

RawResult

Objeto de resultado bruto.

Representação JSON 
{
  "scope": string,
  "rawCode": string
}
Campos
scope

string

OPCIONAL: escopo do código bruto, que pode estar vazio.
rawCode

string

OBRIGATÓRIO: código bruto do integrador ou dos subsistemas dele.

DisburseFundsResultNotificationResultCode

Códigos de resultado para o método disburseFundsResultNotification.

Enums
UNKNOWN_RESULT Nunca defina esse valor padrão.
SUCCESS A notificação foi processada.