Method: paycache.updateDispute

Provides additional information about a dispute to partner bank in response to previous request.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": {
      "epochMillis":1481899949606
    },
    "paymentIntegratorAccountId": "abcdef123456"
  },
  "googleCaseId": "CaseNo1234",
  "additionalInfo": [
    {
      "disputeInfoRequestId": "G1AB0CERJ0Q7LPM",
      "disputeInfoId": "abc123",
      "disputeInfoDetails": {
        "freeform": "Screen was cracked"
      }
    },
    {
      "disputeInfoRequestId": "G1AB0CERJ0Q7LPM",
      "disputeInfoId": "xyz789",
      "disputeInfoDetails": {
        "selection": {
          "selectedItemId": ["ItemId1" ]
        }
      }
    }
  ]
}

An example response where no further info is required:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis":1481899950236
    }
  },
  "result": {
    "accepted": {}
  }
}

HTTP request

POST https://www.integratordomain.com/v1/paycache/updateDispute

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "googleCaseId": string,
  "additionalInfo": [
    {
      object (DisputeInfo)
    }
  ]
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

googleCaseId

string

REQUIRED: The Google-generated ID uniquely identifying the dispute.

additionalInfo[]

object (DisputeInfo)

REQUIRED: Additional information that was previously requested by partner bank from user in-session.

Response body

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

Response object for 'paycache.updateDispute' 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.updateDispute.

DisputeInfo

Contains information about a dispute that was requested in a disputeInfoRequest.

JSON representation
{
  "disputeInfoRequestId": string,
  "disputeInfoId": string,
  "disputeInfoDetails": {
    object (DisputeInfoDetails)
  }
}
Fields
disputeInfoRequestId

string

REQUIRED: The ID of the request that matches this DisputeInfo.

disputeInfoId

string

REQUIRED: The unique ID for theDisputeInfo. This is bank generated and should be unique for this request.

disputeInfoDetails

object (DisputeInfoDetails)

REQUIRED: The dispute info being sent to the bank and its type.

DisputeInfoDetails

Payload of the dispute info requested from the user.

JSON representation
{

  // Union field info_type can be only one of the following:
  "freeform": string,
  "selection": {
    object (SelectionResponse)
  },
  "document": {
    object (UserDocument)
  },
  "amount": {
    object (Amount)
  },
  "integer": string,
  "date": {
    object (Date)
  }
  // End of list of possible types for union field info_type.
}
Fields
Union field info_type. REQUIRED: The type of dispute info requested from the user. info_type can be only one of the following:
freeform

string

A free-form text response.

selection

object (SelectionResponse)

A response where the user selected from a list of options.

document

object (UserDocument)

A document uploaded by the user.

amount

object (Amount)

A user provided amount.

integer

string (Int64Value format)

A user provided integer.

date

object (Date)

A user provided date.

SelectionResponse

Details about a user's response to a SelectionResponse DisputeInfoDetails question.

JSON representation
{
  "selectedItemId": [
    string
  ],
  "otherResponse": string
}
Fields
selectedItemId[]

string

otherResponse

string

OPTIONAL: User entered text. This will only be populated if DisputeInfoRequestType was selectionWithOtherOption and user chose the other option.

Result

JSON representation
{

  // Union field result can be only one of the following:
  "accepted": {
    object (Empty)
  },
  "additionalInfoRequired": {
    object (AdditionalInfoRequired)
  }
  // End of list of possible types for union field result.
}
Fields
Union field result. REQUIRED: Result of dispute initiation call. result can be only one of the following:
accepted

object (Empty)

Acknowledgement indicating a dispute case has been opened.

additionalInfoRequired

object (AdditionalInfoRequired)

The bank requires additional info from the user.