Google Pay
This page contains descriptions of parameters and codes applicable to integrating Google Pay with Velocity API.
Initialize Payment Request Parameters
The Initialize Request parameters for using Google Pay are listed in the tables below.
Parameters for Initializing Payments
Parameter | Type | Required | Description |
---|---|---|---|
client-id | Integer | Yes | The unique ID configured for a merchant on the Velocity POP. |
productid | Integer | No | The product of a merchant. For example, ticket and insurance. |
Currency-id | Integer | No | The currency configured for a country. It depends on the configuration available with Velocity. |
account | Integer | No | The unique ID associated with a payment transaction. It is optional. If you omit this parameter, the payment transaction is associated with the default sub-account. |
order-no | String | Yes | The order ID that a merchant generates. It is an alphanumeric string. Note: Some Payment Providers have strict guidelines for the order-no. The recommended pattern is [a-zA-Z0-9._-] |
accept-url | String | No | The URL where Velocity directs a customer after successfully completing a payment transaction. Note: If you do not provide this parameter, Velocity uses the default URL. The URL is used for redirecting back to the HPP or the merchant’s page after a payment completion. |
cancel-url | String | No | The absolute URL where Velocity directs customers if they cancel a payment transaction midway. Note: If you do not provide this parameter, Velocity uses the default URL. The URL is used for redirecting back to the HPP or the merchant’s page after a payment cancellation. |
decline-url | String | No | The absolute URL where Velocity directs customers if the payment transaction fails. The URL is used for redirecting back to the HPP or the merchant’s page after a payment failure. |
auth-url | String | No | The URL which is used for single sign-on (SSO) authentication if provided by an external system. |
session-id | Integer | No | The ID of a session used for multiple payment transactions during one payment flow. For example, a split payment or a retry of a failed payment transaction. |
product-type | String | No | The product type used to select the payment methods to be displayed or acquirer to be selected. The typical values include TICKET and INSURANCE. |
type-id | Integer | Yes | The type of a transaction. For example, 40 indicates a mobile application purchase and 30 indicates a web purchase. |
amount | Integer | Yes | The total amount that a customer is charged for a payment transaction in a country’s smallest currency. For example, the smallest currency of USD is a penny. If the transaction amount is $120.30, then the amount field contains the value 12030. |
country-id | Integer | Yes | The CPD-specific country code, which is available on request only. |
callback-url | String | No | The absolute URL to the back office of a merchant where Velocity POP sends the payment status. Velocity uses the default URL if merchants do not provide this parameter. |
auth-token | String | No | A unique token sent to the specified auth-url to authenticate customer when they pay with a stored card and use single sign-on. |
HMAC | String | No | The Message Authentication Code. It is calculated by creating a sha-512 hash comprising the following input fields in the listed order: • clientid • account • orderid • callback-url • amount • auth-url • customer-ref • auth-token • mobile • [salt] Note: CPD provides the salt value to merchants. MAC calculation secures the information sent by the merchant to Velocity by applying the SHA-512 encryption algorithm on key parts of the information sent to protect against tampering. The “salt” is the merchant's shared secret string used to ensure that MAC is unique. |
orders | Object | No | The order details which contain event, location, date or time, ticket type, cost, booking fee, quantity, and total price data. Note: This parameter is used for airline data only. |
Merchant Information Parameters
Parameter | Type | Required | Description |
---|---|---|---|
platform | String | Yes | The platform from which the request is sent. For example, web, iOS, Android, B2B, and B2C. |
sdk-version | Integer | Yes | The software development kit (SDK) version used. |
version | String | Yes | The version of the application programming interface (API) or application that sends the request. |
language | String | Yes | The language that Velocity uses as default when translating the payment pages. Velocity uses a default language set by a merchant if this parameter is omitted. Note: Velocity language codes are based upon the ISO- 639-1 standard. Refer http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes for details. |
mobile | Integer | Yes | The MSISDN of a customer without International Dialling Code. Note: Mobile number can be mandatory or optional, based on the requirement of a merchant or a PSP. |
country-id | Integer | No | The CPD-specific country code, which is provided on request. |
operator-id | Integer | No | The ID of a customer’s mobile network operator. CPD recommends including this parameter in a request to ensure that Velocity interacts with the operator accurately. |
String | No | The email address of a customer. If your customer provides this parameter, the Email input field on the Send Email Receipt page is automatically populated with this value. Note: Email can be mandatory or optional, based on the requirement of a merchant or a PSP. | |
customer-ref | String | No | The unique reference ID given by a merchant for a customer. Velocity uses this token to identify a user. The customer reference is included in the request to a specified auth-url to identify customers when they: • Pay with a stored card • Use single sign-on. Note: Customer-ref can be mandatory or optional, based on the requirement of a merchant or a PSP. |
Initialize Payment Response Parameters
The Initialize Response parameters when using Google Pay are listed in the tables below.
Parameter | Type | Required | Description |
---|---|---|---|
version | Integer | Yes | The version of the API or application that sends the request. |
Client-config Parameters
Parameter | Type | Required | Description |
---|---|---|---|
account | Integer | No | The number for the sub-account with which the payment transaction is associated. The Account ID is an integer greater than 100000 and account number is an integer smaller than 1000. The payment transaction is associated with the default sub-account if you do not provide this parameter. CPD recommends you provide this parameter. |
auto-capture | Boolean | Yes | Shows if you have enabled auto-capture |
mode | Integer | No | A parameter used in the SDK to switch between production and staging environment. |
store-card | Integer | Yes | It defines the type of configuration merchants have done to store cards. See the store-card table below for possible values. |
name | String | No | The name a merchant gives to a card as configured in Velocity. |
callback-url | String | Yes | The absolute URL to a merchant’s back office where Velocity sends the payment status. Note: If you do not provide this parameter, Velocity uses the default URL. This parameter is not applicable for most of the API-based integrations. |
accept-url | String | Yes | The absolute URL where Velocity directs a customer after successfully completing a payment transaction. Note: If you do not provide this parameter, Velocity uses the default URL. This parameter is not applicable for most of the API-based integrations. |
store-card
The table below shows possible values for the store-card
client-config parameter.
Integer | Meaning |
---|---|
0 | Cards are not stored |
1 | INVALID! |
2 | Stored cards are available for specific accounts only. |
3 | Use stored cards only and make them available for specific accounts only. The e-money based prepaid account is unavailable. |
4 | Stored cards are available for all accounts. Note: Velocity must be hosted by a Master Merchant. |
Transaction Parameters
Parameter | Type | Required | Description |
---|---|---|---|
auto-capture | Boolean | Yes | Shows if you have enabled auto-capture. |
eua-id | Integer | No | A parameter which identifies if the API to be called is for saving account or saving card. |
id | Integer | Yes | The unique ID of a merchant for Velocity platform. |
language | String | Yes | The language that Velocity uses as default when translating the payment pages. Velocity uses a default language set by a merchant if this parameter is omitted. Note: Velocity language codes are based upon the ISO- 639-1 standard. Refer http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes for details. |
mode | Integer | No | A parameter used in SDK to switch between production and staging environment. |
order-no | String | Yes | The order ID that a merchant generates for a customer. It is an alphanumeric string. Note: Some payment providers have strict guidelines for the order-no. The recommended pattern is "[a-zA-Z0-9._-] |
type-id | Integer | Yes | The type of application used for a transaction. For example, 40 indicates a mobile app purchase and 30 indicates a web purchase. |
country-id | Integer | Yes | The CPD-specific country code, provided to merchants on request. |
currency | String | Yes | The format of currency used for a transaction. |
format | String | Yes | The format in which price is presented. |
mobile country-id | Integer | Yes | The CPD-specific country code, which is made available to merchants on request. |
operator-id | Integer | Yes | The ID of a customer’s mobile network operator. CPD recommends including this parameter in the request to ensure Velocity correctly interacts with the operator. |
Session Parameters
Parameter | Type | Required | Description |
---|---|---|---|
id | Integer | Yes | The unique ID of a merchant for Velocity platform. |
total-amount | Integer | Yes | The total amount that a customer pays for a transaction. |
alpha2code | String | Yes | The three-letter alphabetic code for a currency. |
alpha3code | Integer | Yes | The two-letter numeric code for a country. |
code | Integer | Yes | The CPD currency code for a country. |
country-id | Integer | Yes | The CPD-specific country code, provided to merchants on request. |
currency | String | Yes | The format of currency used for a transaction. |
currency-id | Integer | Yes | The currency code of a currency. |
format | String | Yes | The format in which price is presented. |
symbol | Yes | A symbol used to indicate the currency of a country. |
Card Parameters
Parameter | Type | Required | Description |
---|---|---|---|
cvc-length | Integer | Yes | The length of the card verification code (CVC) number on a card. |
cvcmandatory | Boolean | Yes | Indicates if the CVC is mandatory for a transaction. The value can be true or false. It is used for a wallet transaction. |
dcc | Boolean | Yes | Indicates if currency conversion is available. The value can be true or false. |
enabled | Boolean | Yes | Shows if the card was enabled. |
installment | String | No | This is no longer used in a transaction. |
min-length | Integer | Yes | The minimum length of a card number. |
max-length | Integer | Yes | The maximum length of a card number. |
payment-type | String | Yes | The type of payment. For example, card, wallet, or APM. |
preferred | Boolean | Yes | Shows if a customer has set a card as a preferred one. |
processor-type | String | Yes | The type of processor used to process payment. |
psp-id | Integer | Yes | The ID of a PSP used for a card. |
state-id | Integer | Yes | The state of a card. For example, enabled or disabled by PSP. |
type-id | Integer | Yes | The type of application used for a transaction. For example, 40 indicates a mobile app purchase and 30 indicates a web purchase. |
name | String | Yes | The name of a card type. For example, wallet or PSP. |
Note: The wallets, APM, and gateway have the same parameters as card parameters in this table.
Authorize Request Parameters
The Authorize Request parameters when integrating with Google Pay are listed in the tables below.
Authorize-payment Parameters
Parameter | Type | Required | Description |
---|---|---|---|
account | Integer | No | The number for a sub-account with which a payment transaction is associated. The account ID is an integer greater than 100000 and account number is an integer smaller than 1000. The payment transaction is associated with the default sub-account if merchants do not provide this parameter. |
client-id | Integer | Yes | The unique ID of a merchant. |
Transaction Parameters
Parameter | Type | Required | Description |
---|---|---|---|
id | Integer | Yes | The ID of the transaction. |
type-id | Integer | Yes | A unique transaction identification number. |
card network | Enum | No | A list to identify the card network from which the token was obtained. It takes one of the following values: • amex • dankort • dinersclub • jcb • maestro • mastercard • visa • visaelectron • discover |
Card Parameters
Parameter | Type | Required | Description |
---|---|---|---|
currency-id | Integer | Yes | The country currency code of a currency. |
country-id | Integer | Yes | The CPD-specific country code, which is made available to merchants on request. |
token | String | No | The base64 encoded cryptogram for a third-party wallet such as Google Pay. |
hmac | String | No | The Message Authentication Code (MAC). It is calculated by creating a sha-512 hash comprising the following input fields in the listed order: • clientid • account • orderid • callback-url • amount • auth-url • customer-ref • auth-token • mobile • [salt] Note: CPD provides the salt value to merchants. MAC calculation secures the information sent by the merchant to Velocity by applying the SHA-512 encryption algorithm on key parts of the information sent to protect against tampering. The “salt” is the merchant's shared secret string used to ensure that MAC is unique. |
Address Parameters
Parameter | Type | Required | Description |
---|---|---|---|
country-id | Integer | Yes | The CPD-specific country code, which is made available to merchants on request. |
full-name | String | Yes | The full name of a customer. |
street | String | Yes | The full address of a customer with street name and street number. |
postal-code | String | Yes | The postal code of a customer. |
city | String | Yes | The city in which a customer resides. |
state | String | No | The state in which a customer resides. Customers enter this parameter only if their country of residence is divided onto states. |
country-id | Integer | Yes | The CPD-specific country code, which is made available to merchants on request. |
Client Information Parameters
Parameter | Type | Required | Description |
---|---|---|---|
language | String | Yes | The language that Velocity uses as default when translating the payment pages. Note: Velocity language codes are based upon the ISO- 639-1 standard. Refer https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes for details. |
version | String | Yes | The version of an API or application that sends the request. |
platform | String | Yes | The platform from which the request is sent. For example, web, iOS, Android, B2B, and B2C. |
mobile operator-id | Integer | Yes | The ID of a customer’s mobile network operator. CPD recommends including this parameter in the request to ensure Velocity correctly interacts with the operator. |
String | No | The email address of a customer. If a customer provides this parameter, the Email input field on the Send Email Receipt page is automatically populated with this value. |
Transaction Call Back Request
When integrating Google Pay with Velocity API, the transaction status along with additional transaction information is posted to the callback URL configured for a merchant. There are two callback requests posted to the URL where the status codes indicate the following:
Code | Description |
---|---|
Invalid amount | For example, 0.01. |
Missing mandatory request field | For example, element 'card': The attribute 'type-id' is required but missing. |
The following parameters are sent in the callback:
Field | Required | Description |
---|---|---|
mpoint-id | Yes | This is the transaction/@id generated during initialize step. |
session-id | Yes | Internal session ID. |
orderid | Yes | This is the transaction/@order-no in the initialize request, like PNR. |
status | Yes | Transaction status code indicates successful or failure. |
mobile | Yes | If present in the transaction requests, same will be returned. |
amount | Yes | Transaction amount. |
Fee | Yes | Default is 0. |
currency | Yes | Transaction code. |
language | Yes | If present in the transaction requests, same will be returned. |
operator | Yes | If present in the transaction requests, same will be returned. |
Status Codes
Code | Description |
---|---|
2000 and 2001 | Transaction successful. |
2010 | Transaction failed. |
4021 | Session failed; maximum attempts exceeded. |
4030 | Session successfully completed. |
4031 | Session partially completed. |
4021 | Session failed or declined. |
Updated 3 months ago