Method: transferFunds

  • Initiates money movement between a customer's Google account and the payment processor.

  • Utilizes requestId and paymentIntegratorAccountId as the idempotency key for unique transaction identification.

  • Supports transferring funds to various destinations including Google Bank Accounts, external bank accounts, and Payee Proxies.

  • Responses indicate the transaction status, which can be either a definitive result or a pending status.

  • Includes detailed request and response structures with field descriptions and example JSON payloads.

Initiates money movement between a customer's account held with Google and the payment processor. The requestId within the header is the idempotency key and uniquely identifies this transaction. All mutations on this transaction (refunds) populate the requestId value in the captureRequestId field.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 2
    },
    "requestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
    "requestTimestamp": {
      "epochMillis": "1502220196077"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "googlePaymentToken": {
    "issuerId": {
      "value": "InvisiCash"
    },
    "token": "ZXhhbXBsZSB1bmlxdWUgcGF5bWVudCB0b2tlbiB2YWx1ZQ"
  },
  "transactionDescription": "Google - Music",
  "amount": {
    "amountMicros": "728000000",
    "currencyCode": "INR"
  },
  "destinationBankAccount": {
    "bankAccountId": {
      "usBankAccount": {
        "accountNumber": {
          "number": "1234-5678-91"
        },
        "bankIdentifier": {
          "swiftBic": {
            "value": "XXXXSGS0XXX"
          },
          "usAbaRoutingNumber":{
            "value": "206764189"
          }
        }
      }
    },
    "bankAccountOwner": {
      "name": "Sam User"
    }
  }
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1481900013178"
    }
  },
  "result": { "success": {} },
  "paymentIntegratorTransactionId": "aW50ZWdyYXRvciB0cmFuc2FjdGlvbiBpZA"
}

HTTP request

POST https://www.integratorhost.example.com/integrator-base-path/v2/transferFunds

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "transactionDescription": string,
  "amount": {
    object (Amount)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "googlePaymentToken": {
    object (GooglePaymentToken)
  },
  "vendorPaymentToken": {
    object (VendorPaymentToken)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "googleBankAccount": {
    object (GoogleBankAccount)
  },
  "destinationBankAccount": {
    object (DestinationBankAccount)
  },
  "payeeProxy": {
    object (PayeeProxyDestination)
  },
  "googlePaymentTokenPayee": {
    object (GooglePaymentToken)
  },
  "vendorPaymentTokenPayee": {
    object (VendorPaymentToken)
  }
  // End of mutually exclusive fields.
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.
transactionDescription

string

REQUIRED: This is the description of the transaction that can be put on the customer's statement. Localized to the userLocale found in the requestHeader. This format can be changed without notice and must never be parsed.
amount

object (Amount)

REQUIRED: The amount of the transfer
REQUIRED: This is the token that both companies will use to identify the bank account that was associated during the associateAccount method. This identifies the payer bank account in this call. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
googlePaymentToken

object (GooglePaymentToken)

The Google Payment Token identifying the payer bank account.
vendorPaymentToken

object (VendorPaymentToken)

The vendor payment token identifying the payer bank account.
End of mutually exclusive fields.
REQUIRED: The destination of the funds transfer. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
googleBankAccount

object (GoogleBankAccount)

A bank account that is owned by Google (as opposed to a user).
destinationBankAccount

object (DestinationBankAccount)

Destination account that is not held by Google.
payeeProxy

object (PayeeProxyDestination)

Payee that is referenced by a PayeeProxyKey
googlePaymentTokenPayee

object (GooglePaymentToken)

The Google Payment Token identifying the payee bank account.
vendorPaymentTokenPayee

object (VendorPaymentToken)

The vendor payment token identifying the payee bank account.
End of mutually exclusive fields.

Response body

This method supports multiple return types. For additional information about what 4XX or 5XX HTTP status code to return with an ErrorResponse, consult the ErrorResponse object and HTTP status codes documentation.

Possible response messages
HTTP 200 Status

object (TransferFundsResponse)
HTTP 4XX / 5XX Status

object (ErrorResponse)
End of mutually exclusive fields.

PayeeProxyDestination

Destination for Payee that uses a PayeeProxy key to reference a payee.

JSON representation 
{
  "payeeProxyKey": {
    object (PayeeProxyKey)
  },
  "payeeProxyLookupRequestId": string
}
Fields
payeeProxyKey

object (PayeeProxyKey)

REQUIRED: Proxy Key that will be used for the Payee.
payeeProxyLookupRequestId

string

OPTIONAL: requestId from a lookup for this PayeeProxyKey (if applicable). This value will be set when there was a DisplayInfo lookup done for this PayeeProxyKey in the context of this transfer.

TransferFundsResponse

Response object for the funds transfer method.

JSON representation 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorTransactionId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "result": {
    object (TransferFundsResult)
  },
  "resultNotKnownYet": {
    object (TransactionResultNotKnownYet)
  }
  // End of mutually exclusive fields.
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.
paymentIntegratorTransactionId

string

OPTIONAL: This identifier is specific to the integrator and is generated by the integrator. This is the identifier that the integrator knows this transaction by.

For convenience, this identifier is included with in the remittance details
REQUIRED: The result of this funds transfer. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
result

object (TransferFundsResult)

Result of the FundsTransfer operation.
resultNotKnownYet

object (TransactionResultNotKnownYet)

Captures the scenario where the integrator itself doesn't have a definite status, maybe because they have not received it from the underlying payment network.
End of mutually exclusive fields.