Method: paycache.checkFundsAvailabilityScheduleNotification

Notifies Google of the funds availability schedule for a set of checks. The partner bank must provide a single schedule for all checks deposited on a particular day.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": {
      "epochMillis":1481899949606
    },
    "paymentIntegratorAccountId": "abcdef123456"
  },
  "googleAccountToken": "A1234567890",
  "depositDate": {
    "year":2020,
    "month":1,
    "day":1
  },
  "schedule": [
    {
      "availabilityDate": {
        "year":2020,
        "month":1,
        "day":2
      },
      "totalAvailable": {
        "amountMicros":100000000,
        "currencyCode": "USD"
      }
    },
    {
      "availabilityDate": {
        "year":2020,
        "month":1,
        "day":3
      },
      "totalAvailable": {
        "amountMicros":200000000,
        "currencyCode": "USD"
      }
    }
  ]
}

An example response looks like:


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

HTTP request

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

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "googleAccountToken": string,
  "depositDate": {
    object (Date)
  },
  "schedule": [
    {
      object (FundsAvailabilityNotice)
    }
  ]
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

googleAccountToken

string

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

depositDate

object (Date)

REQUIRED: The deposit date of the checks.

schedule[]

object (FundsAvailabilityNotice)

REQUIRED: The schedule of when funds are to be made available, represented as a series of notices for when funds are to be released.

Response body

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

Response for paycache.checkFundsAvailabilityScheduleNotification.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

object (Result)

REQUIRED: Contains the result of the request.

Date

A date object. This is not a Datetime. It is just a date -- meaning that it refers to a non-relative date like a birthdate.

JSON representation
{
  "year": string,
  "month": string,
  "day": string
}
Fields
year

string (Int64Value format)

REQUIRED: The year portion of the date.

month

string (Int64Value format)

REQUIRED: The month portion of the date. January is 1, February is 2, and so on.

day

string (Int64Value format)

REQUIRED: The day portion of the date. The first day of the month is 1.

FundsAvailabilityNotice

A notice that funds are to be released.

JSON representation
{
  "availabilityDate": {
    object (Date)
  },
  "totalAvailable": {
    object (Amount)
  }
}
Fields
availabilityDate

object (Date)

REQUIRED: The date the funds are to be made available.

totalAvailable

object (Amount)

The total amount of the checks, since deposited, that is now available.

Result

Details corresponding to the result.

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

object (Empty)

The notification was valid and is now being processed by Google.