- HTTP request
- Request body
- Response body
- TransactionEventNotificationResponse
- TransactionEventNotificationResult
Notify Google of transaction event that has occurred for a Virtual Card enrollment.
An example request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 1
},
"requestId": "BKD0GF23KSD8S23",
"requestTimestamp": {
"epochMillis": "1481899949606"
},
"paymentIntegratorAccountId": "abcdef123456"
},
"enrollmentRequestId": "G1MQ0YERJ0Q7LPM",
"transactionUpdateAvailable": {},
"timestamp": {
"epochMillis": "1481899900000"
}
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": "1481899950236"
}
},
"result": {
"success" : {}
}
}
HTTP request
POST https://vgw.googleapis.com/gsp/virtual-cards-v1/transactionEventNotification/:PIAID
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "requestHeader": { object (RequestHeader) }, "enrollmentRequestId": string, "timestamp": { object (Timestamp) }, // Union field |
Fields | |
---|---|
requestHeader |
REQUIRED: Common header for all requests. |
enrollmentRequestId |
REQUIRED: A reference to an earlier enrollment request. Specifically, the identifier set in the This is a string that has a maximum length of 100 characters. |
timestamp |
REQUIRED: The timestamp of the event. This is the timestamp of when this event has occurred, not when it was sent. |
Union field
|
|
transactionUpdateAvailable |
New transactions or transaction updates are available. |
transactionDataDisabled |
Transaction data sharing has been disabled by the user. |
transactionDataEnabled |
Transaction data sharing has been enabled by the user. |
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 |
|
TransactionEventNotificationResponse
Response for the transactionEventNotification
method.
JSON representation |
---|
{
"responseHeader": {
object (ResponseHeader)
},
"result": {
object ( |
Fields | |
---|---|
responseHeader |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this call. |
TransactionEventNotificationResult
Result codes for the transactionEventNotification
method.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field result . REQUIRED: Contains the possible result types. Exactly one must be set. result can be only one of the following: |
|
success |
Transaction Event notification was successfully processed. |
unknownEnrollment |
Declined because the given |