Activate Gift Card

Description¶

The activateGiftCard endpoint is used to activate a Gift Card payment method in VELA. The user-entered data is "activated" and saved for later retrieval.

Request¶

Endpoint¶

/ui/v1/activateGiftCard

Method¶

POST

Header¶

Content-Type: application/json

Attributes¶

ELEMENT	DESCRIPTION	FORMAT
money	Required Array index
• amount	Required Payment amount	10.00
• currency	Required array index
•• currencyCode	Required 3-character currency code	Currency Codes
consolidatedPayInfo	Required Array index
numberOfCards	Required Number of cards that are being added
• payments	Required Array index
•• type	Required Type of payment method being used	• Giftcard
•• paymentMethodType	Required Payment method type name	Payment Method Types
•• nameOnCard	Conditional Cardholder's name	John Smith
•• cardNumber	Required	4111111111111111
•• CVN	Conditional Required if CVV validation is enabled CVV/CVN	4 digits for all
•• billingAddress	Conditional Required if billing address validation is enabled Array index
••• country	Conditional Required if billing address validation is enabled Billing address country	Country Code
••• state	Conditional Required if billing address validation is enabled Billing address state (US) or province (Canada)	States/Provinces
••• city	Conditional Required if billing address validation is enabled Billing address city	Atlanta
••• addressLine1	Conditional Required if billing address validation is enabled Street address	123 Maple Street
••• addressLine2	Optional Apartment/suite number	Apt. 2A
••• zipCode	Conditional Required if billing address validation is enabled Billing address ZIP/postal code	12345
•• paymentGatewayType	Required Array index
••• name	Required Name of payment gateway processing the payment	Payment Gateways
emailAddress	Required User's email address	john.smith@datumsoftware.com
paymentMethodNickname	Optional Payment method nickname	Gift Card 1111

Request Body¶

{
    "money": {
        "amount": "100.00",
        "currency": {
            "currencyCode": "USD",
            "isoNumericCode": ""
        }
    },
    "paymentType": "SINGLE_PAYMENT",
    "consolidatedPayInfo": {
        "payments": [
            {
                "type": "giftcard",
                "paymentMethodType": "GIFT_CARD",
                "cardNetworkName": "",
                "nameOnCard": "John Smith",
                "firstName": "",
                "lastName": "",
                "cardNumber": "6035718880000299196",
                "expiryMonth": "",
                "expiryYear": "",
                "cvn": "1369",
                "cardSwipe": false,
                "posKeyed": false,
                "emvContact": false,
                "geolocation": "{\"city\":\"Johns Creek\",\"country\":{\"code\":\"US\",\"name\":\"United States\"},\"timestamp\":1617033498984,\"location\":{\"latitude\":34.0626609,\"longitude\":-84.1731034,\"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": "",
                "subscriptionId": "",
                "reEnterAccountNumber": "",
                "accountHolderName": "",
                "dateOfBirth": "",
                "driversLicenseNumber": "",
                "driversLicenseState": null,
                "billingAddress": {
                    "country": "USA",
                    "state": "GA",
                    "city": "Johns Creek",
                    "addressLine1": "12000 Findley Road",
                    "addressLine2": "",
                    "addressLine3": "",
                    "zipCode": "30097"
                },
                "paymentGateway": {
                    "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": "ACTIVATE"
    },
    "transactionCategory": {
        "name": "CARD_NOT_PRESENT"
    },
    "paymentAction": {
        "name": "PRE_AUTHORIZATION"
    },
    "memo": "",
    "addProfileAsPartOfAuthRequest": false,
    "merchantId": "3",
    "userRole": "",
    "uiType": "",
    "emailAddress": "",
    "reEnterEmailAddress": "",
    "recurringInd": false,
    "id": "",
    "createdUserId": "",
    "disablePaymentType": false,
    "disableAmount": false,
    "digitalSignature": "",
    "agreeToPayInd": false,
    "agreeToAcceptRefundInd": false,
    "goodsAndServicesPurchaseType": {
        "name": "UNKNOWN"
    },
    "customerId": "",
    "numberOfCards": "1",
    "confirmationInd": false,
    "paymentMethodNickname": "Gift Card Test",
    "sameAsUserAddress": [
        false
    ]
}

Response¶