Method: transferFunds

Initiates money movement between a customer's account held with Google and the payment processor. The combination of requestId within the header and paymentIntegratorAccountId is the idempotency key and uniquely identifies this transaction. All mutations on this transaction (refunds) populate the requestId value in the capture_request_id 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": {
        "accountNumber": {
          "localAccountNumber": "1234-5678-91"
         },
        "swiftBic": "XXXXSGS0XXX"
    },
    "bankAccountOwner": {
      "name": "Sam User"
    }
  },
  "transferFundsContext": {}
}

An example response looks like:


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

HTTP request

POST https://www.integratordomain.com/v2/transferFunds

Request body

The request body contains data with the following structure:

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

  // Union field payment_token can be only one of the following:
  "googlePaymentToken": {
    object (GooglePaymentToken)
  },
  "vendorPaymentToken": {
    object (VendorPaymentToken)
  }
  // End of list of possible types for union field payment_token.

  // Union field funds_destination can be only one of the following:
  "googleBankAccount": {
    object (GoogleBankAccount)
  },
  "destinationBankAccount": {
    object (DestinationBankAccount)
  },
  "payeeProxy": {
    object (PayeeProxyDestination)
  },
  "googlePaymentTokenPayee": {
    object (GooglePaymentToken)
  },
  "vendorPaymentTokenPayee": {
    object (VendorPaymentToken)
  }
  // End of list of possible types for union field funds_destination.
}
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

Union field payment_token. 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. payment_token can be only one of the following:
googlePaymentToken

object (GooglePaymentToken)

vendorPaymentToken

object (VendorPaymentToken)

Union field funds_destination.

funds_destination can be only one of the following:

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)

vendorPaymentTokenPayee

object (VendorPaymentToken)

Response body

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

Response object for the funds transfer method.

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

  // Union field transaction_status can be only one of the following:
  "result": {
    object (TransferFundsResult)
  },
  "resultNotKnownYet": {
    object (TransactionResultNotKnownYet)
  }
  // End of list of possible types for union field transaction_status.
}
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

Union field transaction_status. REQUIRED: The result of this funds transfer. transaction_status can be only one of the following:
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.

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.