Method: paycache.cardFulfillmentStatusNotification

A notification that a card's fulfillment status has changed, e.g., it has been shipped.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": {
      "epochMillis":1481899949606
    },
    "paymentIntegratorAccountId": "abcdef123456"
  },
  "googleInstrumentToken": "Instrument12345",
  "fulfillmentStatus": {
    "shipped": {
      "shippingCarrier": "SHIPPING_CARRIER_UPS",
      "trackingId": "1Z 999 AA1 01 2345 6784"
    }
  }
}

An example response looks like:


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

HTTP request

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

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "googleInstrumentToken": string,
  "fulfillmentStatus": {
    object (FulfillmentStatus)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

googleInstrumentToken

string

REQUIRED: Contains the googleInstrumentToken value that was provided during the issueCard call.

fulfillmentStatus

object (FulfillmentStatus)

REQUIRED: The fulfillment status of the card.

Response body

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

Response object for the cardFulfillmentStatusNotification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

object (Result)

REQUIRED: Details corresponding to the result.

FulfillmentStatus

JSON representation
{

  // Union field fulfillment_state can be only one of the following:
  "issued": {
    object (Empty)
  },
  "ordered": {
    object (Empty)
  },
  "shipped": {
    object (DeliveryDetails)
  },
  "delivered": {
    object (DeliveryDetails)
  }
  // End of list of possible types for union field fulfillment_state.
}
Fields

Union field fulfillment_state.

fulfillment_state can be only one of the following:

issued

object (Empty)

The card was has been issued with the bank.

ordered

object (Empty)

The card was ordered with the manufacturer.

shipped

object (DeliveryDetails)

The card was shipped.

delivered

object (DeliveryDetails)

The card was delivered.

DeliveryDetails

JSON representation
{
  "shippingCarrier": enum (ShippingCarrier),
  "trackingId": string
}
Fields
shippingCarrier

enum (ShippingCarrier)

REQUIRED: The carrier mailing the card.

trackingId

string

OPTIONAL: Tracking identifier, if available.

ShippingCarrier

Enums
SHIPPING_CARRIER_UNSPECIFIED DO NOT USE
SHIPPING_CARRIER_USPS The US Postal Service was used to ship the card.
SHIPPING_CARRIER_UPS UPS was used to ship the card.
SHIPPING_CARRIER_FEDEX FedEx was used to ship the card.

Result

Details corresponding to the result.

JSON representation
{
  "success": {
    object (Empty)
  }
}
Fields
success

object (Empty)

The notification was received successfully.