- Print
- DarkLight
- PDF
/v23.1/GiftCardActions/ActivateCheck
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/v23.1/GiftCardActions/ActivateCheck
Security
HTTP
Type Bearer
Please enter a valid token
Body parameters
object
requestId
integer (int32)
cardNumber
integer (int64)
verificationCode
string
reference
string
email
string
credentials
object (GiftCardCredentialsDTO)
merchantUsername
string
merchantPassword
string
companyNumber
integer (int32)
storeNumber
integer (int32)
posTerminalNumber
integer (int32)
returnGiftCard
boolean
Default"False"
balance
number (double)
object
requestId
integer (int32)
cardNumber
integer (int64)
verificationCode
string
reference
string
email
string
credentials
object (GiftCardCredentialsDTO)
merchantUsername
string
merchantPassword
string
companyNumber
integer (int32)
storeNumber
integer (int32)
posTerminalNumber
integer (int32)
returnGiftCard
boolean
Default"False"
balance
number (double)
object
requestId
integer (int32)
cardNumber
integer (int64)
verificationCode
string
reference
string
email
string
credentials
object (GiftCardCredentialsDTO)
merchantUsername
string
merchantPassword
string
companyNumber
integer (int32)
storeNumber
integer (int32)
posTerminalNumber
integer (int32)
returnGiftCard
boolean
Default"False"
balance
number (double)
Responses
200
Success
object
result
object (GiftCardResultDTO)
status
string
Valid values[ "NotSpecified", "Success", "CreditException", "CardException", "ServerException" ]
exceptionCode
string
Valid values[ "NotSpecified", "InsufficientBalance", "MaxTransactionsReached", "CardNotFound", "CardExpired", "CardBlocked", "CardNotActivated", "CardAlreadyActivated", "InvalidVerificationCode", "InvalidCredentials", "InvalidBalance", "InvalidCardStatus" ]
message
string
cardInfo
object (GiftCardServiceObjectInfoDTO)
giftCardTypeId
integer (int32)
customerId
integer (int32)
cardNumber
integer (int64)
verificationCode
string
pincode
integer (int32)
status
string
Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
initialBalance
number (double)
balance
number (double)
transactionsRemaining
integer (int32)
expiryDate
string (date-time)
isBlocked
boolean
Default"False"
blockedDescription
string
allowCashRevert
boolean
Default"False"
allowIgnoreExpiry
boolean
Default"False"
reference
object (GiftCardReferenceDTO)
transactionId
integer (int32)
object
result
object (GiftCardResultDTO)
status
string
Valid values[ "NotSpecified", "Success", "CreditException", "CardException", "ServerException" ]
exceptionCode
string
Valid values[ "NotSpecified", "InsufficientBalance", "MaxTransactionsReached", "CardNotFound", "CardExpired", "CardBlocked", "CardNotActivated", "CardAlreadyActivated", "InvalidVerificationCode", "InvalidCredentials", "InvalidBalance", "InvalidCardStatus" ]
message
string
cardInfo
object (GiftCardServiceObjectInfoDTO)
giftCardTypeId
integer (int32)
customerId
integer (int32)
cardNumber
integer (int64)
verificationCode
string
pincode
integer (int32)
status
string
Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
initialBalance
number (double)
balance
number (double)
transactionsRemaining
integer (int32)
expiryDate
string (date-time)
isBlocked
boolean
Default"False"
blockedDescription
string
allowCashRevert
boolean
Default"False"
allowIgnoreExpiry
boolean
Default"False"
reference
object (GiftCardReferenceDTO)
transactionId
integer (int32)
object
result
object (GiftCardResultDTO)
status
string
Valid values[ "NotSpecified", "Success", "CreditException", "CardException", "ServerException" ]
exceptionCode
string
Valid values[ "NotSpecified", "InsufficientBalance", "MaxTransactionsReached", "CardNotFound", "CardExpired", "CardBlocked", "CardNotActivated", "CardAlreadyActivated", "InvalidVerificationCode", "InvalidCredentials", "InvalidBalance", "InvalidCardStatus" ]
message
string
cardInfo
object (GiftCardServiceObjectInfoDTO)
giftCardTypeId
integer (int32)
customerId
integer (int32)
cardNumber
integer (int64)
verificationCode
string
pincode
integer (int32)
status
string
Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
initialBalance
number (double)
balance
number (double)
transactionsRemaining
integer (int32)
expiryDate
string (date-time)
isBlocked
boolean
Default"False"
blockedDescription
string
allowCashRevert
boolean
Default"False"
allowIgnoreExpiry
boolean
Default"False"
reference
object (GiftCardReferenceDTO)
transactionId
integer (int32)
401
Unauthorized
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
403
Forbidden
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
404
Not Found
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
Was this article helpful?