/v23.1/GiftCardActions/Information
  • 05 Jun 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/GiftCardActions/Information

  • Dark
    Light
  • PDF

Article summary

Post
/v23.1/GiftCardActions/Information
Security
HTTP
Type Bearer

Please enter a valid token

Body parameters
Expand All
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)
Expand All
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)
Expand All
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)
Responses
200

Success

Expand All
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)
Expand All
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)
Expand All
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?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.