Gift Card Transaction - Deactivate
Description
The giftCardTransaction endpoint is used to Deactivate Gift cards.
Deactivate¶
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": "",
"cardSwipe": false,
"posKeyed": false,
"emvContact": false,
"geolocation": "{\"city\":\"Johns Creek\",\"country\":{\"code\":\"US\",\"name\":\"United States\"},\"timestamp\":1617041598015,\"location\":{\"latitude\":34.0626605,\"longitude\":-84.1730888,\"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": "rl8emdupa1bt",
"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": "DEACTIVATE"
},
"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": 98,
"createdUserId": "",
"disablePaymentType": false,
"disableAmount": false,
"digitalSignature": "",
"agreeToPayInd": false,
"agreeToAcceptRefundInd": false,
"goodsAndServicesPurchaseType": {
"name": "UNKNOWN"
},
"checkInDate": "",
"checkOutDate": "",
"bookingNumber": "",
"groupName": "",
"customerName": "",
"merchantLocation": null,
"customerId": "",
"numberOfCards": 12,
"confirmationInd": false,
"productCode": null,
"geolocation": "{\"city\":\"Johns Creek\",\"country\":{\"code\":\"US\",\"name\":\"United States\"},\"timestamp\":1617041598015,\"location\":{\"latitude\":34.0626605,\"longitude\":-84.1730888,\"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": 98,
"createdDateTime": 1600265843000,
"lastUpdatedDateTime": 1617043385000,
"encryptedGeolocationInfo": null,
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"pymtMthdType": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"lastFourDigitsOfAcctNum": "1398",
"responseMsg": "Approved",
"responseCode": "00",
"lockedByUserId": null,
"lockedDateTime": null,
"giftCardStatus": {
"value": "Deactivated",
"name": "DEACTIVATED"
},
"orderId": "rl8emdupa1bt",
"pymtGtwyRefNumber": "60621FB9A4D0EF4BB1ED39FB0F5BDC6EACBA5387",
"authCode": "986134",
"giftCardNickname": "sariwaryierti",
"expires": null,
"encryptedGiftCard": "9a+JyKBLRbFObZRZOxAH5+CqHSUBoSl8ZFjKX4JaZb+nO7I/YbW98mPh/2dLmUkEJtDjBScQIq/kCQf1CsgatGoXOk7ULbsU3cDVy4DTkx8hgjvYxl46EZ390EHFvp2EYygbkkYI2Bj078TqqxWHAfsiSNRH0JGm62l1qOxZdJ8OG/+26bNmOpJ89F0kpRk7K+djnRstkjEAhkP1InNZrNK6fHCtAuGHk8J9GOmWhuYDkh06cbTGjftGd3xb1rWC2hhNnShahb6XQJiu1IbKXCA5jM5hBRpRn/VMso26jizykcjyXWnS/7wPh9y1T4O/X3bsQWQ3LFz13/An/8cr8FAXY/l6YVfHTcT7V9LUqNMw0Pu7iiRGXLHyxXTiYEfCgMwhXtoGyH5LiLChmt9hg0kQ9gFoXtuPjCwX8Emo6CsDVYUH49fR22ZK0H3kpgrigRC2a+Up9L2hjAIy0iyY+/YWUSVAdXeWeYtZJo26e8ktFdsIU///ydHfy7cJgFPn7M5xw6IiEIr+fdQ9PxypRAu1TL05KmBEoN7e1YZhwZwmCvc2GOW3mN37Bu3338bJ4qEQ4j7Z5V6rYdXOSRCbZzt74Ffc/8sZvbAoqxn/0YXBXOkSOw/2sScqMeuIDJXPiWWsICI2gF4Qjk+1p6OjKAA2nf1sWVay5MTxhgFgBtjdnrvn5yoFvvFEPHWMt/5avqrC6ndPPuNzZNCb0TmuxO/8QjrFYOVNaGV27KzrATHh3fv6fLEh80t1UOexTj4mKS9xypK0V2Q81lkOFTya1Zb2elxw7691sUxTrlscSaQmo3m4x9TtOPXUD30o7Tp2UBrG7TMCMrNtPzod5mxrDOg/brNBnBpwRFwM5G7ay26AG2T/7xz05OjrNDYEqDtEk9sK5etCe1MSQiMfeLmDmzR9LarGfxrH4Ik+tgyu22AfrdocJr8l7LUYPDk9lugOVPs/wyySceel0AZejl53E+HmhkmhtG9q0U6vkwLwBuOa3DuGf368l8t48RfxWrDyvxt71r/H3W79QAo6OyVzNz8JUgId6y+qhNyYQWKWciYCUEKGXMGq+ae0Eysx1Gzs6zWfRQEQF12kfXs4Y854lD9O5JH9itNmjetlMfNrp/PPFy0kqcjatuVFFuTOmaqL9iUNhL/mWVTGB8hb4kEOdS1hbQq/CN45/oO76fuJ1UYZZu4kNtbdcz9SSWMi7LqiaKp6sTElUOHwr38H48MYniLotSjzoi9V+J1KyJ8Ih7Bkzs6VrxUlVuOSztgxlfDjKJbxjJbJy09OFor+yeGt/s624LywjQzYzsOX5wpvh8FswZHg7RcX3Cx2YeguHN5B3vhnp2bpdQLD8oWhwbxqPoXcPJW7TDk90SWCzdeCxS5IoszifSNUEAlSZiCUug420sCL/JUn9R4RYMZd6MkuEWQrQaRa/Bpak0tc7Cfn+wkR/nS+F0bqWYyPNZEcgnORb+20c4L4RpYx2W5QMT15HQZ2SaKuZkeHOcC5pFMIcVHI3N7i1n5PNMa/2j1E8r9Xpm+ORPmI+WYkRi0aNg1eOjAvmeSMmO6jjfyLzTM/AIMBKBPXFDLW5JbJrRMNjxorCcZXHiY8rZ/Ha9EzKpUM2wuioRjSY0L3TE2wFBZZ7A+cDyeO46LagQC7qVcb4XICB5Bdntq4mTe7IqiZUbOBH8Gc6siATbx3AHPh6wAXOLyVJloDP2egZT4XrvKJlonk7g3qWYLjAeemwe1A/y59BMqAYn4hn2AhdMQbLc/zT5cElfN1NroSIWBMYttqkmiQ",
"channel": {
"id": 117,
"channelName": "Chase Paymentech-Orbital",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "External",
"name": "EXTERNAL"
},
"createdDateTime": 1584975253000,
"merchantId": 2,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 379,
"lastModifiedUserId": 379,
"industryType": {
"value": "eCommerce",
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": true,
"allowMoneyOrderAsPaymentMethodInd": true,
"allowPaperCheckAsPaymentMethodInd": true,
"allowEStoreCreditAsPaymentMethodInd": false,
"paymentMethods": [
{
"id": 1035,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 701,
"createdUserId": 379,
"lastModifiedUserId": 379,
"createdDateTime": 1584975253000,
"lastUpdatedDateTime": null,
"position": 20
},
{
"id": 1046,
"paymentMethodType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 712,
"createdUserId": 379,
"lastModifiedUserId": 379,
"createdDateTime": 1584975253000,
"lastUpdatedDateTime": null,
"position": 31
},
{
"id": 1055,
"paymentMethodType": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"cardId": null,
"createdUserId": 379,
"lastModifiedUserId": 379,
"createdDateTime": 1584975253000,
"lastUpdatedDateTime": null,
"position": 40
}
],
"allowDynamicRoutingCapabilityInd": false,
"secondaryPaymentGateway": null,
"tertiaryPaymentGateway": null,
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
},
"createdUserId": 552,
"lastModifiedUserId": 379,
"merchantId": 2,
"money": {
"amount": 977.000,
"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": 12,
"transactionCategory": {
"value": "Card Not Present (CNP)",
"name": "CARD_NOT_PRESENT"
},
"message": {
"code": "138",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "The Gift Card ending in <strong>1398</strong> has been DeActivated successfully."
},
"cardType": null,
"giftCardName": null,
"createdUserName": null,
"geolocation": null,
"merchantName": null,
"accountNumber": null,
"accountHolderName": null,
"transactionType": null,
"ipaymentMethod": null
}
Updated As Of Version 4.6.0.3