Method: disburseFundsResultNotification

Notify Google of the result of a disbursement after the disburseFunds method call has been made.

The disburseFundsResult value is idempotent for this disburseFundsRequestId, so its value must be identical to the value returned during the disburseFunds call and cannot be changed by a subsequent call to this method.

Responses to this query may be empty if this method does not return an HTTP 200. They are 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 a HTTP 404 with an empty body.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 1,
      "revision": 0
    },
    "requestId": "KcgwSKrV76eVNDUbsZ4UA3",
    "requestTimestamp": "1481852928293"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "disburseFundsRequestId": "awNaC510cefae3IJdNEvW2"
  "disburseFundsResult": {
    "disburseFundsResultCode": "SUCCESS"
  }
}

An example response looks like:


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

HTTP request

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

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "disburseFundsRequestId": string,
  "disburseFundsResult": {
    object (DisburseFundsResult)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

paymentIntegratorAccountId

string

REQUIRED: Payment integrator account identifier on which the disbursement occurred.

disburseFundsRequestId

string

REQUIRED: A unique identifier for this transaction. This is the requestId generated by Google during the disburseFunds call which this request is associated with.

This is a string with a max length of 100 characters and contains only the characters "a-z", "A-Z", "0-9", ":", "-", and "_".

disburseFundsResult

object (DisburseFundsResult)

REQUIRED: Result of this disburse funds call.

Response body

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

Response object for the disburseFundsResultNotification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

enum (DisburseFundsResultNotificationResultCode)

REQUIRED: Result of this call.

DisburseFundsResult

Information about the final result of a disbursement.

JSON representation
{
  "disburseFundsResultCode": enum (DisburseFundsResultCode),
  "rawResult": {
    object (RawResult)
  },

  // Union field FailureDetail can be only one of the following:
  "transactionMaxLimit": string,
  "transactionMinLimit": string
  // End of list of possible types for union field FailureDetail.
}
Fields
disburseFundsResultCode

enum (DisburseFundsResultCode)

REQUIRED: Result code of this disbursement.

rawResult

object (RawResult)

OPTIONAL: Raw result of this disbursement. 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 decline code that was received from the VISA network. In that case, the scope would be "visa" and the rawCode would be whatever the VISA network returned.

This value is required if the result is not SUCCESS.

Union field FailureDetail.

FailureDetail can be only one of the following:

transactionMaxLimit

string (Int64Value format)

OPTIONAL: If disburseFundsResultCode is DISBURSEMENT_EXCEEDS_TRANSACTION_LIMIT then this is the value of the maximum allowable transaction. This is used for structured, user facing messaging and decline rate analysis.

This amount is micros of the same currencyCode as the original disburseFunds method call.

transactionMinLimit

string (Int64Value format)

OPTIONAL: If disburseFundsResultCode is DISBURSEMENT_UNDER_TRANSACTION_LIMIT then this is the value of the minimum allowable transaction. This is used for structured, user facing messaging and decline rate analysis.

This amount is micros of the same currencyCode as the original disburseFunds method call.

DisburseFundsResultCode

Result codes for a disburse funds call.

Enums
UNKNOWN_RESULT Do not ever set this default value!
SUCCESS Disbursement successful.
DISBURSEMENT_UNDER_TRANSACTION_LIMIT Requested disbursement amount does not meet the integrator's minimum per-transaction amount. If this code is used, populate the transactionMinLimit field with the minimum transaction amount for user messaging purposes.
DISBURSEMENT_EXCEEDS_TRANSACTION_LIMIT Requested disbursement amount exceeds the integrator's maximum per-transaction limit. If this code is used, populate the transactionMaxLimit field with the transaction limit for user messaging purposes.
ACCOUNT_CLOSED User's account held with the integrator has been closed. This return value will cause the user's instrument to be closed with Google. The user will be forced to add a new instrument.
ACCOUNT_CLOSED_ACCOUNT_TAKEN_OVER User's account with the integrator has been closed, suspected account take over. This return value will cause the user's instrument to be closed with Google. The user will be forced to add a new instrument.
ACCOUNT_CLOSED_FRAUD User's account held with the integrator has been closed because of fraud. This return value will cause the user's instrument to be closed with Google. The user will be forced to add a new instrument.
ACCOUNT_ON_HOLD User's account is on hold.

DisburseFundsResultNotificationResultCode

Result codes for the disburseFundsResultNotification method.

Enums
UNKNOWN_RESULT Do not ever set this default value!
SUCCESS The notification was successfully processed.