|
Field |
Description |
Returned By |
Data Type & Length |
|
customerID |
Identifier for the customer or gift card. The activation service associates a number with the gift card and returns the number in this field. After a card is activated, this identifier is returned in the response message for all transactions with the gift card. You can use this value to identify a gift card in your system. This value does not require PCI compliance. This field is supported only on ValueLink. |
Activation Balance Inquiry Redemption Refund Reload Reversal Void |
String (16) |
|
decision |
Summarizes the result of the overall request. Possible values: nACCEPT nERROR nREJECT For details about these values, see the information about handling replies in Getting Started with Cybersource Advanced for the SCMP API. |
All Cybersource services |
String (6) |
|
giftCard_balanceCurrency |
Your local currency. See ISO Standard Currency Codes. |
Balance Inquiry |
String (3) |
|
giftCard_baseCurrency |
Currency assigned to the gift card when it was activated. The gift card currency might not be the same as your local currency. See ISO Standard Currency Codes. This field is supported only on ValueLink. |
Balance Inquiry Redemption Refund Reload Void |
String (3) |
|
giftCard_baseCurrencyCashbackAmount |
Cash back amount in base currency. This field is supported only on ValueLink. |
Redemption |
String (12) |
|
giftCard_baseCurrencyCurrentBalance |
Current gift card balance in the gift card currency. This field is included in the response message when the gift card currency is not the same as your local currency. This field is supported only on ValueLink. |
Balance Inquiry Redemption Refund Reload Void |
String (12) |
|
giftCard_baseCurrencyPreviousBalance |
Previous gift card balance in the gift card currency. This value is the gift card balance before the concurrent transaction was applied to the gift card. This field is included in the response message when the gift card currency is not the same as your local currency. This field is supported only on ValueLink. |
Balance Inquiry Redemption Refund Reload Void |
String (12) |
|
giftCard_bonusAmount |
Amount of promotional bonus. This field is included in the response message when the transaction amount for activating the card is not the same as the gift card’s account balance because of a programmed promotional bonus. This field is supported only on ValueLink. Example When you offer a promotion that applies a 20% bonus to all gift card activations, a card with a $100 denomination is activated with a starting balance of $120. |
Activation Void |
String (12) |
|
giftCard_count |
Total number of cards in sequence for bulk activation or void of bulk activation. |
Activation Void |
Integer (4) |
|
giftCard_currentBalance |
Current gift card balance in your local currency. |
Activation Balance Inquiry Redemption Refund Reload Reversal Void |
String (12) |
|
giftCard_discountAmount |
Discount amount. This field is included in the response message when the transaction amount for activating the card is not the same as the account balance because of a programmed discount. This field is supported only for ValueLink. Example When a gift card with a $100 denomination is activated at a cost of $90, the discount amount is $10. |
Activation Void |
String (12) |
|
giftCard_exchangeRate |
Exchange rate between your local currency and the gift card currency. The value for this field includes a decimal. The number of digits before or after the decimal varies depending on the precision of the exchange rate. This field is supported only on ValueLink. |
Balance Inquiry Redemption Refund Reload Void |
String (18) |
|
giftCard_expirationDate |
Date on which the gift card expires. When a gift card does not have an expiration date, the value for this field exceeds 3000. This field is supported only on ValueLink. Format: YYYYMMDD |
Activation Balance Inquiry Redemption Reversal Refund Reload Void |
String (8) |
|
giftCard_extendedAccountNumber |
The PIN on the back of the gift card. This field is supported only on ValueLink. |
Activation |
Integer (8) |
|
giftCard_groupID |
Identifier for groups of multiple transactions. Bulk Activations This field is returned on the response record and is not a client determined field. If sent in the request, this field will be echoed back in the response. |
Activation Redemption Refund Reload |
String (8) |
|
giftCard_merchantfundedAmount |
Amount of the balance that you funded. |
Activation Reload |
Integer (12) |
|
giftCard_previousBalance |
Previous gift card balance in your local currency. This value is the gift card balance before the concurrent transaction was applied to the gift card. This field is supported only on ValueLink. Example When a customer purchases a gift card and uses the gift card to purchase a product at the same time, the response message includes: nPrevious gift card balance, which is the balance before the purchase of the product nCurrent gift card balance, which is the balance after the purchase of the product |
Activation Balance Inquiry Redemption Refund Reload Reversal Void |
String (12) |
|
giftCard_promoCode |
Promotion code associated with the gift card activation. |
Activation |
Integer (8) |
|
giftCardActivationReply_authorizationCode |
Authorization code. This value is included in the response message when the activation is approved. This field is supported only on ValueLink. |
Activation |
String (8) |
|
giftCardActivationReply_processorResponse |
Error message from the bank. Returned only when the processor returns this value. Possible values: n00: Transaction was completed successfully. nAny other value: Transaction was declined. Your payment acceptance system must examine the value in this field before determining how to interpret the remaining fields in the response message. When a request is declined, some response fields might not be present, or their values might be zero. |
Activation |
String(2) |
|
giftCardActivationReply_reasonCode |
Numeric value corresponding to the result of the activation request. See Reason Codes. |
Activation |
Integer (5) |
|
giftCardActivationReply_reconciliationID |
Reference number that you use to reconcile your Cybersource reports with your processor reports. See Getting Started with Cybersource Advanced for the Simple Order API for information about order tracking and reconciliation. |
Activation |
FDC Nashville Global: String (12) ValueLink: String (17) |
|
giftCardActivationReply_requestDateTime |
Date and time when the service was requested.
|
Activation |
String (20) |
|
giftCardBalanceInquiryReply_authorizationCode |
Authorization code. This value is included in the response message when the balance inquiry is approved. This field is supported only on ValueLink. |
Balance Inquiry |
String (8) |
|
giftCardBalanceInquiryReply_processorResponse |
Error message from the bank. Returned only when the processor returns this value. Possible values: n00: Transaction was completed successfully. nAny other value: Transaction was declined. Your payment acceptance system must examine the value in this field before determining how to interpret the remaining fields in the response message. When a request is declined, some response fields might not be present or their values might be zero. |
Balance Inquiry |
String(2) |
|
giftCardBalanceInquiryReply_reasonCode |
Numeric value corresponding to the result of the balance inquiry request. See Reason Codes. |
Balance inquiry |
Integer (5) |
|
giftCardBalanceInquiryReply_reconciliationID |
Reference number that you use to reconcile your Cybersource reports with your processor reports. See Getting Started with Cybersource Advanced for the Simple Order API for information about order tracking and reconciliation. |
Balance Inquiry |
FDC Nashville Global: String (12) ValueLink: String (17) |
|
giftCardBalanceInquiryReply_requestDateTime |
Date and time when the service was requested.
|
Balance Inquiry |
String (20) |
|
giftCardRedemptionReply_authorizationCode |
Authorization code. This value is included in the response message when the redemption is approved. This field is supported only on ValueLink. |
Redemption |
String (8) |
|
giftCardRedemptionReply_processorResponse |
Error message from the bank. Returned only when the processor returns this value. Possible values: n00: Transaction was completed successfully. nAny other value: Transaction was declined. Your payment acceptance system must examine the value in this field before determining how to interpret the remaining fields in the response message. When a request is declined, some response fields might not be present or their values might be zero. |
Redemption |
String (2) |
|
giftCardRedemptionReply_reasonCode |
Numeric value corresponding to the result of the redemption request. See Reason Codes. |
Redemption |
Integer (5) |
|
giftCardRedemptionReply_reconciliationID |
Reference number that you use to reconcile your Cybersource reports with your processor reports. See Getting Started with Cybersource Advanced for the Simple Order API for information about order tracking and reconciliation. |
Redemption |
String (17) |
|
giftCardRedemptionReply_requestDateTime |
Date and time when the service was requested.
|
Redemption |
String (20) |
|
giftCardRefundReply_authorizationCode |
Authorization code. This value is included in the response message when the refund is approved. This field is supported only on ValueLink. |
Refund |
String (8) |
|
giftCardRefundReply_processorResponse |
Error message from the bank. Returned only when the processor returns this value. Possible values: n00: Transaction was completed successfully. nAny other value: Transaction was declined. Your payment acceptance system must examine the value in this field before determining how to interpret the remaining fields in the response message. When a request is declined, some response fields might not be present or their values might be zero. |
Refund |
String (2) |
|
giftCardRefundReply_reasonCode |
Numeric value corresponding to the result of the refund request. See Reason Codes. |
Refund |
Integer (5) |
|
giftCardRefundReply_reconciliationID |
Reference number that you use to reconcile your Cybersource reports with your processor reports. See Getting Started with Cybersource Advanced for the Simple Order API for information about order tracking and reconciliation. |
Refund |
String (17) |
|
giftCardRefundReply_requestDateTime |
Date and time when the service was requested.
|
Refund |
String (20) |
|
giftCardReloadReply_authorizationCode |
Authorization code. This value is included in the response message when the reload is approved. This field is supported only on ValueLink. |
Reload |
String (8) |
|
giftCardReloadReply_processorResponse |
Error message from the bank. Returned only when the processor returns this value. Possible values: n00: Transaction was completed successfully. nAny other value: Transaction was declined. Your payment acceptance system must examine the value in this field before determining how to interpret the remaining fields in the response message. When a request is declined, some response fields might not be present or their values might be zero. |
Reload |
String (2) |
|
giftCardReloadReply_reasonCode |
Numeric value corresponding to the result of the reload request. See Reason Codes. |
Reload |
Integer (5) |
|
giftCardReloadReply_reconciliationID |
Reference number that you use to reconcile your Cybersource reports with your processor reports. See Getting Started with Cybersource Advanced for the Simple Order API for information about order tracking and reconciliation. |
Reload |
String (17) |
|
giftCardReloadReply_requestDateTime |
Date and time when the service was requested.
|
Reload |
String (20) |
|
giftCardReversalReply_authorizationCode |
Authorization code. This value is included in the response message when the reversal is approved. This field is supported only on ValueLink. |
Reversal |
String (8) |
|
giftCardReversalReply_processorResponse |
Error message from the bank. Returned only when the processor returns this value. Possible values: n00: Transaction was completed successfully. nAny other value: Transaction was declined. Your payment acceptance system must examine the value in this field before determining how to interpret the remaining fields in the response message. When a request is declined, some response fields might not be present or their values might be zero. |
Reversal |
String (2) |
|
giftCardReversalReply_reasonCode |
Numeric value corresponding to the result of the reversal request. See Reason Codes. |
Reversal |
Integer (5) |
|
giftCardReversalReply_reconciliationID |
Reference number that you use to reconcile your Cybersource reports with your processor reports. See Getting Started with Cybersource Advanced for the Simple Order API for information about order tracking and reconciliation. |
Reversal |
String (17) |
|
giftCardReversalReply_requestDateTime |
Date and time when the service was requested.
|
Reversal |
String (20) |
|
giftCardVoidReply_authorizationCode |
Authorization code. This value is included in the response message when the void is approved. This field is supported only on ValueLink. |
Void |
String (8) |
|
giftCardVoidReply_processorResponse |
Error message from the bank. Returned only when the processor returns this value. Possible values: n00: Transaction was completed successfully. nAny other value: Transaction was declined. Your payment acceptance system must examine the value in this field before determining how to interpret the remaining fields in the response message. When a request is declined, some response fields might not be present or their values might be zero. |
Void |
String (2) |
|
giftCardVoidReply_reasonCode |
Numeric value corresponding to the result of the void request. See Reason Codes. |
Void |
Integer (5) |
|
giftCardVoidReply_reconciliationID |
Reference number that you use to reconcile your Cybersource reports with your processor reports. See Getting Started with Cybersource Advanced for the Simple Order API for information about order tracking and reconciliation. |
Void |
String (17) |
|
giftCardVoidReply_requestDateTime |
Date and time when the service was requested.
|
Void |
String (20) |
|
invalidField_0 through invalidField_N |
Fields in the request that have invalid data. For information about missing or invalid fields, see Getting Started with Cybersource Advanced for the Simple Order API. Note These fields are included as an aid to software developers only. Do not use these fields to interact with your customers.
|
All Cybersource Services |
String (100) |
|
merchantReferenceCode |
Transaction number or tracking number that you provided in the request. If you included multi-byte characters in this field in the request, the returned value might include corrupted characters.
|
All Cybersource Services |
String (50) |
|
missingField_0 through missingField_N |
Required fields that were missing from the request. For information about missing or invalid fields, see Getting Started with Cybersource Advanced for the Simple Order API. Note These fields are included as an aid to software developers only. Do not use these fields to interact with your customers.
|
All Cybersource Services |
String (100) |
|
purchaseTotals_currency |
Currency used for the order. Use the three-character ISO Standard Currency Codes.
|
Activation Redemption Refund Reload Reversal Void |
String (5) |
|
reasonCode |
Numeric value corresponding to the result of the overall request. See Reason Codes. |
All Cybersource Services |
Integer (5) |
|
requestID |
Identifier for the request.
|
All Cybersource Services |
String (26) |