Method: payment-integrator-dispute-api.defendChargeback

Verifies a user's card to see if it is valid.

This method is called by Google to defend an Inquiry or a Chargeback.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": "1481899949606"
  },
  "paymentIntegratorAccountId": "GlobalPayments",
  "captureRequestId": "G664529173",
  "defenseMaterialDocument" : {
     "mimeType": "APPLICATION_PDF",
     "payload": "ZGFzZGFkYXNkc2Rhc2Rhc2Rhc2Zhc2Y="
  }
}

An example response looks like:


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

HTTP request

POST https://www.integratordomain.com/v1/payment-integrator-dispute-api/defendChargeback

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "captureRequestId": string,
  "defenseMaterialDocument": {
    object (DefenseMaterialDocument)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

paymentIntegratorAccountId

string

REQUIRED: This is the payment integrator account identifier that identifies contractual constraints around this transaction.

captureRequestId

string

REQUIRED: A unique identifier for the payment that is being defended. This is the requestId generated by Google during the captureFundsReservation or capture which this request is associated with.

defenseMaterialDocument

object (DefenseMaterialDocument)

REQUIRED: Present when the chargeback is defended using a PDF document.

Response body

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

Response object for the payment integrator hosted payment-integrator-dispute-api.defendChargeback method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

enum (DefendChargebackResultCode)

REQUIRED: Result of this call.

DefenseMaterialDocument

A chargeback defense in the form of a PDF document.

JSON representation
{
  "mimeType": enum (MimeType),
  "payload": string
}
Fields
mimeType

enum (MimeType)

REQUIRED: The MIME type of the document. Only the listed subset of IANA published MIME types are valid.

payload

string

REQUIRED: The raw bytes of the PDF document encoded using base64url.

MimeType

The MIME type of a document.

Enums
MIME_TYPE_UNSPECIFIED DO NOT USE
IMAGE_PNG Equivalent of IANA published MIME type image/png.
IMAGE_JPEG Equivalent of IANA published MIME type image/jpeg.
IMAGE_GIF Equivalent of IANA published MIME type image/gif.
APPLICATION_PDF Equivalent of IANA published MIME type application/pdf.

DefendChargebackResultCode

Result codes for the defendChargeback method.

Enums
DEFEND_CHARGEBACK_RESULT_CODE_UNSPECIFIED Do not ever set this default value!
SUCCESS The defense was successfully submitted.
CAPTURE_REQUEST_ID_NOT_FOUND The captureRequestId is not known to the receipient of the request.
INVALID_DOCUMENT_FORMAT The document payload is malformed.
CHARGEBACK_NOT_DEFENDABLE There is no recourse to defend this chargeback.