- HTTP request
- Request body
- Response body
- PayeeProxyDestination
- PayeeProxyKey
- ProxyKeyNationalId
- TransferFundsResponse
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.
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 ( |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
payment |
REQUIRED: This is the payment integrator account identifier that identifies contractual constraints around this transaction. |
transaction |
REQUIRED: This is the description of the transaction that can be put on the customer's statement. Localized to the userLocale found in the |
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: |
|
google |
|
Union field
|
|
payee |
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 |
|
HTTP 4XX / 5XX Status |
|
PayeeProxyDestination
Destination for Payee that uses a PayeeProxy key to reference a payee.
JSON representation |
---|
{
"payeeProxyKey": {
object ( |
Fields | |
---|---|
payee |
REQUIRED: Proxy Key that will be used for the Payee. |
payee |
OPTIONAL: |
PayeeProxyKey
ProxyKey that may be used as a Payee if the proxy key is registered with a PayeeProxy directory and may be used to query the registration status or to retrieve display information from the directory.
JSON representation |
---|
{ "networkId": string, // Union field |
Fields | |
---|---|
network |
REQUIRED: Network Id for the payee proxy. For example, 'PaymentNetwork1', 'PaymentNetwork2', etc. |
Union field proxy_key . Oneof proxy key for payee proxy key. proxy_key can be only one of the following: |
|
phone |
A proxy key that is a phone number. |
national |
A proxy key that is a national ID number. |
business |
A proxy key that is a business ID number. |
virtual |
A proxy key that is a virtual payment address. |
qr |
A proxy key that is a QR code. For example, an EMVCo QR. |
ProxyKeyNationalId
A proxy key that is a national ID number.
JSON representation |
---|
{ "nationalId": string, "issuingCountryCode": string } |
Fields | |
---|---|
national |
REQUIRED: The value of the national ID number. |
issuing |
REQUIRED: ID issuing country's country code, expected to be ISO-3166-1 Alpha-2. |
TransferFundsResponse
Response object for the funds transfer method.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
payment |
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 |
Result of the FundsTransfer operation. |
result |
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. |