Gift Card Transaction
Description
The giftCardTransaction endpoint is used to know the Balance on the Gift cards.
Balance Inquiry¶
Request
Endpoint
/ui/v1/giftCardTransaction
Method
POST
Header
Content-Type: application/json
Request body
{
"money": {
"amount": "",
"currency": {
"currencyCode": "CAD",
"isoNumericCode": ""
}
},
"paymentType": "SINGLE_PAYMENT",
"consolidatedPayInfo": {
"payments": [{
"type": "giftcard",
"paymentMethodType": "GIFT_CARD",
"cardNetworkName": "",
"nameOnCard": "",
"firstName": "",
"lastName": "",
"cardNumber": "",
"expiryMonth": "",
"expiryYear": "",
"cvn": "2002",
"cardSwipe": false,
"posKeyed": false,
"emvContact": false,
"geolocation": "{\"city\":\"Johns Creek\",\"country\":{\"code\":\"US\",\"name\":\"United States\"},\"timestamp\":1617045556267,\"location\":{\"latitude\":34.0626641,\"longitude\":-84.17308539999999,\"address\":\"12000 Findley Rd, Johns Creek, GA 30097, USA\",\"placeId\":\"ChIJF0YqUyaZ9YgRJtEh_OqlSDA\",\"altitude\":null,\"accuracy_radius\":20,\"altitudeAccuracy\":null,\"heading\":null,\"speed\":null,\"time_zone\":\"America/New_York\"},\"userAgent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.90 Safari/537.36\",\"ip\":\"12.197.184.98\",\"remoteHost\":\"\"}",
"processDebitOrCredit": "",
"refundMethod": {
"name": "ORIGINAL_PAYMENT_METHOD"
},
"refundStatus": {
"name": "NONE"
},
"voidStatus": {
"name": "NONE"
},
"orderId": "t4hur6l2vo6s",
"subscriptionId": "",
"routingNumber": "",
"accountNumber": "",
"reEnterAccountNumber": "",
"accountHolderName": "",
"bankName": "",
"accountType": "",
"dateOfBirth": "",
"driversLicenseNumber": "",
"driversLicenseState": null,
"billingAddress": {
"country": "CAN",
"state": null,
"city": "",
"addressLine1": "",
"addressLine2": "",
"addressLine3": "",
"zipCode": ""
},
"money": {
"amount": "",
"currency": {
"currencyCode": "CAD",
"isoNumericCode": ""
}
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"payWith": "CARD_NOT_PRESENT",
"posTerminalId": "",
"arqcData": "",
"serialNumber": "",
"trackData1": "",
"trackData2": "",
"encryptedTrack1": "",
"encryptedTrack2": "",
"encryptedTrack": false,
"posEntryMode": {
"name": "MANUAL_ENTRY_WIRED"
},
"ksn": "",
"posDeviceType": {
"name": "NONE"
},
"authCode": "",
"convenienceFees": 0,
"channel": {
"id": ""
}
}]
},
"paymentCycle": "ONCE",
"transactionType": {
"name": "BALANCE_INQUIRY"
},
"ssoEnabledInd": "false",
"threeDSecurePaReq": "",
"threeDSecureURL": "",
"threeDSecureVISAPit": "",
"realexRequestId": "",
"threeDSecureEncodedMD": "",
"password": "password",
"paymentMethodName": "",
"invoiceNumber": "",
"voidReason": "",
"refundReason": "",
"transactionCategory": {
"name": "CARD_NOT_PRESENT"
},
"paymentAction": {
"name": "PRE_AUTHORIZATION"
},
"memo": "",
"addProfileAsPartOfAuthRequest": false,
"merchantId": "2",
"userRole": "",
"uiType": "",
"emailAddress": "",
"reEnterEmailAddress": "",
"recurringInd": false,
"id": 78,
"createdUserId": "",
"disablePaymentType": false,
"disableAmount": false,
"digitalSignature": "",
"agreeToPayInd": false,
"agreeToAcceptRefundInd": false,
"goodsAndServicesPurchaseType": {
"name": "UNKNOWN"
},
"checkInDate": "",
"checkOutDate": "",
"bookingNumber": "",
"groupName": "",
"customerName": "",
"merchantLocation": null,
"customerId": "",
"numberOfCards": 1,
"confirmationInd": false,
"productCode": null,
"geolocation": "{\"city\":\"Johns Creek\",\"country\":{\"code\":\"US\",\"name\":\"United States\"},\"timestamp\":1617045556267,\"location\":{\"latitude\":34.0626641,\"longitude\":-84.17308539999999,\"address\":\"12000 Findley Rd, Johns Creek, GA 30097, USA\",\"placeId\":\"ChIJF0YqUyaZ9YgRJtEh_OqlSDA\",\"altitude\":null,\"accuracy_radius\":20,\"altitudeAccuracy\":null,\"heading\":null,\"speed\":null,\"time_zone\":\"America/New_York\"},\"userAgent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.90 Safari/537.36\",\"ip\":\"12.197.184.98\",\"remoteHost\":\"\"}"
}
Response
{
"id": 78,
"createdDateTime": null,
"lastUpdatedDateTime": null,
"encryptedGeolocationInfo": "ua09vB+0GuHY+V5JiXwpObPuU4DADyH0f5fREGdkm2i8Y7v5asRgH+bGTWR2JWyHBzwW37H9R2FZ3v2Avq3zAOGSGWLYw+HLdbvy2BmRjHo1QX1mCLysaoefB01hoKKYfYNsSmsnHba9BW05XESKaBKdUD+k83hiGNNhLZtmXYSQoHup3lXsI34+mvTYpJebENocziCUBrqXmWA6gTN5ei4hSkUn249bLEmVQns1FcWBAGl87bUKEjxw3n8g+MbF15Ohd22iR1Gq3/grcE7lQGZ+5UIBJqtP09kHD6BReI3N9deCgyBt/gACnJLhZv2aK7CALxVAESLfho2nUvQ5NttWbTJTw2teoV/+is72mxTBrx8BIi4G0w9nP0KtlCF1r1TcRkRAwlPqInd+koh9SDEqocxQ96FYHb9Q9winZTiI6UcNX0ErpsGQW8vu0jbPcgfnPnBTblucIXiPKOU7g8WjQ2HHOmJmUYiEZU4c+AhT7xRzJteFbovOtNT6wRbGTxiP32yVLnoYQTVxGeDkrG3uE+jukx6SlQEFSg6cTz/aNQWemK0ok+TlkZhSCOctAuRJ06C9lO0UsitbNKnZSwN+QSYh7SUWkNfXPX0LnWeVhWEXHrSf84Ybqb+TLX6vkuisdm387Q8tMYb718LCSW+eT3KKge3d6pE8gQ+krrDrNeUTb+5RCqwDJA81r9PlexZxz4Tx7SMBBzVCrXZOwsyD1PQ2/NP6cnd11rGB0NQ=",
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"pymtMthdType": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"lastFourDigitsOfAcctNum": "3192",
"responseMsg": null,
"responseCode": null,
"lockedByUserId": null,
"lockedDateTime": null,
"giftCardStatus": {
"value": "Failed",
"name": "FAILED"
},
"orderId": "t4hur6l2vo6s",
"pymtGtwyRefNumber": null,
"authCode": "983198",
"giftCardNickname": null,
"expires": null,
"encryptedGiftCard": "9a+JyKBLRbFObZRZOxAH5+CqHSUBoSl8ZFjKX4JaZb+nO7I/YbW98mPh/2dLmUkEJtDjBScQIq/kCQf1CsgatGoXOk7ULbsU3cDVy4DTkx8hgjvYxl46EZ390EHFvp2EYygbkkYI2Bj078TqqxWHAfsiSNRH0JGm62l1qOxZdJ8OG/+26bNmOpJ89F0kpRk7K+djnRstkjEAhkP1InNZrNK6fHCtAuGHk8J9GOmWhuYDkh06cbTGjftGd3xb1rWC2hhNnShahb6XQJiu1IbKXCA5jM5hBRpRn/VMso26jizykcjyXWnS/7wPh9y1T4O/X3bsQWQ3LFz13/An/8cr8FAXY/l6YVfHTcT7V9LUqNMw0Pu7iiRGXLHyxXTiYEfCgMwhXtoGyH5LiLChmt9hg0kQ9gFoXtuPjCwX8Emo6CsDVYUH49fR22ZK0H3kpgrigRC2a+Up9L2hjAIy0iyY+55rQ/Fiy+NhQPAnrAlPC56Atuesvwsw4y1AsSaGIoQakyE8fpUvPKmSIIT1KVGMuzWPpFOme7s7GY9YlLMjVjx5lznhCGVx5hhs+YtQobljlJt+Sxc2B7XHkVMJZMqSs+LglwPJNXuHSg4SFWE5GFO5nefg8I7oYQYVPmSXK8V+q0ceN0ISTzepken4YznQM63xAhxkooALMfAWwYOcvKhfWSwU9PbMsaniXIUbgjsYYySdL4YW+fxKj8IMjqsSlYhVhZB0oD75b2AM+spcLg1//BLTm9Tu3V+g6LfiL1ai/r9yKkujstenuA6dRh80gdq4nPnkGJ3Nr+o1n9Bx5CTOd0M8Xgrrj0fiCOaVX90xk9nwlRu41jtC6hMLQsLC0F1oohkLPZf7APyMOxOtrPTWa6OXMpnOwiGpD6Enialyxm6jmECKQ3cTdieE0eM9Jc/FDgjhGkRfxS/GXl+jeSHM65Ehx7DE9hFmi0WVanZYiUdyFrKF5cUQfDknsyuRfdXXuySdLi60Zg/ykJMzorFOlIhKSz2gIKhM5QZjrjTWMGcLbXNaCeuT7Qk8hvPLTDIh4lMygoupAwshLK9sPS/pzkK3fz88AeGnUvJPkq3DHoRiLAbJwrNAdDnXV+oThQ0elBltvxhG6+DdABfMJj3HmJdro3py7KkaWoGhYsGeLGrVJxzOjEKmas8y8KZqnnIa/WmWtqetE1foDMe2YwUWDCDmgg7vdjVIAOJnUPBcwz2V5IiC4CBB+rnXOXKCTCvp0QQtpSfnaROSAVWQc2atA/mIymSW2tfexC4KQCv5E8Kjme/0wxoUZP3T6UpqgTTWTm0vn6OkLtLujrd/iK5bOBMvt5MIRG1t8V7Zr1Q0h9ZYPmS8choIEHag1//M/cRgTj62PdE9GJAxh1pUXdq3f5l3t/Z34x21yjFFC0w3bvMFZGNi5p9WP116dJLGLKN2brgOtGYImXmu6PeArXH2TUKrTRxGPUmJYQxtUpOVmY5+Mh1VrDb65DdsNJAe7s/TICE6dQ/wyjuMgEOVXQ2y5s64HGNa63FC6dJAUV5iSkwwqbYo3CziQOrVSrGP7prdBNkNK4qXa7i6o0iIqwczcoYwCwt3r0tE3/wpT/+U",
"channel": {
"id": 1,
"channelName": null,
"channelStatus": null,
"channelType": null,
"createdDateTime": null,
"merchantId": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": null,
"lastModifiedUserId": null,
"industryType": null,
"allowCashAsPaymentMethodInd": false,
"allowMoneyOrderAsPaymentMethodInd": false,
"allowPaperCheckAsPaymentMethodInd": false,
"allowEStoreCreditAsPaymentMethodInd": false,
"paymentMethods": [],
"allowDynamicRoutingCapabilityInd": false,
"secondaryPaymentGateway": null,
"tertiaryPaymentGateway": null,
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
},
"createdUserId": 379,
"lastModifiedUserId": null,
"merchantId": 2,
"money": {
"amount": 100.00,
"currency": {
"id": 31,
"currencyCode": "CAD",
"currencyText": "Canadian Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608260909000,
"isoNumericCode": "124",
"isoCountryCode": "124"
}
},
"merchantNumber": "700000201119",
"memo": "",
"numberOfCards": 1,
"transactionCategory": {
"value": "Card Not Present (CNP)",
"name": "CARD_NOT_PRESENT"
},
"message": {
"code": "145",
"type": {
"value": "Error",
"name": "ERROR"
},
"text": null,
"include_i_icon": false,
"description": "The Balance Inquiry for the Gift Card ending in <strong>3192</strong> has been failed. Please try again later or contact customer service."
},
"cardType": null,
"giftCardName": null,
"createdUserName": null,
"geolocation": null,
"merchantName": null,
"accountNumber": null,
"accountHolderName": null,
"transactionType": {
"value": "Balance Inquiry",
"name": "BALANCE_INQUIRY"
},
"ipaymentMethod": {
"type": "giftcard",
"processDebitOrCredit": null,
"refundMethod": {
"value": "Original Payment Method",
"name": "ORIGINAL_PAYMENT_METHOD"
},
"money": null,
"paymentMethodType": "GIFT_CARD",
"orderId": null,
"billingAddress": {
"country": "CAN",
"addressLine1": "12000 Findley Road",
"addressLine2": "",
"addressLine3": "",
"city": "Montreal",
"state": "QC",
"zipCode": "H3Z 3G1"
},
"subscriptionId": null,
"emailAddress": "madhaviyemme@gmail.com",
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"refundStatus": {
"value": "None",
"name": "NONE"
},
"convenienceFees": null,
"channel": null,
"nameOnCard": "Certification # 09",
"firstName": "",
"lastName": "",
"cardNetworkName": "",
"cardNumber": "6035718880040023192",
"expiryMonth": "",
"expiryYear": "",
"applicationPANSeqNum": null,
"cvn": null,
"cardSwipe": false,
"emvContact": false,
"fallbackMSR": false,
"trackData1": "",
"trackData2": "",
"posKeyed": false,
"posTerminalId": null,
"posEntryMode": {
"value": "Manual Entry - Wired (Current EMV)",
"name": "MANUAL_ENTRY_WIRED"
},
"encryptedTrack": false,
"ksn": null,
"arqcData": null,
"batchData": null,
"cardBINInfo": null,
"authCode": null,
"encryptedTrack1": null,
"encryptedTrack2": null,
"chipCardData": null,
"decryptedEMVPayload": null,
"posDeviceType": null,
"serialNumber": null,
"applicationIdentifier": null,
"transactionSequenceCounter": null,
"macKSN": null,
"ifdserialNumber": null
}
}
Updated As Of Version 3.8.0.5