- HTTP request
- Request body
- Response body
- ChargebackStage
- ChargebackNotificationResponse
- ChargebackNotificationResultCode
Notifies Google that a chargeback is being issued for a payment.
This signifies a user is contesting a payment and the issuer has decided to issue a chargeback. When the request is made it signifies that the user is being reimbursed by the issuer and will recover those funds either from the integrator or from Google.
If the endpoint encounters an error while processing the request, the response from this endpoint will be of type ErrorResponse
.
Responses to this query may be empty if this method does not return an HTTP 200. The response body is empty in situations where an ErrorResponse
with a clear description could be used to help an attacker understand the payment integrator account identifier of other integrators. In these situations, where either the signing key doesn't match, the payment integrator identifier was not found, or the encryption key was unknown, this method will return an HTTP 404 with an empty body. If the request signature could be verified, additional information regarding the error will be returned in the response body.
An example request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 0,
"revision": 0
},
"requestId": "fe640ae3-d9af-4075-90a1-7b90f436b3c0",
"requestTimestamp": "1484584747000"
},
"paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR",
"captureRequestId": "G112YZH4XPDV88J",
"amount": "728000000",
"chargebackStage": "FIRST",
"reasonCode": "INCORRECT_MERCHANDISE",
"rawResult": {
"scope": "VISA",
"rawCode": "04"
},
"chargebackDate": "1483574400000",
"replyByDate": "1491350400000",
"caseId": "G-7832-13512"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": "1484584747598"
},
"result": "SUCCESS"
}
HTTP request
POST https://vgw.googleapis.com/gsp/google-card-fop-api/v1/chargebackNotification/:PIAID
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "requestHeader": { object (RequestHeader) }, "paymentIntegratorAccountId": string, "captureRequestId": string, "amount": string, "chargebackStage": enum ( |
Fields | |
---|---|
requestHeader |
REQUIRED: Common header for all requests. |
paymentIntegratorAccountId |
REQUIRED: This is the payment integrator account identifier that identifies contractual constraints around this transaction. |
captureRequestId |
REQUIRED: A unique identifier for the capture that the chargeback is associated with. This is the |
amount |
REQUIRED: The amount of the chargeback, in micros of the currency unit. This must be greater than zero and less than or equal to the amount in the |
chargebackStage |
REQUIRED: This represents whether this was the first or second chargeback event for this capture. A second chargeback, also known as Second Presentment or Pre-arbitration is when the result of an initial chargeback was challenged. The second chargeback is a separate event that can also be reversed. Once a second chargeback event has occurred the payment is in a terminal state and no subsequent chargeback events can be added. |
reasonCode |
REQUIRED: The reason the transaction is being charged back. |
rawResult |
REQUIRED: Raw result of the chargeback request from the issuer. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact chargeback code that was received from the VISA network. In that case, the |
chargebackDate |
REQUIRED Timestamp of the date that the chargeback was requested. If that date is not known then the date that the payment integrator received the notification for a chargeback. It is represented as milliseconds since epoch. This is a date and therefore should be the first millisecond of the day in the America/Los Angeles timezone. If it is not the first millisecond of the day the date will be assumed to be the day the specified millisecond falls on in the America/Los Angeles time zone. |
replyByDate |
REQUIRED: Timestamp of the date by which a reply must be received by the payment integrator if Google chooses to represent the transaction and challenge the chargeback. It is represented as milliseconds since epoch. This is a date and therefore should be the first millisecond of the day in the America/Los Angeles timezone. If it is not the first millisecond of the day the date will be assumed to be the day the specified millisecond falls on in the America/Los Angeles time zone. |
caseId |
REQUIRED: A unique value assigned to each chargeback that the issuer and payment integrator can use to identify this chargeback. |
Response body
This method supports multiple return types. For additional information about what 4XX or 5XX HTTP status code to return with an ErrorResponse
, consult the ErrorResponse
object and HTTP status codes documentation.
Possible response messages | |
---|---|
HTTP 200 Status |
|
HTTP 4XX / 5XX Status |
|
ChargebackStage
The reason the transaction is being charged back.
Enums | |
---|---|
UNKNOWN_STAGE |
Do not ever set this default value! |
FIRST |
This is the first chargeback request for this capture. |
SECOND |
This is the second chargeback request for this capture. This is used when a chargeback has already been attempted but was reversed and the issuer is requesting a second chargeback for a different amount or for a different reason. |
ChargebackNotificationResponse
Response object for Google hosted card-fop-v1.chargebackNotification method.
JSON representation |
---|
{
"responseHeader": {
object (ResponseHeader)
},
"result": enum ( |
Fields | |
---|---|
responseHeader |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this call. |
ChargebackNotificationResultCode
Result codes for the chargebackNotification
method.
Enums | |
---|---|
UNKNOWN_RESULT |
Do not ever set this default value! |
SUCCESS |
Chargeback notification was successfully processed. |