- HTTP request
- Request body
- Response body
- GooglePaymentToken
- IssuerId
- AssociateAccountResponse
- AssociateAccountResult
- SuccessDetails
- UserInformation
Associates the customer's account with the payment processor to the Google instrument being added.
Account association happens after the integrator has authenticated the user. Association occurs through a server-to-server call that contains the requestId
for the associated authentication flow (authenticationRequestId
), an associationId
and a googlePaymentToken
(GPT). The payment processor should associate the associationId
and the googlePaymentToken
to the customer's account for authentication. The GPT is used to initiate payments. The associationId
is used during re-authentication calls to identify the account for authentication.
The combination of requestId
within the header and paymentIntegratorAccountId
is the idempotency key and uniquely identifies this association attempt.
If Google sends an associationId
or a googlePaymentToken
that the integrator has already seen during a different association attempt (different idempotency key), the expectation is this would throw an HTTP error.
If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type
.ErrorResponse
An example request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 2
},
"requestId": "cmVxdWVzdDE",
"requestTimestamp": {
"epochMillis": "1481899949606"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD"
},
"googlePaymentToken": {
"issuerId": {
"value": "InvisiCashUSA"
},
"token": "ZXhhbXBsZSB1bmlxdWUgcGF5bWVudCB0b2tlbiB2YWx1ZQ"
},
"authenticationRequestId": "bnAxdWTydDX==",
"associationId": "LmddbXBsZSByZWZlcmVuY2UgdG9rZW4gdmFsdWU_",
"provideUserInformation": true
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": "1481899949611"
}
},
"result": {
"success": {
"transactionLimits": {
"transactionMaxLimit": {
"limitAmount": {
"amountMicros": "100000000",
"currencyCode": "JPY"
}
}
},
"associatedAccountIdentifier": {
"accountId": "1234-5678-91"
},
"associatedAccountDetails": {
"accountNickname" : {
"partialAccountNickname": "***-91"
},
"accountAlias": {
"phoneNumber": {
"value": "+15555555555"
}
}
},
"userInformation": {
"name": "Example Customer",
"addressLine": ["123 Main St"],
"localityName": "Springfield",
"administrativeAreaName": "CO",
"postalCodeNumber": "80309",
"countryCode": "US"
}
}
}
}
HTTP request
POST https://www.integratorhost.example.com/integrator-base-path/v2/associateAccount
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "requestHeader": { object ( |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
provide |
REQUIRED: True if we want the integrator to provide the address associated with this account. |
google |
REQUIRED: The token that Google will use to initiate purchases with the payment processor. |
association |
REQUIRED: The identifier of this association. This identifier is created by Google and is sent during re-authentication flows to identify which account should be authenticated. This is a string that has a maximum length of 100 characters. |
Union field
|
|
authentication |
|
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 |
|
GooglePaymentToken
Describes a GooglePaymentToken (GPT), including the token and the issuer of the backing user account.
JSON representation |
---|
{
"issuerId": {
object ( |
Fields | |
---|---|
issuer |
REQUIRED: The identifier of the issuer of the backing user account. |
token |
REQUIRED: This is the token that both companies will use to identify the account for purchases between each other. |
IssuerId
A unique identifier for an issuer of user accounts.
JSON representation |
---|
{ "value": string } |
Fields | |
---|---|
value |
REQUIRED: The string value of the identifier. This unique identifier is defined by Google. Google will share a list with the identifiers for all external issuers available through the payment integrator. |
AssociateAccountResponse
Response object for the associate account method.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this association. |
AssociateAccountResult
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
success |
The account association was successful. |
user |
Even though the account authentication bundle was returned, the user authentication failed. |
not |
User's account is not eligible for this service. |
otp |
OTP did not match what the integrator sent. |
otp |
OTP was already used. |
otp |
User has requested or tried to verify too many OTPs. |
SuccessDetails
JSON representation |
---|
{ "transactionLimits": { object ( |
Fields | |
---|---|
transaction |
REQUIRED: Defines user scoped transaction limits. |
user |
REQUIRED: User information that the integrator knows and will share with Google about this customer. Used for risk information and address prepopulation. |
Union field
|
|
associated |
The account ID the user has with the integrator. |
bank |
The account ID the user has with a bank. |
Union field
|
|
associated |
Details about the account that was associated. |
bank |
Details about the bank account that was associated. |
UserInformation
Structure holding information about a user.
JSON representation |
---|
{ "name": string, "addressLine": [ string ], "localityName": string, "administrativeAreaName": string, "postalCodeNumber": string, "countryCode": string, "phone": string, "emailAddress": string } |
Fields | |
---|---|
name |
OPTIONAL: Customer's full name. |
address |
OPTIONAL: This holds unstructured Address text. |
locality |
OPTIONAL: This is something of a fuzzy term, but it generally refers to the city/town portion of an address. In regions of the world where localities are not well defined or do not fit into this structure well (for example, Japan and China), leave localityName empty and use addressLine. Examples: US city, IT comune, UK post town. |
administrative |
OPTIONAL: Top-level administrative subdivision of this country" Examples: US state, IT region, CN province, JP prefecture." |
postal |
OPTIONAL: Despite the name, postalCodeNumber values are frequently alphanumeric. Examples: "94043", "SW1W", "SW1W 9TQ". |
country |
OPTIONAL: Customer address country code, expected to be ISO-3166-1 Alpha-2. |
phone |
OPTIONAL: Customer's phone number. |
email |
OPTIONAL: Customer's email address. |