See the following sections for descriptions of Get Transaction Status response parameters:

For Get Transaction Status sample code, see Get Transaction Status.

`session`

Parent: root

The session element is required when retrieving a session status, and it has the following attributes:

Parameter	Format	Requirement	Description
`id`	Integer	Conditional Requirement: Required when retrieving a session status.	The CPD session ID for the session whose status you are requesting. Applicable to a session status response.
`total-amount`	Integer	Conditional Requirement: Required when retrieving a session status.	The total amount of the transaction. Applicable to a session status response.
`type`	Integer	Conditional Requirement: Required when retrieving a session status.	The session type. Possible values: • `1` - normal payment • `2` - split payment Applicable to a session status response.

`amount`

Parent: root: session

The amount element within session is required when retrieving a session status, and it has the following attributes:

Parameter	Format	Requirement	Description
`alpha2code`	String	Optional	The two-letter code for the country whose currency is used in this session. Applicable to a session status response.
`alpha3code`	String	Optional	The three-letter code for the country whose currency is used in this session. Applicable to a session status response.
`code`	Integer	Optional	The numeric code for the currency used in this session. See Reference for possible values. Applicable to a session status response.
`country-id`	Integer	Optional	The numeric code for the country whose currency is used in this session. See Reference for possible values. Applicable to a session status response.
`currency`	String	Optional	The three-letter code for the currency used in this session. Applicable to a session status response.
`currency-id`	Integer	Optional	The currency configured for the country. This depends on the configuration available with Velocity. See Reference for possible values. Applicable to a session status response.
`format`	String	Optional	The format in which this session's total amount is presented. Applicable to a session status response.
`symbol`	String	Optional	The symbol used to indicate the currency used in this session. Applicable to a session status response.

The amount element has the following text content:

Parameter	Format	Requirement	Description
amount	Integer	Conditional Requirement: Required when retrieving a session status.	The total amount of the session in the 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`. Applicable to a session status response.

`status`

Parent: root: session

The status element within session is required when retrieving a session status, and it has the following text content:

Parameter	Format	Requirement	Description
status	Integer	Conditional Requirement: Required when retrieving a session status.	The session's status code. See Reference for possible values. Applicable to a session status response.

`transaction`

Parent: root: refund

Please note:

The transaction element is required.
When retrieving a session status, the response may contain multiple transaction elements, each providing information on one transaction in a split payment session.

The transaction element has the following attributes:

Parameter	Format	Requirement	Description
`accountid`	Integer	Required	The number for the sub-account with which the payment transaction is associated.
`approval-code`	Integer	Required	The unique ID that a PSP provides for a transaction.
`card-id`	Integer	Required	The ID that identifies the card type, such as MasterCard or Visa. See Reference for possible values.
`clientid`	Integer	Required	The merchant-generated ID for the customer.
`extid`	Integer	Required	The external ID.
`id`	Integer	Required	The unique ID of the transaction.
`language`	String	Required	Default language encoding set during client onboarding.
`mpoint-id`	Integer	Required	Velocity’s unique ID for the payment transaction.
`order-no`	Integer	Required	The order ID number the merchant provides when a transaction is initiated.
`payment-method-id`	Integer	Required	The type of method used for payment. For example, card, APM, or wallet.
`psp-id`	Integer	Required	ID of the transaction at PSP or ACQ. This is unique for every transaction.
`session-id`	Integer	Required	The session ID that Velocity sends as a callback request.
`session-type`	Integer	Required	The session type. Possible values: • `1` - normal payment • `2` - split payment
`walletid`	Integer	Required	The ID of the wallet used.
`txn-type-id`	Integer	Conditional Requirement: Required when retrieving a session status.	The numeric code describing the transaction type. See Reference for possible values. Applicable to a session status response.

`amount`

Parent: root: refund: transaction

The amount element is required, and it has the following attributes:

Parameter	Format	Requirement	Description
`conversionRate`	Integer	Required	The conversion rate given by FX. If you do not subscribe to FX, the value of this field is 1.
`country-id`	Integer	Required	The country ID for the transaction currency. See Reference for possible values.
`currency`	Integer	Required	The numeric code for the transaction currency. See Reference for possible values.
`currency-code`	String	Required	The format of currency used for a transaction.
`decimals`	Integer	Required	The currency precision; for example, `2` for USD for the currency parameter. If you subscribe to FX, this field contains the converted currency in decimals.
`format`	String	Optional	The format in which the currency and price are displayed; for example, `{CURRENCY}{PRICE}`.
`pending`	Integer	Required	The amount of the total that is pending after this transaction.
`symbol`	String	Required	The symbol used to indicate the transaction's currency.

The amount element has the following text content:

Parameter	Format	Requirement	Description
amount	Integer	Required	The amount of the transaction.

`card-mask`

Parent: root: refund: transaction

The card-mask element is required when retrieving a card transaction status, or for the first transaction with a specific card when retrieving a session status.

The card-mask element has the following text content:

Parameter	Format	Requirement	Description
masked card number	String	Conditional Requirement: Required when retrieving a card transaction status. Required for the first transaction returned for a specific card when retrieving a session status.	The masked card number.

`dummy-account-number`

Parent: root: refund: transaction

The dummy-account-number element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
dummy account number	Integer	Optional	A dummy account number. Applicable to a transaction status response.

`card-expiry`

Parent: root: refund: transaction

The card-expiry element is required when retrieving a card transaction status, or for the first transaction with a specific card when retrieving a session status.

The card-expiry element has the following text content:

Parameter	Format	Requirement	Description
expiration date	String	Conditional Requirement: Required when retrieving a card transaction status. Required for the first transaction returned for a specific card when retrieving a session status.	The card's expiration date, in MM/YY format.

`card-name`

Parent: root: refund: transaction

The card-name element is required, and it has the following text content:

Parameter	Format	Requirement	Description
card name	String	Required	A customer-provided name to distinguish the card from their other saved payment methods.

`psp-name`

Parent: root: refund: transaction

The psp-name element is required, and it has the following text content:

Parameter	Format	Requirement	Description
PSP name	String	Required	The name of the PSP or ACQ used for completing the transaction. For example, 2C2P, 2C2P-ALC, GlobalPayment, Worldpay, or ChasePayment.

`accept-url`

Parent: root: refund: transaction

The accept-url element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
accept URL	String	Optional	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`

Parent: root: refund: transaction

The cancel-url element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
cancel URL	String	Optional	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.

`css-url`

Parent: root: refund: transaction

The css-url element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
CSS URL	String	Optional	A CSS URL used to include a style sheet file.

`logo-url`

Parent: root: refund: transaction

The logo-url element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
logo URL	String	Optional	A URL used to include a logo image.

`google-analytics-id`

Parent: root: refund: transaction

The google-analytics-id element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
Google Analytics ID	String	Optional	The Google Analytics tracking ID for the website.

`form-method`

Parent: root: refund: transaction

The form-method element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
method	String	Optional	The method used for this request.

`auto-redirect`

Parent: root: refund: transaction

The auto-redirect element is required, and it has the following text content:

Parameter	Format	Requirement	Description
auto-redirect	Boolean	Required	If `true`, the customer is automatically redirected to one of the URLs provided.

`createdDate`

Parent: root: refund: transaction

The createdDate element is required, and it has the following text content:

Parameter	Format	Requirement	Description
created date	String, in YYYY-MM-DD format	Required	The date the transaction was created.

`createdTime`

Parent: root: refund: transaction

The createdTime element is required, and it has the following text content:

Parameter	Format	Requirement	Description
created time	String, in HH:MM:SS format	Required	The time the transaction was created.

`status`

Parent: root: refund: transaction

Please note:

The status element is required when retrieving a card transaction status, or for the first transaction with a specific card when retrieving a session status.
The status element must have at least one status-message child. It may have multiple status-message children.
See response code samples in Get Transaction Status for examples of possible values.

Each status-message child element has the following attributes:

Parameter	Format	Requirement	Description
`id`	Integer	Conditional Requirement: Required when `status-message` is present.	The status code of the session. See Reference for possible values.
`position`	Integer	Conditional Requirement: Required when `status-message` is present.	The position of the status code.

The status-message child element has the following text content:

Parameter	Format	Requirement	Description
status message	String	Conditional Requirement: Required when `status-message` is present.	The status message. See Reference for possible values.

`sign`

Parent: root: refund: transaction

The sign element is required, and it has the following text content:

Parameter	Format	Requirement	Description
sign	String	Required

`client-info`

Parent: root: refund: transaction

The client-info element is required, and it has the following attributes:

Parameter	Format	Requirement	Description
`language`	String	Optional	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 to http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes for details.
`platform`	String	Conditional Requirement: Required when retrieving a card transaction status. Required for the first transaction returned for a specific card when retrieving a session status.	The type of platform from which the request is sent.
`profileid`	Integer	Conditional Requirement: Required when retrieving a card transaction status. Required for the first transaction returned for a specific card when retrieving a session status.	The ID of the client's profile in the merchant database.

`mobile`

Parent: root: refund: transaction: client-info

The mobile element is optional, and it has the following attributes:

Parameter	Format	Requirement	Description
`country-id`	Integer	Conditional Requirement: Required if mobile number is present.	The CellPoint Digital-specific country code. This is available in Reference.
`operator-id`	Integer	Optional	The ID of a customer’s mobile network operator. CellPoint Digital recommends including this parameter in a request to ensure that Velocity interacts with the operator accurately.

The mobile element has the following text content:

Parameter	Format	Requirement	Description
mobile number	Integer	Conditional Requirement: A mobile number can be mandatory or optional, based on the requirement of a merchant or a PSP.	The MSISDN of a customer without International Dialing Code.

`email`

Parents: root: refund: transaction: client-info

The email element can be mandatory or optional, based on the requirement of a merchant or a PSP. It has the following text content:

Parameter	Format	Requirement	Description
email	String	Conditional Requirement: Email can be mandatory or optional, based on the requirement of a merchant or a PSP.	The customer's email address.

`customer-ref`

Parents: root: refund: transaction: client-info

The customer-ref element can be mandatory or optional, based on the requirement of a merchant or a PSP. It has the following text content:

Parameter	Format	Requirement	Description
customer reference ID	String	Conditional Requirement: Can be mandatory or optional, based on the requirement of a merchant or a PSP.	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, or • Use single sign-on.

`device-id`

Parents: root: refund: transaction: client-info

The device-id element is optional for a web channel, and it has the following text content:

Parameter	Format	Requirement	Description
device ID	String	Conditional Requirement: Optional for a web channel.	The device ID of the device used in the transaction.

`additional-data`

Parent: root: refund: transaction

Note the following:

The additional-data element is optional; it contains additional information about the transaction.
The additional-data element can have multiple param children.
Each param child element has:
- one attribute, and
- text content defined by that attribute.

The table below describes the possible attribute values and their associated text content.

Attribute	Attribute Value	Requirement	Text Content Format	Text Content Value
`name`	`pre_auth_ext_status_code`	Optional	Integer	The pre-auth fraud check system response code.
`name`	`eci`	Optional	Integer	Electronic Commerce Indicator (ECI). This indicates the outcome of the 3DS verification. Possible values: • 02 or 05 - Fully Authenticated Transaction • 01 or 06 - Attempted Authentication Transaction • 00 or 07 - Non 3-D Secure Transaction • Mastercard - 02, 01, 00 • Visa - 05, 06, 07 • Amex - 05, 06, 07 • JCB - 05, 06, 07 • Diners - 05, 06, 07
`name`	`merchant`	Optional	String	The name of the merchant for the transaction.
`name`	`issuer-approval-code`	Optional	Integer	The issuer's approval code.
`name`	`hmac`	Optional	String	The Message Authentication Code (MAC). It is calculated by creating a SHA-512 hash comprising the input fields in the order listed in the Message Authentication Code table. 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. Note: CellPoint Digital provides the salt value to merchants. Conditional parameters in the Message Authentication Code table are optional if not provided in request; if the conditional parameters are present in request, they are mandatory here.
`name`	`card-holder-name`	Optional	String	The name on the payment card being used in this transaction.
`name`	`pre_auth_ext_id`	Optional	Integer	The pre-auth fraud check system transaction ID.
`name`	`pre_auth_ext_status_code`	Optional	Integer	The pre-auth fraud check system response code.
`name`	`Response_Code`	Optional	Integer	The response code.
`name`	`hold_fee_amount`	Optional	Integer	The amount of the hold fee. Applicable to a session status response.
`name`	`hold_fee_currency_code`	Optional	String	The three-letter currency code for the hold fee. Applicable to a session status response.
`name`	`platform`	Optional	String	The type of platform from which the request is sent. For example, web, iOS, Android, B2B, and B2C.
`name`	`_ga`	Optional	String
`name`	`office_id`	Optional	String	A merchant-generated ID used for internal reference.
`name`	`invoiceid`	Optional	Integer	The invoice ID for the transaction.

`address`

Parent: root: refund: transaction

The address element is optional, and it defines the customer's address. It has the following children: first-name, last-name, street, street2, postal-code, city, state, country, mobile, and email.

The first-name child element has the following text content:

Parameter	Format	Requirement	Description
first name	String	Optional	The customer's first name.

The last-name child element has the following text content:

Parameter	Format	Requirement	Description
last name	String	Optional	The customer's last name.

The street child element has the following text content:

Parameter	Format	Requirement	Description
street address	String	Optional	The first line of the customer's mailing address, including street name and number.

The street2 child element has the following text content:

Parameter	Format	Requirement	Description
street address 2	String	Optional	The second line of the customer's mailing address.

The postal-code child element has the following text content:

Parameter	Format	Requirement	Description
postal code	String	Optional	The postal code for the customer's mailing address.

The city child element has the following text content:

Parameter	Format	Requirement	Description
city	String	Optional	The city in the customer's mailing address.

The state child element has the following text content:

Parameter	Format	Requirement	Description
state	String	Optional	The state in the customer's mailing address.

The mobile child element has the following attribute:

Parameter	Format	Requirement	Description
`idc`	Integer	Conditional Requirement: Required if mobile number is present.	The CellPoint Digital-specific country code for the mobile number. This is available in Reference.

The mobile element has the following text content:

Parameter	Format	Requirement	Description
mobile number	Integer	Conditional Requirement: A mobile number can be mandatory or optional, based on the requirement of a merchant or a PSP.	The MSISDN of a customer without International Dialing Code.

The email child element has the following text content:

Parameter	Format	Requirement	Description
email address	String	Optional	The customer's email address.

`country`

Parent: root: refund: transaction: address

The country element is a child element of address, and it has four child elements: name, code, alpha2code, and alpha3code.

The name element has the following text content:

Parameter	Format	Requirement	Description
name	String	Optional	The name of the country in the customer's mailing address.

The code element has the following text content:

Parameter	Format	Requirement	Description
country code	Integer	Optional	The CellPoint Digital-specific country code, which is made available to merchants on request.

The alpha2code element has the following text content:

Parameter	Format	Requirement	Description
alpha 2 code	String	Optional	The two-letter numeric code for the country.

The alpha3code element has the following text content:

Parameter	Format	Requirement	Description
alpha 3 code	String	Optional	The three-letter alphabetic code for a currency.