ActivateNoNameCardRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
customerNumberCustomer Number - [Optional]
lastFourDigitLast Four Digit - [Optional]
barcodeBarcode - [Optional]
AddDebitCardLogRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
logCodeLog Code - [Optional]
cardLogDetailCard Log Detail - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
customerNumberCustomer Number - [Optional]
validFlagValid Flag - [Optional]
oldValueOld Value - [Optional]
newValueNew Value - [Optional]
AddDocumentByCaseNumberRequest
ChannelChannel
CaseNumberCase Number
ExternalCaseIdExternal Case Id
ExternalDocumentIdExternal Document Id
Dms Reference
AttachAccount
accountNumberAccount Number
accountRecordIdAccount Record Id
AttachCardAccountRequest
fecCodeFec Code - [Optional]
accountBranchIdAccount Branch Id - [Optional]
accountTypeAccount Type - [Optional]
accountSuffixAccount Suffix - [Optional]
accountNumberAccount Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
accountAliasAccount Alias - [Optional]
ibanIban - [Optional]
accountOrderFlagAccount Order Flag - [Optional]
fxAutoConversionFlagFx Auto Conversion Flag
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
currencyCodeCurrency Code - [Optional]
accountOrderAccount Order - [Optional]
CancelCardEmbossByShadowCardNumberRequest
shadowCardNumberShadow Card Number
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
CancelDisputeCaseRequest
ChannelChannel
CaseNumberCase Number
DisputeTransactionIdDispute Transaction Id
UTIDU T I D
DescriptionDescription
CancelNoNameCardApplicationRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
correlationIdCorrelation Id - [Optional]
applicationIdApplication Id - [Optional]
cancelReasonCodeCancel Reason Code - [Optional]
cancelReasonTextCancel Reason Text - [Optional]
CardAccount
fecCodeFec Code
accountBranchIdAccount Branch Id
accountSuffixAccount Suffix
accountNumberAccount Number
recordIdRecord Id
validFlagValid Flag
insertDateInsert Date
accountOrderAccount Order
fxAutoConversionFlagFx Auto Conversion Flag
accountTypeAccount Type - [Optional]
shadowCardNumberShadow Card Number - [Optional]
accountAliasAccount Alias - [Optional]
updateUserIdUpdate User Id - [Optional]
updateDateUpdate Date - [Optional]
insertTokenIdInsert Token Id - [Optional]
insertUserIdInsert User Id - [Optional]
updateTokenIdUpdate Token Id - [Optional]
accountOrderFlagAccount Order Flag - [Optional]
ibanIban - [Optional]
currencyCodeCurrency Code - [Optional]
CardAccountInfo
accountNumberAccount Number
accountBranchIdAccount Branch Id
fecCodeFec Code
balanceBalance
usableBalanceUsable Balance
cardAccountTypeCard Account Type - [Optional]
accountTypeAccount Type - [Optional]
accountSubTypeAccount Sub Type - [Optional]
accountOrderFlagAccount Order Flag - [Optional]
currencyCodeCurrency Code - [Optional]
iBANI B A N - [Optional]
errorDescriptionError Description - [Optional]
CardLimitParameterData
shadowCardNumberShadow Card Number - [Optional]
customerLimitationFlagCustomer Limitation Flag - [Optional]
profileCodeProfile Code - [Optional]
profileDescriptionProfile Description - [Optional]
Keys - [Optional]
perTrnAmountPer Trn Amount - [Optional]
perTrnAmountLimitRatioPer Trn Amount Limit Ratio - [Optional]
dailyTrnCountDaily Trn Count - [Optional]
dailyTrnAmountDaily Trn Amount - [Optional]
weeklyTrnCountWeekly Trn Count - [Optional]
weeklyTrnAmountWeekly Trn Amount - [Optional]
monthlyTrnCountMonthly Trn Count - [Optional]
monthlyTrnAmountMonthly Trn Amount - [Optional]
yearlyTrnCountYearly Trn Count - [Optional]
yearlyTrnAmountYearly Trn Amount - [Optional]
noCvmConsecutiveTransactionCountNo Cvm Consecutive Transaction Count - [Optional]
noCvmConsecutiveTransactionLimitNo Cvm Consecutive Transaction Limit - [Optional]
CardMiscOptionData
customerNumberCustomer Number
mainCardRefNumberMain Card Ref Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
optionTypeOption Type - [Optional]
optionValueOption Value - [Optional]
CardMiscOptionResponse
listOfCardMiscOptionLogRecordIdList Of Card Misc Option Log Record Id - [Optional]
ChangeAndReplaceCardPermissions
eCommercePermittedE Commerce Permitted
mailOrderPermittedMail Order Permitted
ChangeAndReplaceCardRequest
channelChannel
shadowCardNumberShadow Card Number
Replace Info
cardStatusCodeCard Status Code - [Optional]
cardStatusReasonCodeCard Status Reason Code - [Optional]
closeRequestDateClose Request Date - [Optional]
ChangeAndReplaceCardResponse
toStatusActiveTo Status Active
Replace Result - [Optional]
ChangeAndReplaceNoNameCardReplaceModel
replaceReasonCodeReplace Reason Code - [Optional]
enrollMasterpassEnroll Masterpass - [Optional]
Permissions - [Optional]
ChangeAndReplaceNoNameCardRequest
channelChannel
shadowCardNumberShadow Card Number
cardStatusCodeCard Status Code
cardStatusReasonCodeCard Status Reason Code
Replace Info
closeRequestDateClose Request Date - [Optional]
ChangeAndReplaceNoNameCardResponse
toStatusActiveTo Status Active
applicationIdApplication Id - [Optional]
shadowCardNumberShadow Card Number - [Optional]
newCardGeneratedNew Card Generated - [Optional]
productChangedProduct Changed - [Optional]
maskedCardNumberMasked Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
ChangeCardBranchRequest
shadowCardNumberShadow Card Number - [Optional]
targetBranchCodeTarget Branch Code - [Optional]
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
ChangeCardBranchResponse
isSuccessIs Success
oldBranchOld Branch
newBranchNew Branch
ChangeCardMiscOptionRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
optionTypeOption Type - [Optional]
optionValueOption Value - [Optional]
customerNumberCustomer Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
allMainCardFlagAll Main Card Flag - [Optional]
allCardFlagAll Card Flag - [Optional]
ChangeCardPinRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
currentCardPinCurrent Card Pin - [Optional]
newCardPinNew Card Pin - [Optional]
ChangeCardPinResponse
successSuccess
verifiedVerified
changedChanged
encryptedPinEncrypted Pin - [Optional]
ChangeCardStatusRequest
shadowCardNumberRequired · NotNullOrWhiteSpace — The card whose status changes.
statusCodeRequired · Enum · NotNullOrWhiteSpace · EqualValue — The status to move to. Must be a status the platform defines, and the move must be permitted for this channel group.
statusReasonCodeRequired · Dependent · NotNullOrWhiteSpace · EqualValue — The reason for the new status. Must be a reason defined for statusCode.
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel, and its group must be Backoffice, Branch, CallCenter, System or Security — no other channel may change a card's status.
transactionIdOptional — The caller's own id. Echoed back in the error body.
closeRequestDateOptional · Nullable · Format date-time — The date the closure was requested.
ChangeCustomerBranchRequest
customerNumberCustomer Number - [Optional]
targetBranchCodeTarget Branch Code - [Optional]
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
ChangeCustomerBranchResponse
oldBranchOld Branch
newBranchNew Branch
changedCardCountChanged Card Count
listOfShadowCardNumbersList Of Shadow Card Numbers - [Optional]
ChangeSecurePinRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
currentEPBCurrent E P B - [Optional]
newEPBNew E P B - [Optional]
operationDateOfCurrentOperation Date Of Current - [Optional]
operationDateOfNewOperation Date Of New - [Optional]
ChangeSecurePinResponse
successSuccess
encryptedPinEncrypted Pin - [Optional]
responseCodeResponse Code - [Optional]
responseDescriptionResponse Description - [Optional]
CreateAndProcessNoNameCardApplicationRequest
productNumberProduct Number
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
customerNumberCustomer Number - [Optional]
branchCodeBranch Code - [Optional]
Permissions - [Optional]
List Of Account - [Optional]
enrollMasterpassEnroll Masterpass - [Optional]
applicationContractIdApplication Contract Id - [Optional]
CreateAndProcessNoNameCardApplicationResponse
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
Warnings - [Optional]
Sensitive Card Data - [Optional]
applicationIdApplication Id - [Optional]
CreateCardMiscOption
optionTypeOption Type - [Optional]
optionValueOption Value - [Optional]
CreateCardUsingNoNameApplicationRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
applicationIdApplication Id - [Optional]
correlationIdCorrelation Id - [Optional]
customerNumberCustomer Number - [Optional]
barcodeBarcode - [Optional]
Permissions - [Optional]
List Of Account - [Optional]
CreateCardUsingNoNameApplicationResponse
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
Warnings - [Optional]
Sensitive Card Data - [Optional]
CreateCorporateCardAccount
accountNumberAccount Number
accountTypeAccount Type - [Optional]
accountOrderFlagAccount Order Flag - [Optional]
currencyCodeCurrency Code - [Optional]
fxAutoConversionFlagFx Auto Conversion Flag
CreateCorporateCardRequest
productNumberProduct Number
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
digitalCardFlagDigital Card Flag
customerNumberCustomer Number - [Optional]
shadowCardNumberShadow Card Number
nameOnCardName On Card - [Optional]
secondNameOnCardSecond Name On Card
branchCodeBranch Code - [Optional]
cardDeliveryTypeCard Delivery Type - [Optional]
cardSendAddressTypeCard Send Address Type - [Optional]
cardSendAddressIdCard Send Address Id - [Optional]
cardDeliveryBranchCodeCard Delivery Branch Code - [Optional]
Permissions - [Optional]
List Of Account - [Optional]
applicationDateApplication Date - [Optional]
applicationContractIdApplication Contract Id - [Optional]
CreateCorporateCardResponse
recordIdRecord Id - [Optional]
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
mainShadowCardNumberMain Shadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
Warnings - [Optional]
applicationIdApplication Id - [Optional]
CreateDisputeCaseDetail
DisputeAmountDispute Amount
UTIDU T I D
CurrencyCodeCurrency Code
DisputeAmountCurrencyCodeDispute Amount Currency Code
ClearingChannelClearing Channel
ClearingTableNameClearing Table Name
ClearingNumberClearing Number
AcquirerRefNumberAcquirer Ref Number
ExternalCaseIdExternal Case Id
ExternalDocumentIdExternal Document Id
SpecialFollowupSpecial Followup
VipFlagVip Flag
Dms Reference
CreateDisputeCaseRequest
ChannelChannel
CardNumberCard Number
ShadowCardNumberShadow Card Number
CardRefNumberCard Ref Number
EncryptedCardNumberEncrypted Card Number
CaseTypeCase Type
DisputeDateDispute Date
DisputeReasonCodeDispute Reason Code
DisputeExplanationDispute Explanation
ExternalCaseIdExternal Case Id
SpecialFollowupSpecial Followup
VipFlagVip Flag
Create Dispute Case Detail
Dms Reference
CreateDisputeCaseResponse
CaseNumberCase Number
Dispute Transaction
CreateDummyCorporateCardRequest
productNumberProduct Number
channelChannel
customerNumberCustomer Number
digitalCardFlagDigital Card Flag
cardDeliveryTypeCard Delivery Type
cardSendAddressTypeCard Send Address Type
cardDeliveryBranchCodeCard Delivery Branch Code
branchCodeBranch Code
nameOnCardName On Card
applicationDateApplication Date
CreateDummyCorporateCardResponse
cardMasterRecordIdCard Master Record Id
secureCardMasterRecordIdSecure Card Master Record Id
cardRefNumberCard Ref Number
mainCardRefNumberMain Card Ref Number
shadowCardNumberShadow Card Number
CreateIndividualCardAccount
accountNumberAccount Number
accountTypeAccount Type - [Optional]
accountOrderFlagAccount Order Flag - [Optional]
currencyCodeCurrency Code - [Optional]
fxAutoConversionFlagFx Auto Conversion Flag
CreateIndividualCardPermissions
eCommercePermittedE Commerce Permitted
mailOrderPermittedMail Order Permitted
CreateIndividualCardRequest
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel.
productNumberRequired · NotNull — The product the card is issued on. Must be a product the platform defines.
customerNumberRequired · NotNull — The customer the card is issued to.
branchCodeRequired · NotNull — The branch the card is issued from. Must be a defined branch.
Required · ListHasNoItem — The accounts the card draws on. Must be sent and must hold at least one entry.
digitalCardFlagDigital Card Flag
nameOnCardName On Card - [Optional]
cardDeliveryTypeOptional — How the card reaches the cardholder. Branch makes cardDeliveryBranchCode mandatory.
cardSendAddressTypeCard Send Address Type - [Optional]
cardDeliveryBranchCodeConditional · NotNull — The branch the card is delivered to. Mandatory when cardDeliveryType is Branch, and it must be a defined branch.
cardSendAddressIdCard Send Address Id - [Optional]
Permissions - [Optional]
Card Misc Option - [Optional]
enrollMasterpassEnroll Masterpass - [Optional]
applicationDateApplication Date - [Optional]
applicationContractIdApplication Contract Id - [Optional]
contractTypeContract Type - [Optional]
contractVersionNumberContract Version Number - [Optional]
CreateIndividualResponse
recordIdRecord Id - [Optional]
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
Warnings - [Optional]
applicationIdApplication Id - [Optional]
Attach Account List - [Optional]
CreateIndividualSupplementaryCardRequest
productNumberProduct Number
channelChannel
digitalCardFlagDigital Card Flag
customerNumberCustomer Number
shadowCardNumberShadow Card Number
nameOnCardName On Card
branchCodeBranch Code
cardDeliveryTypeCard Delivery Type
cardSendAddressTypeCard Send Address Type
cardDeliveryBranchCodeCard Delivery Branch Code
cardSendAddressIdCard Send Address Id
List Of Account
Permissions
Card Misc Option
enrollMasterpassEnroll Masterpass
applicationDateApplication Date
applicationContractIdApplication Contract Id
contractTypeContract Type
contractVersionNumberContract Version Number
CreateIndividualSupplementaryCardResponse
recordIdRecord Id
maskedCardNumberMasked Card Number
shadowCardNumberShadow Card Number
cardRefNumberCard Ref Number
mainCardRefNumberMain Card Ref Number
Warnings
applicationIdApplication Id
Attach Account List
CreateNoNameCardApplicationRequest
channelChannel
productNumberProduct Number
digitalCardDigital Card
customerNumberCustomer Number - [Optional]
branchCodeBranch Code - [Optional]
Permissions - [Optional]
List Of Account - [Optional]
correlationIdCorrelation Id - [Optional]
enrollMasterpassEnroll Masterpass - [Optional]
applicationContractIdApplication Contract Id - [Optional]
CreateVirtualCardRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
enrollMasterpassEnroll Masterpass - [Optional]
List Of Account - [Optional]
CreateVirtualCardResponse
recordIdRecord Id
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
relatedCardRefNumberRelated Card Ref Number - [Optional]
Warnings - [Optional]
Sensitive Card Data - [Optional]
Attach Account List - [Optional]
CustomerLimitationParameterData
customerNumberCustomer Number
customerLimitationFlagCustomer Limitation Flag - [Optional]
profileCodeProfile Code - [Optional]
profileDescriptionProfile Description - [Optional]
Keys - [Optional]
perTrnAmountPer Trn Amount - [Optional]
perTrnAmountLimitRatioPer Trn Amount Limit Ratio - [Optional]
dailyTrnCountDaily Trn Count - [Optional]
dailyTrnAmountDaily Trn Amount - [Optional]
weeklyTrnCountWeekly Trn Count - [Optional]
weeklyTrnAmountWeekly Trn Amount - [Optional]
monthlyTrnCountMonthly Trn Count - [Optional]
monthlyTrnAmountMonthly Trn Amount - [Optional]
yearlyTrnCountYearly Trn Count - [Optional]
yearlyTrnAmountYearly Trn Amount - [Optional]
cardTypeCard Type - [Optional]
DebitCardModel
supplementaryCardFlagSupplementary Card Flag
cardRefCurrentCardFlagCard Ref Current Card Flag
branchCodeBranch Code
virtualFlagVirtual Flag
digitalCardFlagDigital Card Flag
emvFlagEmv Flag
magneticStripeFlagMagnetic Stripe Flag
contactlessFlagContactless Flag
rewardEarningFlagReward Earning Flag
provisionStatusFlagProvision Status Flag
cvv2RetryCountCvv2 Retry Count
pinRetryCountPin Retry Count
disabledFlagDisabled Flag
pendingReplaceApplicationExistsPending Replace Application Exists
shadowCardNumberShadow Card Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
customerNumberCustomer Number - [Optional]
mainCustomerNumberMain Customer Number - [Optional]
relatedCardRefNumberRelated Card Ref Number - [Optional]
branchNameBranch Name - [Optional]
ownerNameOwner Name - [Optional]
ownerSecondNameOwner Second Name - [Optional]
ownerSurnameOwner Surname - [Optional]
embossNameEmboss Name - [Optional]
productNumberProduct Number - [Optional]
productSegmentCodeProduct Segment Code - [Optional]
cardStatusCodeCard Status Code - [Optional]
cardStatusDscrCard Status Dscr - [Optional]
cardStatusReasonCodeCard Status Reason Code - [Optional]
cardStatusReasonDscrCard Status Reason Dscr - [Optional]
productNameProduct Name - [Optional]
productShortNameProduct Short Name - [Optional]
tenantIdTenant Id - [Optional]
cardBrandCard Brand - [Optional]
cardBrandDescriptionCard Brand Description - [Optional]
cardDeliveryTypeCard Delivery Type - [Optional]
expiryDateStrExpiry Date Str - [Optional]
cardFormTypeCard Form Type
insertDateInsert Date - [Optional]
barcodeBarcode - [Optional]
fromShadowCardNumberFrom Shadow Card Number - [Optional]
toShadowCardNumberTo Shadow Card Number - [Optional]
requestDateRequest Date - [Optional]
requestChannelRequest Channel - [Optional]
embossReasonCodeEmboss Reason Code - [Optional]
embossReasonDescriptionEmboss Reason Description - [Optional]
embossReasonSubCodeEmboss Reason Sub Code - [Optional]
embossReasonSubDescEmboss Reason Sub Desc - [Optional]
cardStatusChangeDateCard Status Change Date - [Optional]
firstTrnDateFirst Trn Date - [Optional]
lastTrnDateLast Trn Date - [Optional]
firstPinSetDateFirst Pin Set Date - [Optional]
lastPinSetDateLast Pin Set Date - [Optional]
lastPinChangeDateLast Pin Change Date - [Optional]
deliveryAddressDelivery Address - [Optional]
isFirstPinSetIs First Pin Set - [Optional]
sendingBranchCodeSending Branch Code - [Optional]
sendingAddressTypeSending Address Type - [Optional]
productGroupCodeProduct Group Code - [Optional]
productGroupDescriptionProduct Group Description - [Optional]
fromMaskedCardNumberFrom Masked Card Number - [Optional]
toMaskedCardNumberTo Masked Card Number - [Optional]
Card Account Info List - [Optional]
Filled only for a digital or virtual card. On a physical card it is null.
pinStatusPin Status - [Optional]
cardStatusChangeChannelCard Status Change Channel - [Optional]
securityFlagSecurity Flag - [Optional]
citizenshipNumberCitizenship Number - [Optional]
taxNumberTax Number - [Optional]
customerNameSurnameCustomer Name Surname - [Optional]
cardSeqNumberCard Seq Number - [Optional]
isDeliveredIs Delivered - [Optional]
DebitCardPermissions
restrictionCodeRestriction Code - [Optional]
restrictionCodeDescriptionRestriction Code Description - [Optional]
restrictionPermissionIndicatorRestriction Permission Indicator - [Optional]
restrictionPermissionIndicatorDescriptionRestriction Permission Indicator Description - [Optional]
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
securityFlagSecurity Flag - [Optional]
DebitCorporateCustomerInfo
mainCustomerNumberMain Customer Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
DetachCardAccountByAccountNumberRequest
shadowCardNumberShadow Card Number
accountNumberAccount Number
accountSuffixAccount Suffix
channelChannel
DetachCardAccountByAccountNumberResponse
listOfRemovedRecordIdList Of Removed Record Id
DetachCardAccountRequest
recordIdRecord Id
channelChannel
shadowCardNumberShadow Card Number
DisputeListItem
CaseNumberCase Number
CustomerNumberCustomer Number
DisputeAmountDispute Amount
DisputeCurrencyCodeDispute Currency Code
DisputeDateDispute Date
DisputeReasonCodeDispute Reason Code
DisputeTransactionIdDispute Transaction Id
InsertUserIdInsert User Id
MaskedCardNumberMasked Card Number
ShadowCardNumberShadow Card Number
MerchantNameMerchant Name
TrnAmountTrn Amount
TrnCurrencyCodeTrn Currency Code
TrnDateTrn Date
TrnStatusDescriptionTrn Status Description
AuthorizationNumberAuthorization Number
MccMcc
SourceNetworkSource Network
UtidUtid
DisputeTransactionDetail
DisputeTransactionIdDispute Transaction Id
UTIDU T I D
Error
transactionIdTransaction Id
errorCodeError Code
descriptionDescription
messageMessage
messageFormatMessage Format
argumentsArguments
propertyNameProperty Name
detailDetail
Items
isTechnicalErrorIs Technical Error
exceptionTypeException Type
GenerateCVVRequest
channelRequired · NotNull — Three-digit channel code.
shadowCardNumberRequired · NotNull — The card to generate a verification value for.
GenerateCVVResponse
hasErrorHas Error
errorTextError Text - [Optional]
verificationValueVerification Value - [Optional]
GetApplicableProductsByCustomerNumberRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
customerNumberCustomer Number - [Optional]
mainCustomerNumberMain Customer Number - [Optional]
Filter - [Optional]
GetApplicableProductsItem
digitalAbilityDigital Ability
productNumberProduct Number - [Optional]
productNameProduct Name - [Optional]
productShortNameProduct Short Name - [Optional]
brandBrand - [Optional]
tenantIdTenant Id - [Optional]
GetAuthorizationListByBegindateEnddateParam
AuthorizationMatchStatusAuthorization Match Status - [Optional]
BeginDateBegin Date - [Optional]
CardRefNumberCard Ref Number - [Optional]
CustomerNumberCustomer Number - [Optional]
EndDateEnd Date - [Optional]
MaxAmountMax Amount - [Optional]
MccMcc - [Optional]
MinAmountMin Amount - [Optional]
NetworkTypeNetwork Type - [Optional]
NotSuccesfullResponseNot Succesfull Response - [Optional]
ResponseCodeResponse Code - [Optional]
ResponseReasonCodeResponse Reason Code - [Optional]
RrnRrn - [Optional]
ShadowCardNumberShadow Card Number - [Optional]
TrnCodeMatrixIdTrn Code Matrix Id - [Optional]
TrnStatusTrn Status - [Optional]
GetAuthorizationListByBegindateEnddateRequest
Get Authorization List By Begindate Enddate Param - [Optional]
GetAuthorizationListByBegindateEnddateResponse
Get Authorization List By Begindate Enddate Result - [Optional]
GetAuthorizationListByBegindateEnddateResult
OpenReceiptFormIsEnabledFlagOpen Receipt Form Is Enabled Flag
AccountNumberAccount Number - [Optional]
AcqInstitutionIdAcq Institution Id - [Optional]
AuthorizationMatchStatusAuthorization Match Status - [Optional]
AuthorizationNumberAuthorization Number - [Optional]
CardRefNumberCard Ref Number - [Optional]
CardSeqNumberCard Seq Number - [Optional]
ChannelTypeChannel Type - [Optional]
ChannelTypeDescriptionChannel Type Description - [Optional]
CommissionAmountCommission Amount - [Optional]
CustomerCustomer - [Optional]
CustomerNumberCustomer Number - [Optional]
DigitalSlipValueDigital Slip Value - [Optional]
EarnedPointEarned Point - [Optional]
FeeAmountFee Amount - [Optional]
InstallmentCountInstallment Count
InstallmentParameterInstallment Parameter
InstallmentProfitRateInstallment Profit Rate
IsChipFlagIs Chip Flag - [Optional]
LocalAmountLocal Amount - [Optional]
LocalCurrencyCodeLocal Currency Code - [Optional]
LocalCurrencyDescriptionLocal Currency Description - [Optional]
MainCardRefNumberMain Card Ref Number - [Optional]
MainCustomerNumberMain Customer Number - [Optional]
MaskedCardNumberMasked Card Number - [Optional]
MatchStatusDescriptionMatch Status Description - [Optional]
MccMcc - [Optional]
MccDescriptionMcc Description - [Optional]
MccGroupCodeMcc Group Code - [Optional]
MerchantCountryCodeMerchant Country Code - [Optional]
MerchantNameMerchant Name - [Optional]
MerchantNumberMerchant Number - [Optional]
NetworkTypeDescriptionNetwork Type Description - [Optional]
OfflineFlagOffline Flag - [Optional]
PanEntryModePan Entry Mode - [Optional]
PinUsagePin Usage - [Optional]
PreAuthorizationStatusPre Authorization Status - [Optional]
ProductDigitalFlagProduct Digital Flag - [Optional]
ProductNameProduct Name - [Optional]
ProductVirtualFlagProduct Virtual Flag - [Optional]
ResponseCodeDescriptionResponse Code Description - [Optional]
ResponseReasonCodeDescriptionResponse Reason Code Description - [Optional]
RrnRrn - [Optional]
SettlementAmountSettlement Amount - [Optional]
SettlementCurrencyDescriptionSettlement Currency Description - [Optional]
ShadowCardNumberShadow Card Number - [Optional]
SourceTabSource Tab - [Optional]
SuccessCodeSuccess Code - [Optional]
SupplementaryCardFlagSupplementary Card Flag
TerminalNumberTerminal Number - [Optional]
TerminalTypeTerminal Type - [Optional]
TransactionDateTransaction Date - [Optional]
TransactionDescriptionTransaction Description - [Optional]
TransactionTimeTransaction Time - [Optional]
TrnAmountTrn Amount - [Optional]
TrnCodeMatrixDescriptionTrn Code Matrix Description - [Optional]
TrnCodeMatrixIdTrn Code Matrix Id - [Optional]
TrnCurrencyCodeTrn Currency Code - [Optional]
TrnCurrencyDescriptionTrn Currency Description - [Optional]
TrnEffectTrn Effect - [Optional]
TrnRewardAbilityTrn Reward Ability - [Optional]
TrnStatusCodeTrn Status Code - [Optional]
TrnStatusDescriptionTrn Status Description - [Optional]
UtidUtid - [Optional]
GetAvailableECommerceLimitRequest
shadowCardNumberShadow Card Number - [Optional]
dateDate - [Optional]
mccMcc
mccGroupMcc Group
GetAvailableECommerceLimitResponse
availableAmountLimitAvailable Amount Limit - [Optional]
availableCountLimitAvailable Count Limit - [Optional]
cardRefNumberCard Ref Number - [Optional]
channelTypeChannel Type - [Optional]
monthlyTrnAmountMonthly Trn Amount - [Optional]
monthlyTrnCountMonthly Trn Count - [Optional]
networkTypeNetwork Type - [Optional]
shadowCardNumberShadow Card Number - [Optional]
trnAmountUsageTrn Amount Usage - [Optional]
trnCountUsageTrn Count Usage - [Optional]
GetCardAccountCurrencyConversionRequest
channelChannel
shadowCardNumberShadow Card Number
GetCardAccountCurrencyConversionResponse
fxAutoConversionFlagFx Auto Conversion Flag
shadowCardNumberShadow Card Number
accountNumberAccount Number
GetCardApplication
accountNumberAccount Number
accountBranchIdAccount Branch Id
fecCodeFec Code
balanceBalance
usableBalanceUsable Balance
cardAccountTypeCard Account Type - [Optional]
accountTypeAccount Type - [Optional]
accountSubTypeAccount Sub Type - [Optional]
accountOrderFlagAccount Order Flag - [Optional]
currencyCodeCurrency Code - [Optional]
iBANI B A N - [Optional]
errorDescriptionError Description - [Optional]
GetCardApplicationListRequest
applicationIdApplication Id - [Optional]
customerNumberCustomer Number - [Optional]
GetCardInfoRequest
shadowCardNumberOne-of — The card to read. Send this or cardNumber; sending neither is refused.
cardNumberOne-of — The card's PAN. Resolved to a shadow card number first, and refused if it matches none. When both are sent this one is used.
GetCardListRequest
customerNumberCustomer Number - [Optional]
mainCustomerNumberMain Customer Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
barcodeBarcode - [Optional]
accountNumberAccount Number - [Optional]
cardNumberCard Number - [Optional]
purposePurpose - [Optional]
channelCodeThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
tenantIdTenant Id - [Optional]
isCorporateAllCardListIs Corporate All Card List - [Optional]
branchCodeBranch Code - [Optional]
customerNameSurnameCustomer Name Surname - [Optional]
identificationNumberIdentification Number - [Optional]
courierStatusCourier Status - [Optional]
GetCardMiscOptionRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
optionTypeOption Type - [Optional]
customerNumberCustomer Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
onlyMainCardFlagOnly Main Card Flag
GetCardOperationLimitRequest
cardRefNumberRequired · NotNull — The card whose limits are read.
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel.
GetCardOperationLimitResponseItem
Keys - [Optional]
perTrnAmountPer Trn Amount - [Optional]
perTrnAmountLimitRatioPer Trn Amount Limit Ratio - [Optional]
dailyTrnCountDaily Trn Count - [Optional]
dailyTrnAmountDaily Trn Amount - [Optional]
weeklyTrnCountWeekly Trn Count - [Optional]
weeklyTrnAmountWeekly Trn Amount - [Optional]
monthlyTrnCountMonthly Trn Count - [Optional]
monthlyTrnAmountMonthly Trn Amount - [Optional]
yearlyTrnCountYearly Trn Count - [Optional]
yearlyTrnAmountYearly Trn Amount - [Optional]
GetCardPermissionsRequest
shadowCardNumberOptional — The card whose permissions are read. Not validated here — unlike the credit twin, this operation checks nothing and a card it cannot find comes back as an empty list rather than an error.
GetCardPinOperationHistory
channelTypeChannel Type - [Optional]
insertDateInsert Date - [Optional]
operationResultOperation Result - [Optional]
operationResultDescriptionOperation Result Description - [Optional]
operationTypeOperation Type - [Optional]
operationTypeDescriptionOperation Type Description - [Optional]
GetCardTypeByBinResponse
cardTypeCard Type — 0 None, 1 Credit, 2 Debit, 3 Prepaid
GetCorporateCustomerInfoByIndividualCustomerRequest
customerNumberCustomer Number - [Optional]
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
GetCorporateCustomerInfoByIndividualCustomerResponse
List Of Debit Corporate Customer Info - [Optional]
GetCustomerAssetRequest
customerNumberCustomer Number - [Optional]
purposePurpose - [Optional]
channelCodeThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
GetCustomerAssetsSummaryDebitCardModel
supplementaryCardFlagSupplementary Card Flag
digitalCardFlagDigital Card Flag
shadowCardNumberShadow Card Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
customerNumberCustomer Number - [Optional]
mainCustomerNumberMain Customer Number - [Optional]
productNumberProduct Number - [Optional]
productNameProduct Name - [Optional]
productShortNameProduct Short Name - [Optional]
expiryDateStrExpiry Date Str - [Optional]
cardStatusCodeCard Status Code - [Optional]
cardStatusCodeDescriptionCard Status Code Description - [Optional]
cardStatusReasonCodeCard Status Reason Code - [Optional]
cardStatusReasonCodeDescriptionCard Status Reason Code Description - [Optional]
cardStatusChangeChannelCard Status Change Channel - [Optional]
securityFlagSecurity Flag - [Optional]
Card Account Info List - [Optional]
GetCustomerAssetsSummaryDebitRequest
customerNumberCustomer Number - [Optional]
channelCodeThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
GetCustomerDebitCardListByTenantIdRequest
customerNumberCustomer Number
tenantIdTenant Id
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
GetCustomerDebitCardListByTenantIdResult
digitalCardFlagDigital Card Flag
usableBalanceUsable Balance
pendingReplaceApplicationExistsPending Replace Application Exists
binBin - [Optional]
keyDerivationIndexKey Derivation Index - [Optional]
encryptedCardNumberEncrypted Card Number - [Optional]
toShadowCardNumberTo Shadow Card Number - [Optional]
accountNumberAccount Number - [Optional]
barcodeBarcode - [Optional]
cardRenewStatusCard Renew Status - [Optional]
cardRenewSubStatusCard Renew Sub Status - [Optional]
cardStatusCodeCard Status Code - [Optional]
cardStatusCodeDescCard Status Code Desc - [Optional]
cardStatusReasonCodeCard Status Reason Code - [Optional]
cardStatusReasonCodeDescCard Status Reason Code Desc - [Optional]
customerNumberCustomer Number - [Optional]
firstPinSetDateFirst Pin Set Date - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
noNameFlagNo Name Flag - [Optional]
productNumberProduct Number - [Optional]
productShortNameProduct Short Name - [Optional]
shadowCardNumberShadow Card Number - [Optional]
currencyCodeCurrency Code - [Optional]
expiryDateStrExpiry Date Str - [Optional]
GetCustomerDebitShadowCardsByTenantIdRequest
customerNumberCustomer Number
tenantIdTenant Id
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
GetCustomerDebitShadowCardsByTenantIdResponse
Customer Debit Shadow Card List - [Optional]
GetCustomerDebitShadowCardsByTenantIdResult
cardTypeCard Type - [Optional]
customerNumberCustomer Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
productNumberProduct Number - [Optional]
productShortNameProduct Short Name - [Optional]
cardStatusCodeCard Status Code - [Optional]
cardStatusCodeDescCard Status Code Desc - [Optional]
cardStatusReasonCodeCard Status Reason Code - [Optional]
cardStatusReasonCodeDescCard Status Reason Code Desc - [Optional]
GetCustomerLimitationParametersResponse
Customer Limitation Parameter Data List - [Optional]
GetCustomerOperationLimitRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
customerNumberCustomer Number - [Optional]
GetDbttransactionByCardrefCustomernumParam
CardRefNumberCard Ref Number - [Optional]
CustomerNumberCustomer Number - [Optional]
EmbossNameEmboss Name - [Optional]
MaxAmountMax Amount - [Optional]
MinAmountMin Amount - [Optional]
ShadowCardNumberShadow Card Number - [Optional]
SourceNetworkSource Network - [Optional]
TransactiondatebeginTransactiondatebegin - [Optional]
TransactiondateendTransactiondateend - [Optional]
TrnCodeMatrixIdTrn Code Matrix Id - [Optional]
GetDbttransactionByCardrefCustomernumRequest
Get Dbttransaction By Cardref Customernum Param - [Optional]
GetDbttransactionByCardrefCustomernumResponse
Get Dbttransaction By Cardref Customernum Result - [Optional]
GetDbttransactionByCardrefCustomernumResult
AccountNumberAccount Number - [Optional]
AcqInstitutionIdAcq Institution Id - [Optional]
AcqRefNumberAcq Ref Number - [Optional]
AuthorizationMatchStatusAuthorization Match Status - [Optional]
AuthorizationNumberAuthorization Number - [Optional]
BillingAmountBilling Amount - [Optional]
BillingCurrencyBilling Currency - [Optional]
BkmUniqueMerchantIdBkm Unique Merchant Id - [Optional]
CampaignCodeAcqCampaign Code Acq - [Optional]
CampaignCodeIssCampaign Code Iss - [Optional]
ChannelTypeChannel Type - [Optional]
ChannelTypeDescriptionChannel Type Description - [Optional]
ClearingChannelClearing Channel - [Optional]
ClearingDateClearing Date - [Optional]
ClearingNumberClearing Number - [Optional]
CustomerNumberListCustomer Number List - [Optional]
DigitalSlipValueDigital Slip Value - [Optional]
DisplayAtChannelsDisplay At Channels - [Optional]
EarnedRewardBankEarned Reward Bank - [Optional]
EarnedRewardCampaignAcqEarned Reward Campaign Acq - [Optional]
EarnedRewardCampaignIssEarned Reward Campaign Iss - [Optional]
EarnedRewardMerchantEarned Reward Merchant - [Optional]
EmbossNameEmboss Name - [Optional]
EodDateEod Date - [Optional]
InstallmentCountInstallment Count
InstallmentParameterInstallment Parameter
InstallmentProfitRateInstallment Profit Rate
InvoiceNumberInvoice Number - [Optional]
LocalAmountLocal Amount - [Optional]
LocalCurrencyLocal Currency - [Optional]
LocalCurrencyCodeLocal Currency Code - [Optional]
MainCardRefNumberMain Card Ref Number - [Optional]
MainCustomerNumberMain Customer Number - [Optional]
MaskedCardNumberMasked Card Number - [Optional]
MatchStatusDescriptionMatch Status Description - [Optional]
MccMcc - [Optional]
MccDescriptionMcc Description - [Optional]
MccGroupCodeMcc Group Code - [Optional]
MerchantAmexIdMerchant Amex Id - [Optional]
MerchantCityMerchant City - [Optional]
MerchantCountryCodeMerchant Country Code - [Optional]
MerchantNameMerchant Name - [Optional]
MerchantNumberMerchant Number - [Optional]
NetworkDescriptionNetwork Description - [Optional]
OfflineFlagOffline Flag - [Optional]
PanEntryModePan Entry Mode - [Optional]
PinUsagePin Usage - [Optional]
ProductProduct - [Optional]
ProductDigitalFlagProduct Digital Flag - [Optional]
ProductVirtualFlagProduct Virtual Flag - [Optional]
RefUtidRef Utid - [Optional]
RequestDateRequest Date - [Optional]
RewardTypeDescriptionReward Type Description - [Optional]
RrnRrn - [Optional]
SettlementAmountSettlement Amount - [Optional]
SettlementCurrencySettlement Currency - [Optional]
ShadowCardNumberShadow Card Number - [Optional]
SupplementaryCardFlagSupplementary Card Flag
TerminalNumberTerminal Number - [Optional]
TerminalTypeTerminal Type - [Optional]
TransactionDescriptionTransaction Description - [Optional]
TrnAmountTrn Amount - [Optional]
TrnCodeMatrixDescTrn Code Matrix Desc - [Optional]
TrnCodeMatrixIdTrn Code Matrix Id - [Optional]
TrnCurrencyTrn Currency - [Optional]
TrnCurrencyCodeTrn Currency Code - [Optional]
TrnDateTrn Date - [Optional]
TrnDescriptionTrn Description - [Optional]
TrnEffectTrn Effect - [Optional]
TrnOriginTrn Origin - [Optional]
TrnRewardAbilityTrn Reward Ability - [Optional]
TrnStatusTrn Status - [Optional]
UtidUtid - [Optional]
GetDebitApplicationIdByFromShadowCardNumberRequest
shadowCardNumberShadow Card Number
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
GetDebitApplicationIdByFromShadowCardNumberResponse
applicationIdApplication Id - [Optional]
applicationDateApplication Date - [Optional]
GetDebitCustomerLisfOfBranchRequest
branchCodeBranch Code - [Optional]
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
GetDebitTransactionAllRequest
shadowCardNumberShadow Card Number - [Optional]
beginDateBegin Date - [Optional]
endDateEnd Date - [Optional]
responseCodeResponse Code - [Optional]
responseReasonCodeResponse Reason Code - [Optional]
networkTypeNetwork Type - [Optional]
trnCodeMatrixIdTrn Code Matrix Id - [Optional]
maxAmountMax Amount - [Optional]
minAmountMin Amount - [Optional]
GetDebitTransactionAllResponse
totalAmountTotal Amount
List Of Transaction - [Optional]
GetDebitTransactionAllResponseItem
cardProductVirtualFlagCard Product Virtual Flag
cardProductDigitalFlagCard Product Digital Flag
sourceTabSource Tab - [Optional]
terminalNumberTerminal Number - [Optional]
authorizationNumberAuthorization Number - [Optional]
authorizationMatchStatusAuthorization Match Status - [Optional]
cardRefNumberCard Ref Number - [Optional]
cardSeqNumberCard Seq Number - [Optional]
channelTypeDescriptionChannel Type Description - [Optional]
customerCustomer - [Optional]
customerNumberCustomer Number - [Optional]
digitalSlipValueDigital Slip Value - [Optional]
isChipFlagIs Chip Flag - [Optional]
localAmountLocal Amount - [Optional]
localCurrencyDescriptionLocal Currency Description - [Optional]
mainCustomerNumberMain Customer Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
matchStatusDescriptionMatch Status Description - [Optional]
mccDescriptionMcc Description - [Optional]
merchantCountryCodeMerchant Country Code - [Optional]
merchantNameMerchant Name - [Optional]
merchantNumberMerchant Number - [Optional]
networkTypeDescriptionNetwork Type Description - [Optional]
offlineFlagOffline Flag - [Optional]
panEntryModePan Entry Mode - [Optional]
pinUsagePin Usage - [Optional]
responseCodeDescriptionResponse Code Description - [Optional]
responseReasonCodeDescriptionResponse Reason Code Description - [Optional]
rrnRrn - [Optional]
settlementAmountSettlement Amount - [Optional]
settlementCurrencyDescriptionSettlement Currency Description - [Optional]
terminalTypeTerminal Type - [Optional]
transactionDateTransaction Date - [Optional]
trnAmountTrn Amount - [Optional]
trnCodeMatrixDescriptionTrn Code Matrix Description - [Optional]
trnCurrencyDescriptionTrn Currency Description - [Optional]
trnStatusCodeTrn Status Code - [Optional]
trnStatusDescriptionTrn Status Description - [Optional]
utidUtid - [Optional]
trnEffectTrn Effect - [Optional]
channelTypeChannel Type - [Optional]
capitalRewardIndicatorCapital Reward Indicator - [Optional]
trnCurrencyCodeTrn Currency Code - [Optional]
transactionDescriptionTransaction Description - [Optional]
Earned Point - [Optional]
trnCodeMatrixIdTrn Code Matrix Id - [Optional]
shadowCardNumberShadow Card Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
mccMcc - [Optional]
mccGroupCodeMcc Group Code - [Optional]
localCurrencyCodeLocal Currency Code - [Optional]
accountNumberAccount Number - [Optional]
acqInstitutionIdAcq Institution Id - [Optional]
supplementaryCardFlagSupplementary Card Flag
GetDigitalSlipReceiptRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
utidUtid - [Optional]
GetDigitalSlipReceiptResponse
utidUtid - [Optional]
refUtidRef Utid - [Optional]
trnCodeMatrixIdTrn Code Matrix Id - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
trnAmountTrn Amount - [Optional]
trnCurrencyCodeTrn Currency Code - [Optional]
responseCodeResponse Code - [Optional]
trnDatetimeTrn Datetime - [Optional]
trnStatusTrn Status - [Optional]
stanStan - [Optional]
rrnRrn - [Optional]
authorizationNumberAuthorization Number - [Optional]
terminalNumberTerminal Number - [Optional]
merchantNumberMerchant Number - [Optional]
merchantNameMerchant Name - [Optional]
panEntryModePan Entry Mode - [Optional]
iccData84Icc Data84 - [Optional]
iccData9f26Icc Data9f26 - [Optional]
cardSeqNumberCard Seq Number - [Optional]
merchantAddressMerchant Address - [Optional]
GetDisputeListRequest
CaseNumberCase Number
DisputeTransactionIdDispute Transaction Id
UTIDU T I D
CustomerNumberCustomer Number
CardNumberCard Number
ShadowCardNumberShadow Card Number
CardRefNumberCard Ref Number
EncryptedCardNumberEncrypted Card Number
ExternalCaseIdExternal Case Id
GetPendingCardEmbossListResponse
cardSeqNumberCard Seq Number - [Optional]
embossDateEmboss Date - [Optional]
applicationDateApplication Date - [Optional]
embossReasonCodeEmboss Reason Code - [Optional]
embossReasonDescriptionEmboss Reason Description - [Optional]
embossReasonSubCodeEmboss Reason Sub Code - [Optional]
embossReasonSubDescEmboss Reason Sub Desc - [Optional]
embossStatusEmboss Status - [Optional]
maskedCardNumberMasked Card Number - [Optional]
productTypeCodeProduct Type Code - [Optional]
productTypeDescriptionProduct Type Description - [Optional]
shadowCardNumberShadow Card Number - [Optional]
validFlagValid Flag - [Optional]
IncreasePinTryCountRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
increaseCountIncrease Count - [Optional]
IsCardFoundInRipperResponse
isFoundIs Found
serviceDomainIdService Domain Id - [Optional]
IsCustomerConvertToRipperResponse
haveAnyDebitCardHave Any Debit Card
haveAnyCreditCardHave Any Credit Card
haveAnyPrepaidCardHave Any Prepaid Card
ListCardAccountByShadowCardNumberRequest
shadowCardNumberShadow Card Number - [Optional]
ModifyCardAccountRequest
recordIdRecord Id - [Optional]
accountTypeAccount Type - [Optional]
accountNumberAccount Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
accountAliasAccount Alias - [Optional]
accountOrderFlagAccount Order Flag - [Optional]
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
accountOrderAccount Order - [Optional]
fxAutoConversionFlagFx Auto Conversion Flag
NoNameCardAccount
accountNumberAccount Number
accountTypeAccount Type - [Optional]
accountOrderFlagAccount Order Flag - [Optional]
currencyCodeCurrency Code
fxAutoConversionFlagFx Auto Conversion Flag
OperationLimitErrorItem
errorCodeError Code - [Optional]
errorTextError Text - [Optional]
OperationLimitItem
Keys - [Optional]
profileCodeProfile Code - [Optional]
profileDescriptionProfile Description - [Optional]
perTrnAmountPer Trn Amount - [Optional]
perTrnAmountLimitRatioPer Trn Amount Limit Ratio - [Optional]
dailyTrnCountDaily Trn Count - [Optional]
dailyTrnAmountDaily Trn Amount - [Optional]
weeklyTrnCountWeekly Trn Count - [Optional]
weeklyTrnAmountWeekly Trn Amount - [Optional]
monthlyTrnCountMonthly Trn Count - [Optional]
monthlyTrnAmountMonthly Trn Amount - [Optional]
yearlyTrnCountYearly Trn Count - [Optional]
yearlyTrnAmountYearly Trn Amount - [Optional]
cardTypeCard Type - [Optional]
OperationLimitItemKeys
customLimitationChangeFlagCustom Limitation Change Flag
limitProfileDetailIdLimit Profile Detail Id - [Optional]
trnLimitationGroupCodeTrn Limitation Group Code - [Optional]
trnLimitationGroupDescriptionTrn Limitation Group Description - [Optional]
trnMainLimitationGroupCodeTrn Main Limitation Group Code - [Optional]
trnMainLimitationGroupDescriptionTrn Main Limitation Group Description - [Optional]
networkTypeNetwork Type - [Optional]
networkDescriptionNetwork Description - [Optional]
channelTypeChannel Type - [Optional]
channelDescriptionChannel Description - [Optional]
eventCodeEvent Code - [Optional]
eventDescriptionEvent Description - [Optional]
mccMcc
mccGroupMcc Group
RecreateCustomerCardAccountsRequest
shadowCardNumberShadow Card Number - [Optional]
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
Card Account List - [Optional]
RemoveCardOperationLimitRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
cardRefNumberCard Ref Number - [Optional]
List Of Remove Operation Limit Keys - [Optional]
RemoveCardOperationLimitResponseItem
actionTypeAction Type — 0 None, 1 Insert, 2 Update, 3 Delete
successSuccess
Operation Limit Keys - [Optional]
Errors - [Optional]
RemoveCustomerOperationLimitRequest
customerNumberCustomer Number
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
List Of Remove Operation Limit Keys - [Optional]
RemoveCustomerOperationLimitResponseItem
actionTypeAction Type — 0 None, 1 Insert, 2 Update, 3 Delete
successSuccess
Errors - [Optional]
Operation Limit Keys - [Optional]
RemoveOperationLimitItemKeys
operationLimitRecordIdOperation Limit Record Id
ReplaceCardPermissions
eCommercePermittedE Commerce Permitted - [Optional]
mailOrderPermittedMail Order Permitted - [Optional]
ReplaceCardRequest
channelRequired · Enum · NotNullOrWhiteSpace — Three-digit channel code. Must be a defined channel.
shadowCardNumberRequired · NotNullOrWhiteSpace — The card being replaced.
cardEmbossReasonRequired · Enum · NotNullOrWhiteSpace · NotEqualValue — Why the card is reissued. Renew is the only value this operation accepts; anything else is refused.
cardEmbossSubReasonRequired · NotNullOrWhiteSpace — The sub-reason under cardEmbossReason.
embossNameOptional — The name printed on the card.
deliveryTypeOptional — How the card reaches the cardholder. Branch makes deliveryBranchCode mandatory.
deliveryBranchCodeConditional — The branch the card is delivered to. Mandatory when deliveryType is Branch.
deliveryAddressTypeOptional — The address type the card is sent to.
productNumberOptional — Reissue onto a different product. If sent it must be a product the platform defines; the product change scenario must exist too.
cardSendAddressIdOptional — The stored address the card is sent to.
enrollMasterpassOptional — Enrol the new card in Masterpass.
Optional — Permissions to carry onto the new card.
ReplaceCardRequestInfo
deliveryTypeDelivery Type - [Optional]
deliveryAddressTypeDelivery Address Type - [Optional]
deliveryBranchCodeDelivery Branch Code - [Optional]
embossNameEmboss Name - [Optional]
cardEmbossReasonCard Emboss Reason - [Optional]
cardEmbossSubReasonCard Emboss Sub Reason - [Optional]
productNumberProduct Number - [Optional]
Permissions - [Optional]
cardSendAddressIdCard Send Address Id - [Optional]
ReplaceCardResponse
newCardGeneratedNew Card Generated
productChangedProduct Changed
shadowCardNumberShadow Card Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
Warnings - [Optional]
ReplaceCardResponseInfo
newCardGeneratedNew Card Generated
productChangedProduct Changed
expiryDateExpiry Date
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
ReplaceCardUsingNoNameApplicationRequest
barcodeBarcode - [Optional]
customerNumberCustomer Number - [Optional]
applicationIdApplication Id - [Optional]
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
ReplaceCardUsingNoNameApplicationResponse
recordIdRecord Id
maskedCardNumberMasked Card Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
Warnings - [Optional]
Sensitive Card Data - [Optional]
ReplaceNoNameCardRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
replaceReasonCodeReplace Reason Code - [Optional]
enrollMasterpassEnroll Masterpass - [Optional]
Permissions - [Optional]
ReplaceNoNameCardResponse
applicationIdApplication Id - [Optional]
shadowCardNumberShadow Card Number - [Optional]
newCardGeneratedNew Card Generated - [Optional]
productChangedProduct Changed - [Optional]
maskedCardNumberMasked Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
ResetCvvCounterRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
SaveCardAccountCurrencyConversionRequest
channelChannel
shadowCardNumberShadow Card Number
accountNumberAccount Number
fxAutoConversionFlagFx Auto Conversion Flag
SaveCardAccountCurrencyConversionResponse
accountNumberAccount Number
fxAutoConversionFlagFx Auto Conversion Flag
shadowCardNumberShadow Card Number
SaveCardBnplPermissionRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
cardRefNumberCard Ref Number - [Optional]
bnplFlagBnpl Flag - [Optional]
SaveCardBnplPermissionResponse
bnplFlagBnpl Flag
cardRefNumberCard Ref Number - [Optional]
SaveCardPermissionsRequest
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel.
Required · NotNull — The permissions to write. Must be sent; an empty list is accepted and changes nothing.
cardRefNumberOne-of · NotNull — The card to permit or restrict. Send this or shadowCardNumber; sending neither is refused with both named.
shadowCardNumberOne-of · NotNull — The card to permit or restrict. Send this or cardRefNumber; when both are sent this one finds the card.
SaveCardPermissionsRequestItem
restrictionCodeRequired · Enum · NotNull — The restriction this entry is about. Must be a restriction the platform defines; a bad one is reported against permissions.
permittedOptional · Default false — True permits, false restricts. Null is read as false.
startDateOptional · Nullable · Format date-time — When the permission starts.
endDateOptional · Nullable · Format date-time — When the permission ends.
transactionIdOptional — The caller's own id for this entry.
SaveCardPermissionsResponse
changedCountHow many entries actually changed. An entry already holding the value it was sent is skipped, so this can be lower than the number sent — and zero is a success.
listOfRecordIdList Of Record Id - [Optional]
SensitiveCardData
panPan - [Optional]
expiryDateStrExpiry Date Str - [Optional]
cvvCvv - [Optional]
SetCardOperationLimitRequest
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel, and the channel must be permitted to customise card limits.
cardRefNumberRequired · NotNull — The card whose limits are set.
Required · ListHasNoItem — The limits to write. Must be sent and must hold at least one entry.
SetCardOperationLimitResponseItem
actionTypeAction Type — 0 None, 1 Insert, 2 Update, 3 Delete
successSuccess
Errors - [Optional]
Operation Limit - [Optional]
SetCardPinRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
clearPinClear Pin - [Optional]
SetCardPinResponse
successSuccess
encryptedPinEncrypted Pin - [Optional]
SetCustomerOperationLimitRequest
customerNumberCustomer Number
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
List Of Operation Limit - [Optional]
SetCustomerOperationLimitResponseItem
actionTypeAction Type — 0 None, 1 Insert, 2 Update, 3 Delete
successSuccess
Errors - [Optional]
Operation Limit - [Optional]
SetSecurePinRequest
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel.
shadowCardNumberRequired · NotNull — The card whose PIN is set.
ePBRequired · NotNull — The encrypted PIN block.
operationDateRequired · NotNull — The date the operation is stamped with.
SetSecurePinResponse
successSuccess
encryptedPinEncrypted Pin - [Optional]
responseCodeResponse Code - [Optional]
responseDescriptionResponse Description - [Optional]
SubmitCardApplicationExtStatusRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
applicationIdApplication Id - [Optional]
externalStatusCodeExternal Status Code - [Optional]
SubmitCardApplicationExtStatusResponse
cardApplicationExtStatusHistoryRecordIdCard Application Ext Status History Record Id
TransferBranchCustomer
currentBranchCodeCurrent Branch Code - [Optional]
targetBranchCodeTarget Branch Code - [Optional]
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
listOfPersonIdList Of Person Id - [Optional]
TransferBranchCustomerResponse
oldBranchOld Branch
newBranchNew Branch
changedCardCountChanged Card Count
listOfShadowCardNumbersList Of Shadow Card Numbers - [Optional]
UpdateNoNameCardApplicationRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
correlationIdCorrelation Id - [Optional]
Permissions - [Optional]
List Of Account - [Optional]
UpdateTransactionForBNPLRequest
utidUtid
installmentCountInstallment Count
installmentParameterInstallment Parameter
installmentProfitRateInstallment Profit Rate
UpdateTransactionForBNPLResponse
isSuccessIs Success
errorMessageError Message
VerifyCVVPartialRequest
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel.
shadowCardNumberRequired · NotNull — The card whose CVV is being checked.
Required · NotBetween — The positions to check, as position/value pairs. Two or three pairs, no more and no fewer. Each position is 1 to 3 — the CVV is three digits — and each value is 0 to 9.
VerifyCVVPartialResponse
verifiedVerified
lastTryCountLast Try Count
tryCountExceedTry Count Exceed
VerifyCVVRequest
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel.
shadowCardNumberRequired · NotNull — The card whose CVV is being checked.
verificationValueRequired · NotNull · LengthNotEquals — The CVV to check. Exactly 3 characters; any other length is refused before the card is read.
VerifyCVVResponse
verifiedWhether the CVV matched. A CVV that does not match is not an error — the call returns 200 with this false, and the card's failed-attempt counter goes up. The value is checked against the card's current expiry date and, failing that, against its previous one, so a CVV that still matches the old expiry verifies.
lastTryCountThe failed-attempt counter after this call. Zero when the CVV matched, because a match resets it.
tryCountExceedTrue when this call took the counter to the platform's maximum. The next call is refused with 10508 before the CVV is looked at, until the counter is reset.
VerifyCardPinRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
clearCardNumberClear Card Number - [Optional]
clearPinClear Pin - [Optional]
VerifyCardPinResponse
verifiedVerified
lastTryCountLast Try Count
tryCountExceedTry Count Exceed
VerifyRsaPinWithStaticSaltRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
ePBE P B - [Optional]
operationDateOperation Date - [Optional]
staticSaltStatic Salt - [Optional]
VerifyRsaPinWithStaticSaltResponse
verifiedVerified
lastTryCountLast Try Count
tryCountExceedTry Count Exceed
responseCodeResponse Code
responseDescriptionResponse Description - [Optional]
VerifySecurePinRequest
channelThree-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
ePBE P B - [Optional]
operationDateOperation Date - [Optional]