giftCardCredit
The giftCardCredit
element is the parent element for all Gift Card Credit transactions. There are two possible structures for this message type. You use the first structure for credit transactions against captures/sales processed by Worldpay. The alternate structure applies to credits against captures/sales not processed by Worldpay. You can use this transaction type in either Online or Batch submissions.
Parent Elements:
cnpOnlineRequest, batchRequest
Attributes:
Attribute Name |
Type |
Required? |
Description |
---|---|---|---|
id |
String |
Yes |
A unique identifier assigned by the presenter and mirrored back in the response. minLength = 1 maxLength = 36 |
customerId |
String |
No |
A value assigned by the merchant to identify the consumer. minLength = N/A maxLength = 50 |
reportGroup |
String |
Yes |
Required attribute that defines the merchant sub-group in the user interface where this transaction will be displayed. For more information, please refer to Coding for Report Groups. minLength = 1 maxLength = 25 |
Child Elements:
For credits to transactions processed by Worldpay (Required): creditAmount, card
For credits to transactions processed by Worldpay (Optional): cnpTxnId
For credits to transactions not processed by Worldpay (Required): orderId, creditAmount, orderSource, card