DisburseResult

  • The disburse result is represented in JSON format and indicates the outcome of a disbursement.

  • A successful transfer is indicated by the success field, while other fields represent various error conditions.

  • Error conditions include accountDoesNotSupportCurrency, accountClosed, and payeeProxyNotRegistered, each providing specific reasons for disbursement failure.

  • Each result type (success, accountDoesNotSupportCurrency, etc.) is further detailed in linked documentation for deeper understanding.

  • If the accountClosed error is returned, the user's instrument will be closed with Google, requiring them to add a new instrument.

Result for disburse.

JSON representation
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "success": {
    object (Empty)
  },
  "accountDoesNotSupportCurrency": {
    object (AccountDoesNotSupportCurrency)
  },
  "accountClosed": {
    object (AccountClosed)
  },
  "payeeProxyNotRegistered": {
    object (PayeeProxyNotRegistered)
  }
  // End of mutually exclusive fields.
}
Fields
REQUIRED: The possible results of this disbursement. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
success

object (Empty)

Successful transfer.

accountDoesNotSupportCurrency

object (AccountDoesNotSupportCurrency)

This account does not support the requested currency.

accountClosed

object (AccountClosed)

The user's account held with the integrator has been closed.

Returning this value will cause the user's instrument to be closed with Google. The user will be forced to add a new instrument by going through the association flow again.

payeeProxyNotRegistered

object (PayeeProxyNotRegistered)

The payee proxy is not registered.

End of mutually exclusive fields.