Method: transferFunds

AI-generated Key Takeaways

• Initiates money movement between a Google user's account and a payment processor using a unique requestId and paymentIntegratorAccountId combination.

• The request body includes details like the transaction amount, description, payment token, and payee proxy information.

• The response body indicates the transaction status, which can be either a success/failure result or an indication that the result is not yet known.

• The API supports multiple response types, including a success response (HTTP 200) and error responses (HTTP 4XX/5XX) with detailed error information.

• Payee proxy information is used to identify the recipient of the funds using various methods like QR codes, phone numbers, or national IDs.

• HTTP request
• Request body
  • JSON representation
• Response body
• TransferFundsResponse
  • JSON representation

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.

An example request looks like:

{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "liUrreQY233839dfFFb24gaQM",
    "requestTimestamp": "1502220434778"
  },
  "paymentIntegratorAccountId": "InvisiCash",
  "googlePaymentToken": "ZXhhbXBsZSB1bmlxdWUgcGF5bWVudCB0b2tlbiB2YWx1ZQ",
  "transactionDescription": "Google - Music",
  "amount": {
    "amountMicros": "728000000",
    "currencyCode": "INR"
  },
  "payeeProxy": {
    "payeeProxyKey": {
      "qrCode": "QrCode",
      "networkId": "PaymentNetwork1"
    }
  }
}

An example response looks like:

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

HTTP request

POST https://www.integratorhost.example.com/integrator-base-path/e-wallets-v1/transferFunds

Request body

The request body contains data with the following structure:

JSON representation

{ "requestHeader": { object (RequestHeader) }, "paymentIntegratorAccountId": string, "transactionDescription": string, "amount": { object (Amount) }, // Union field payment_token can be only one of the following: "googlePaymentToken": string // End of list of possible types for union field payment_token. // Union field funds_destination can be only one of the following: "payeeProxy": { object (PayeeProxyDestination) } // End of list of possible types for union field funds_destination. }

Fields
requestHeader	object (RequestHeader) REQUIRED: Common header for all requests.
paymentIntegratorAccountId	string REQUIRED: This is the payment integrator account identifier that identifies contractual constraints around this transaction.
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 tokenized account that was associated during the associateAccount method. This identifies the payer tokenized account in this call. payment_token can be only one of the following:
googlePaymentToken	string
Union field funds_destination. REQUIRED: The destination of the funds transfer. funds_destination can be only one of the following:
payeeProxy	object (PayeeProxyDestination) Payee that is referenced by a PayeeProxyKey

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)

TransferFundsResponse

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.