Velocity Developer Resources

API DOCS MENU

Stored Value Account Data Elements

The following Stored Value Account data elements are required in all Stored Value Account (SVA) transactions, unless noted otherwise. These data elements are included with each Stored Value Account transaction in addition to Base Transaction data elements.

Note: While the Base Transaction data elements are required, your application cannot send a transaction containing only Base Transaction data elements. Stored Value Account-specific transaction data is required to successfully process any Stored Value transaction.

CardData

Cardholder data. Conditional, required if IdType of the consumer identifier instance is a card (PAN or TrackData).

Parameter	Description	Data Type
AccountNumber	Card account number. Required.	String
Expire	Card expiration. Optional.	String
Track1Data	The actual data read from the magnetic stripe on a card. Application should strip Start and End Sentinels, LRC, and Track separators. Conditional, required if at least one track data is required for authorizations unless card not present or keyed entry.	String
Track2Data	The actual data read from the magnetic stripe on a card. Application should strip Start and End Sentinels, LRC, and Track separators. Conditional, required if at least one track data is required for authorizations unless card not present or keyed entry.	String
TrackData	DEPRECATED. Use Track1Data or Track2Data. The actual data read from the magnetic stripe on a card. Socket should strip Start and End Sentinels, LRC and Track separators if present in card swipe. Conditional, required when IdType is a swiped card (‘Track_?_Data’).	String

 

---

 

CardSecurityData

Contains security information for the payment card. Conditional, required for PIN Debit transactions.

Parameter	Description	Data Type
CVData	Actual CVD2 data. Conditional, required if CVDataInd = ‘Provided’.	String
CVDataProvided	Indicates whether or not CVD2 data was provided. Conditional, required for keyed transactions. Recommended for card-not-present authorizations. Not used in settlement.	Enum

 

---

 

ConsumerIdentification

Consumer Identification data. Conditional, required if CardData is not supplied.

Parameter	Description	Data Type
IdData	Contains the actual consumer identifier data. Required.	String
IdEntryMode	Indicates the method by which the consumer identifier data was received. Required.	Enum
IdType	Indicates the type of consumer identifier provided. Required.	Enum

 

---

 

StoredValueActivateTenderData

Used to activate the card as tender. Required.

Parameter	Description	Data Type
VirtualCardData	Aggregate used to submit account number length and BIN number for virtual card activation. Conditional, for virtual card activation when TxnCode = ‘Issue_Account’. At least one of CardData, VirtualCardData, PaymentAccountDataToken or SecurePaymentAccountData must be provided.	Object

 

---

 

StoredValueBalanceTransferTenderData

Tender data specific to balance transfers. Required.

Parameter	Description	Data Type
SourceCardData	Card data for the source account. Optional.	Object
SourceConsumerId	Consumer Identification data for the source account. Conditional, required if CardData is not supplied.	Object

 

---

 

StoredValueCapture

Contains information for capturing Stored Value transactions. Required.

Parameter	Description	Data Type
Amount	Amount to capture if different from the authorized amount. Conditional, required when capturing a different amount than authorized.	Decimal

 

---

 

StoredValueCaptureResponse

Response to capturing one or more Stored Value transactions. Expected.

Note:StoredValueCaptureResponse inherits the data elements in Response.

Parameter	Description	Data Type
BatchId	Batch Identifier. Optional.	String
SummaryData	Summary information for Stored Value totals. Required.	Object

 

---

 

StoredValueManage

Stored Value udpdate data for building Deactivate, Status, Reload, and BalanceTransfer from Activate.

Parameter	Description	Data Type
Amount	The amount to be reloaded on the card. Conditional required if processing Reload.	Decimal
CardData	Card data for the source account. Conditional, required if processing Balance Transfer.	Object
CardStatus	Specifies card status for status update. Optional.	Enum
IsCashOut	Specifies cash out deactivation. Optional.	Boolean
OperationType	Indicates the opertion type for ManageAccount. Conditional, required if processing ManageAccount.	Enum

 

---

 

StoredValueReturn

Contains information for processing Stored Value return transactions. Required.

Parameter	Description	Data Type
Amount	Amount to return if different from the authorized amount. Conditional, required when returning a different amount than authorized.	Decimal

 

---

 

StoredValueTenderData

Stored Value tender data. Required.

Parameter	Description	Data Type
AcctType	The type of SVA account being used. Conditional.	Enum
CardData	Cardholder data. Conditional, required if IdType is a card (PAN or TrackData).	Object
CardholderId	Actual cardholder identification data in the form of encrypted PIN. Optional.	String
CardSecurityData	Contains security information for the payment card. Conditional, required for PIN Debit transactions.	Object
ConsumerIdentifications	Collection of Consumer Identification data. Conditional, required if CardData is not supplied. Maps to ConsumerIdentification.	List of Objects

 

---

 

StoredValueTransaction

Contains information about the Stored Value transaction (gift card). Required.

Note: StoredValueTransaction inherits the data elements in Transaction.

Parameter	Description	Data Type
StoredValueTenderData	Details about the card tender used for the transaction. Required.	Object
StoredValueTransactionData	Contains transaction detail information. Required.	Object

 

---

 

StoredValueTransactionData

Contains information about the Stored Value transaction data. Required.

Note: StoredValueTransactionData inherits the data elements in TransactionData.

Parameter	Description	Data Type
CardRestrictionValue	Specifies the gift card restriction value assigned to a specific card. Optional.	String
CardStatus	Specifies card status for status update. Optional.	Enum
EmployeeId	The Employee Identifier. Required.	String
EntryMode	Indicates how the cardholder data was retrieved. When authorizing with stored card data, either locally or with PaymentAccountDataToken, indicates that the card data was manually collected (keyed or one of its variants). Required.	Enum
IndustryType	The industry type of the transaction. Required.	Enum
OperationType	Indicates the operation type for ManageAccount. Conditional, required if processing ManageAccount.	Enum
OrderNumber	Order number as assigned by the merchant. Required.	String
TenderCurrencyCode	Currency code as defined by the International Standards Organization (ISO). Required.	Enum
TipAmount	Tip amount. Optional.	Decimal
Unload	Specifies if Authorize should unload remaining balance. Optional.	Boolean

 

---

 

StoredValueTransactionResponse

Response to the Stored Value transaction (gift card). Expected.

Note: StoredValueTransactionResponse inherits the data elements in Response.

Parameter	Description	Data Type
AccountNumber	Virtual card account number. Conditional, required for virtual card activation.	String
Amount	Amount of the transaction. Required.	Decimal
ApprovalCode	A value returned when a transaction is approved. Required.	String
CardRestrictionValue	Specifies the gift card restriction value assigned to a specific card. Optional.	String
CardStatus	Indicates the status of the card if one is present. Optional.	Enum
CashBackAmount	The amount to return to the cardholder in another tender. Optional.	Decimal
CVData	CVD2 data (gift card security code) for virtual card activations. Optional.	String
CVResult	Response code returned by the card issuer indicating the result of Card Verification (CVV2/CVC2/CID). Optional.	Enum
FeeAmount	Indicates fees charged to process transaction if applicable. Optional.	Decimal
LockAmount	The value on the card that is locked due to balance lock transaction received. Optional.	Decimal
MaskedPAN	The cardholder’s PAN in masked format. Expected. Note: MaskedPAN is stored with each transaction record and returned in the response to TMS query requests. Although the first 6 digits of MaskedPAN may be returned in the response (for example, 9876-54**-****-****-1234), they are only to be used by the software company and NAB Velocity for troubleshooting purposes. As a best practice, software companies should only present the last 4 digits of MaskedPAN to the merchant and their customers, whether displaying this information on-screen or printing the information on a receipt or invoice.	String
NewBalance	The account balance after the transaction. Required.	Decimal
OrderId	The order id generated by CWS. Often used by service providers for transaction correlation. Optional.	String
PaymentAccountDataToken	Token specified by a tokenization (offsite payment account data storage) service provider, used to retrieve securely stored payment account data. Expected.	String
PreviousBalance	The account balance prior to the transaction. Optional.	Decimal

 

---

 

VirtualCardData

Aggregate used to submit account number length and BIN number for virtual card activation. Conditional for virtual card activation when TxnCode = ‘Issue_Account’. At least one of CardData, VirtualCardData, PaymentAccountDataToken or SecurePaymentAccountData must be provided.

Parameter	Description	Data Type
AccountNumberLength	The length of the account number that will be returned by the service provider. Required.	Integer
BIN	The virtual gift card BIN number assigned by the service provider. Required.	String

Updated: June 2, 2017