Method: paycache.initiateDisputeFromBank

Bank initiated dispute for a transaction.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": {
      "epochMillis":1603380811
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "bankCaseId": "BankCaseNo1234",
  "partnerTransactionId": "TxnId1234",
  "googleAccountToken": "A1234567890",
  "reason": "DISPUTE_REASON_EXAMPLE",
  "status": {},
  "caseInitiatedTimestamp": {
     "epochMillis": 1603380811
  },
  "caseExpirationTimestamp":{
    "epochMillis": 1604480811
  },
  "amount": {
    "amountMicros":"120000000",
     "currencyCode":"USD"
   },
  "card" : {
    "googleInstrumentToken" : "Instrument1234"
  }
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis":1481899950236
    }
  },
  "result": {
      "googleCaseId": "CaseNo1234"
   }
}

HTTP request

POST https://billpaynotification.googleapis.com/secure-serving/gsp/v1/paycache/initiateDisputeFromBank

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "bankCaseId": string,
  "partnerTransactionId": string,
  "googleAccountToken": string,
  "reason": enum (DisputeReason),
  "status": {
    object (DisputeStatus)
  },
  "caseInitiatedTimestamp": {
    object (Timestamp)
  },
  "caseExpirationTimestamp": {
    object (Timestamp)
  },
  "amount": {
    object (Amount)
  },
  "card": {
    object (CardDispute)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

bankCaseId

string

REQUIRED: A bank-generated ID that uniquely identifies the dispute.

partnerTransactionId

string

REQUIRED: The unique ID of the transaction that is being disputed.

googleAccountToken

string

REQUIRED: The unique ID for the account of this disputed transaction. This ID is generated by Google and supplied to the bank during account creation.

reason

enum (DisputeReason)

REQUIRED: Reason for dispute.

status

object (DisputeStatus)

REQUIRED: The status of the dispute.

caseInitiatedTimestamp

object (Timestamp)

REQUIRED: Timestamp of when the case was created in the partner bank's system.

caseExpirationTimestamp

object (Timestamp)

OPTIONAL: Timestamp of the case expiration.

amount

object (Amount)

REQUIRED: The amount that is being disputed. This can be equal to or less than the original amount.

card

object (CardDispute)

Dispute for a debit card transaction.

Response body

If successful, the response body contains data with the following structure:

Response object for 'paycache.initiateDisputeFromBank' method.

JSON representation
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (Result)
  }
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

object (Result)

REQUIRED: The outcome of calling paycache.initiateDisputeFromBank.

DisputeReason

Enums
DISPUTE_REASON_UNSPECIFIED
DISPUTE_REASON_EXAMPLE is understood.

CardDispute

Dispute details for a debit card transaction.

JSON representation
{
  "googleInstrumentToken": string
}
Fields
googleInstrumentToken

string

REQUIRED: The googleInstrumentToken for the card on which the transaction was made. This value was given to the payment integrator when issueCard was called to create the card.

Result

JSON representation
{
  "googleCaseId": string
}
Fields
googleCaseId

string

The Google-generated ID to uniquely identify the dispute. The dispute case was successfully created.