Get Gift Card
Description¶
The getGiftCard endpoint is used to retrieve a Gift Card details for a given user.
Request¶
Endpoint¶
/ui/v1/getGiftCardMethod¶
POSTHeader¶
Content-Type: application/jsonRequest 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": "PRE_AUTHORIZATION"
},
"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": "1",
"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": null,
"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": "Active",
"name": "ACTIVE"
},
"orderId": "rl8emdupa1bt",
"pymtGtwyRefNumber": "5FE0CAD726F40FDB410D7ECCF3A52600599A5380",
"authCode": "994259",
"giftCardNickname": "sariwaryierti",
"expires": null,
"encryptedGiftCard": "9a+JyKBLRbFObZRZOxAH5+CqHSUBoSl8ZFjKX4JaZb+nO7I/YbW98mPh/2dLmUkEJtDjBScQIq/kCQf1CsgatGoXOk7ULbsU3cDVy4DTkx8hgjvYxl46EZ390EHFvp2EYygbkkYI2Bj078TqqxWHAfsiSNRH0JGm62l1qOxZdJ8OG/+26bNmOpJ89F0kpRk7K+djnRstkjEAhkP1InNZrNK6fHCtAuGHk8J9GOmWhuYDkh06cbTGjftGd3xb1rWC2hhNnShahb6XQJiu1IbKXCA5jM5hBRpRn/VMso26jizykcjyXWnS/7wPh9y1T4O/X3bsQWQ3LFz13/An/8cr8FAXY/l6YVfHTcT7V9LUqNMw0Pu7iiRGXLHyxXTiYEfCgMwhXtoGyH5LiLChmt9hg0kQ9gFoXtuPjCwX8Emo6CsDVYUH49fR22ZK0H3kpgrigRC2a+Up9L2hjAIy0iyY+5Eu5a2yoXKWjGbr5S5y1PIBMSTuV3Cx4KScZ/8ATwiudzzUAZvHv4X0Rc6S/dKiTickL8o/y6pid56t4yOO3sI6DAf6PDtLqp32I2iMiZbzMqftDHD9S5UbQ7E8sTGq0En5JM/dN/ZZ5yBw8uMvYeWPI+IFhyhNAO7kBnpvq4XW2CT24XpHIxuTtIleu5RbQB2E2iWNeKrjAU8mwY3P5VxbkB+foV1TjVGrq8seDXEpc+rsv//tIT7Ax5VRviWOCR8FZ1rMrw0w72SsLgS/keARB18BJ0DUmyO4f4eLS1x5wm+qv13hFR1stZKt++GQoYb4iNomjnDPdSffBuJzQGoEJFaWM/iP3qS5JUqRXfLd2D3MtCUwJSdBMW4VfIPSOc+9an2IVeALBjEBae4RJoG2iJph3Li996AMIAygtmU+xy/sfuAvkOAI9xefd2d8jhoHecvgVxpwY6hjtZQUNeQsa3ljcTr+Hs1GdP5WZoXYndlxbyxti15iOiCa23fzmwV1SSFjk0R7wHDZ1qqNEN+Y8r+SrhYB3/NHaMjD0XK+BZgFL+WvG9oql3wMYcZTx1/KjyHNOvPwAYyqOVMVNvX0KNQ9UvK0RCF+krAhnOKa6Q8lSY2XowB2hmLPqfRYPMEwAMfHLYflUSavNGQm8dLRZsKHINWdfYpgj9COkQ56rDIplXSzsGiy3+1IvIXytWYXgN7xBuiF2ANRcRd2llBJ2ZA70OTph3VA7hqU2hOgyOO7+lpQtHgfxkm6JVas9zEjkWHhNtSp+SmnHrVhYfwnuPVRm20+ZP9YSR28BZOH06TRJTdHDrf8Y2/479IrrifLcvVL+vAsBrG5G0fUT3AQ5JN5IgmxF+W4EKerUkDWMftbMdaJkDyseehL2EUYG7Jiksf6fK/qOvL5Slti9QlGo91MECMv3d9G0ZSgNKdBIs5A5bQl1N61warAPoH2KQyjpHkNP3oxJ03q9t2G+YBUwR9PTAmoDwHVtERZhrG+jyGTXU1oe4wOIWletUEgtQyM9ncl76X6q2OWqfdlqHBJfIbQZdWUuQmkkQehAHM/xv5d8ZWNX5qFYipqY++xkLDkhKYrdvGpN14JR2JqpQa7gqrmK76coj4wXwaM+8C5wYdPW8LeXY1oUwxaGdoSsHwbELdS/sTW6EfdIuqBCR2JR7o1L37NIJn0phlzgvYrdrKdWQrEpVv54PTv2QFLRI8iySrRPw6OC1PRTfWTLjSA8hiW3xj4rLb8MqpLOsu/xuRorKNuAy2NB1qMw7REFCwHRIjirYRo0UZmgk/UzybVI5YmdbfmbfKJZ+TeSJoMrs3TNj0rkSxUwcmxkffz2KHbh012eO3I8DucIeO9DC26PKzbBjijgHilOyPY21y8/3X7gGKo2BA3COCVI/HT3zsXEMv51tnXJsCLWITiIbnCBOLtDt2q3rSxsLD0tOoIhm9iVU+FZroWHf+KPHdz/NUr2kCeA8fPjcKwtzgj8WcXun11dAt6E5yosDqL2CCAwyREKfeOjIh5quonGaPan4gRbKwQEhke5ff3qgoAh6waAthnWZ4Wlpk2t27sb2bU",
"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": 392,
"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": null,
"cardType": null,
"giftCardName": null,
"createdUserName": "automation_events",
"geolocation": null,
"merchantName": "Meetings & Events Canada",
"accountNumber": null,
"accountHolderName": null,
"transactionType": {
"value": "Pre-Authorization",
"name": "PRE_AUTHORIZATION"
},
"ipaymentMethod": {
"type": "giftcard",
"processDebitOrCredit": "",
"refundMethod": {
"value": "Original Payment Method",
"name": "ORIGINAL_PAYMENT_METHOD"
},
"money": {
"amount": null,
"currency": {
"id": null,
"currencyCode": "CAD",
"currencyText": null,
"currencySymbol": null,
"fractionalUnit": null,
"numOfDecimalPlaces": null,
"supportedByVisaCheckout": false,
"createdDateTime": null,
"isoNumericCode": "",
"isoCountryCode": null
}
},
"paymentMethodType": "GIFT_CARD",
"orderId": "",
"billingAddress": {
"country": "CAN",
"addressLine1": "12000 Findley Road",
"addressLine2": "",
"addressLine3": "",
"city": "Johns Creek",
"state": "ON",
"zipCode": "L6A"
},
"subscriptionId": "",
"emailAddress": null,
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"refundStatus": {
"value": "None",
"name": "NONE"
},
"convenienceFees": 0,
"channel": null,
"nameOnCard": "nishathsoyutre",
"firstName": "",
"lastName": "",
"cardNetworkName": "",
"cardNumber": "603571xxxxxxxxx1398",
"expiryMonth": "",
"expiryYear": "",
"applicationPANSeqNum": null,
"cvn": "",
"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": "",
"batchData": null,
"cardBINInfo": null,
"authCode": "",
"encryptedTrack1": "",
"encryptedTrack2": "",
"chipCardData": null,
"decryptedEMVPayload": null,
"posDeviceType": null,
"serialNumber": null,
"applicationIdentifier": null,
"transactionSequenceCounter": null,
"macKSN": null,
"ifdserialNumber": null
}
}
Updated As of Version 3.8.0.9