- HTTP request
- Request body
- Response body
- DisburseFundsResult
- DisburseFundsResultCode
- RawResult
- DisburseFundsResultNotificationResultCode
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.
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
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.ErrorResponse
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://vgw.googleapis.com/secure-serving/gsp/v1/disburseFundsResultNotification/:PIAID
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "requestHeader": { object ( |
Fields | |
---|---|
requestHeader |
REQUIRED: Common header for all requests. |
paymentIntegratorAccountId |
REQUIRED: Payment integrator account identifier on which the disbursement occurred. |
disburseFundsRequestId |
REQUIRED: A unique identifier for this transaction. This is the This is a string with a max length of 100 characters and contains only the characters "a-z", "A-Z", "0-9", ":", "-", and "_". |
disburseFundsResult |
REQUIRED: Result of this disburse funds call. |
Response body
Response object for the disburseFundsResultNotification
method.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
responseHeader |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this call. |
DisburseFundsResult
Information about the final result of a disbursement.
JSON representation |
---|
{ "disburseFundsResultCode": enum ( |
Fields | |
---|---|
disburseFundsResultCode |
REQUIRED: Result code of this disbursement. |
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 This value is required if the |
Union field
|
|
transactionMaxLimit |
OPTIONAL: If This amount is micros of the same |
transactionMinLimit |
OPTIONAL: If This amount is micros of the same |
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. |
RawResult
Raw result object.
JSON representation |
---|
{ "scope": string, "rawCode": string } |
Fields | |
---|---|
scope |
OPTIONAL: Scope of the rawCode, can be empty. |
rawCode |
REQUIRED: Raw code from the integrator or subsystems within it. |
DisburseFundsResultNotificationResultCode
Result codes for the disburseFundsResultNotification
method.
Enums | |
---|---|
UNKNOWN_RESULT |
Do not ever set this default value! |
SUCCESS |
The notification was successfully processed. |