Enroll Cardholder
Enroll Cardholder
The Enroll Cardholder API allows to enroll new cardholders providing them UserName/password. In case and the card is SPND/Unactivated Card, the API changes the status ACT. In case and the card is SPND/Unactivated Replacement Card, the API calls the activate card without doing a PIN Set (only replacement card).
Input Parameters:
GetHoldsBalance
N
Format: Y/N (Default = N)
Latitude
N
Format: Alphanumeric, Comma, Dot, "-", 1-8 (can be 40.71435) Description: Latitude can range between 0 and 90 degrees, and can be north or south. (Zero degrees latitude is neither north nor south.) The North Pole is at 90° north latitude; the South Pole is at 90° south latitude. The Equator is at zero degrees latitude.
Longitude
N
Format: Alphanumeric, Comma, Dot, "-", 1-9 (can be -74.00597) Description: Longitude can range between 0 and 180 degrees, and can be east or west. (Zero and 180 degrees longitude are neither east nor west.) The Greenwich Meridian, which passes through the United Kingdom, is at zero degrees longitude (unlike zero degrees latitude, the zero point for longitude is just an arbitrary choice, made for historical reasons).
NewCardholderPassword
Y
Format: Alphanumeric, 6 -10 (including char: ‘_’)
NewCardholderUserName
Y
Format: Alphanumeric, 6 -30 (including chars: ‘_’ ,‘-‘)
OrgId
N
Format: Alphanumeric, 20 Value can be multiple org_id’s split by commas
CardActivationMode
N
Format: Y (default)/N
Output Parameters:
CardholderUserName
Format: Alphanumeric, 6 -30 (including chars: ‘_’ ,‘-‘)
Not returned
Returned
DefaultAccountID
Format: Numeric, 20
Not returned
Returned
DefaultAccountCardNumber
Format: Numeric, 16
Not returned
Returned
Returned in list of DefaultAccountCards/DefaultAccountCard which return all cards related to the default account
DefaultAccountCardRPID
Format: Numeric, 1-19
Not returned
Returned
Returned in list of DefaultAccountCards/DefaultAccountCard which return all cards related to the default account
ReplacedCardNumber
Format: Numeric, 4 Description: XXXX-XXXX-XXXX-1234
Not returned
Returned
LoginCardStatus
Format options: "ACT" (Active) "CC" (Close) "CII" (Card In Inventory) "LOCK_CII" (Locked Card In Inventory) "LOCK" (Locked) "LST" (Lost) "SPLT" (Spoilt) "SPND" (Suspended) "STLN" (Stolen) Description: All application cards statuses (as ACT, SPND, etc)
Not returned
Returned
The status of the card provided in input parameter (before the API has run)
LoginCardStatusReason
Format options: CardExpired CardReplaced CIPException CloseCardForDispute Closed ClosedByPM Deceased Excess-Chargeback InsufficientKYC InvalidArrowEyefiles NegativeWriteOff POBox PrePurge PurgedCard PurgedFailedAtProcessor ReadyToPrint Arbitration ByPM CIPExceptionSus Confirmed Fraud Dispute Lost Lost-Stolen Other Poss Fraud Poss Fraud Warm Address Poss Fraud Warm Source IP PrimaryCardSuspension ProcSuspectedFraudWithNotes ReDisputed ReplaceFailure ReplacementCardRequired Represented Stolen StoreError SuspectedFraud TransactionCompletenessException UnactivatedCard UnactivatedReplacementCard Violation </p
Not returned
Returned
The status reason of the card provided in input parameter (before the API has run)
AccountID
Format: Numeric, 20 Description: Praxell Account ID
Not returned
Returned
Returned in list of Accounts (default account for UserName is saved in field DefaultAccountID)
AccountCurrentCardNumber
Format: Numeric, 16
Not returned
Returned
Returned in list of Accounts
AccountCurrentCardRPID
Format: Numeric, 1-19
Not returned
Returned
Returned in list of Accounts
AccountCurrentCardFirstName
Format: Alphanumeric, 10
Not returned
Returned
Returned in list of Accounts
AccountCurrentCardLastName
Format: Alphanumeric, 15
Not returned
Returned
Returned in list of Accounts
ActivationDate
Format: YYYY-MM-DD
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ActiveHoldsNumber
Format: Numeric, 11 Description:Number of active holds existing for Cardholder
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ActiveHoldsTotalAmount
Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ActualExpirationDate
Format: Alphanumeric, 12, Month YYYY Description: example, April 2013
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
AddressLine1
Format: Alphanumeric, 30
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
AddressLine2
Format: Alphanumeric, 30
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
Brand
Format: Alpha, 1-120
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
CardAvailableBalance
Format: Numeric, 11
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
CardDDA
Format: Numeric, 3-16
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
CardIssuingBank
Format: Alphanumeric, 30
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
CardIssuingBankCode
Format: Alphanumeric, 5
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
CardIssuingBankRoutingNumber
Format: Alphanumeric, 9
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
CardNumber
Format: Numeric, 16
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
CardStatus
Format options: "ACT" (Active) "CC" (Close) "CII" (Card In Inventory) "LOCK_CII" (Locked Card In Inventory) "LOCK" (Locked) "LST" (Lost) "SPLT" (Spoilt) "SPND" (Suspended) "STLN" (Stolen) Description: All application cards statuses (as ACT, SPND, etc)
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
CardStatusId
Format options: ACT, CC, CII, LOCK_CII, LOCK, LST, SPLT, SPND, STLN
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
CHState
Format options: NRNV RNV V-PNS V
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
City
Format: Alphanumeric, 20
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
Country
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
DateOfBirth
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
DocId
Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
DocType
Format options: SSN PASS UDL MCN INMATE Description: Closed list of values.Type of government identification document used: SSN- Social Security Number, PASS - Passport number, 'UDL' – US Drivers license number,'MCN' - Matricula consular ,INMATE.
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern: x@x.x
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ExpirationDate
Format: MMYY
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
Fax
Format: Numeric, 6-10 Description: the fax number.
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
FBEDDA
Format: Numeric, 16
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
FirstName
Format: Alphanumeric, 10
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
IsPinSet
Format: Y/N
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
IsReceiveSms
Format options: Enabled (the cardholder has requested to receive an SMS and therefore he get SMS's) Disabled (the cardholder has requested to not receive an SMS and therefore he does not get SMS's) Blank (the cardholder has not requested to receive an SMS and therefore he does not get SMS's) Description:Defines if the cardholder gets an SMS.
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
IsRegistered
Format: Y/N
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
IssueDate
Format: YYYY-MM-DD HH:MM:SS.M
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
IssuerName
Format: Alphanumeric, 30
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
IsVerified
Format: Y/N
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
LastName
Format: Alphanumeric, 15
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
MiddleInitial
Format: Alpha,1 Description: Middle name char of the cardholder.
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
MobilePhone
Format: Numeric, 6-15 Description: Mobile phone for getting SMS (see IsReceiveSms).
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
Phone
Format: Numeric, 6-15 Description: Phone number
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ProductTypeName
Format: Alphanumeric, 1-120 Description: Each sub program in Praxell consists of one or more product types. A product type is a set of attributes that are applied to the cards that belong to this product type. The ProductTypeName field is the name of the product used when creating and issuing cards.
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ProgramType
Format: Saving/Commercial/GPR
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
PT
Format: Alphanumeric, 30
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
PTExpirationDate
Format: MMYY
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
PTFriendlyName
Format: Alphanumeric, 1-120 Description: Product Type known name.
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ReplacementMessageType
Format options: ToBeReplacedInAnotherBankForVerifiedCH ToBeReplacedInAnotherBankForRNVCH PTExpirationDate CardExpirationDate ReplacementCardOrderedFromAnotherBank ReplacementCardOrderedFromSameBank ReplacedAnotherCardInAnotherBank
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ReplacementStatus
Format options: CardReplaced ReplacementCardObsolete ReplacementCardOrderedFromSameBank ReplacementCardOrderedFromAnotherBank ReplacedAnotherCardInSameBank ReplacedAnotherCardInAnotherBank ReplacementCardRequired ReplacementCardRequiredFailure ToBeReplacedInAnotherBank ToReplaceCardFromAnotherBank ToReplaceCardFromSameBank
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
RPID
Format: Numeric, 1-19
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
State
Format: Alphanumeric, 2
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
StatusReasonCode
Format options: CardExpired CardReplaced CIPException CloseCardForDispute Closed ClosedByPM Deceased Excess-Chargeback InsufficientKYC InvalidArrowEyefiles NegativeWriteOff POBox PrePurge PurgedCard PurgedFailedAtProcessor ReadyToPrint Arbitration ByPM CIPExceptionSus Confirmed Fraud Dispute Lost Lost-Stolen Other Poss Fraud Poss Fraud Warm Address Poss Fraud Warm Source IP PrimaryCardSuspension ProcSuspectedFraudWithNotes ReDisputed ReplaceFailure ReplacementCardRequired Represented Stolen StoreError SuspectedFraud TransactionCompletenessException UnactivatedCard UnactivatedReplacementCard Violation
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
StatusReasonDesc
Format options: Card Expired Card Replaced CIP Exception Close Card Submited for Dispute Closed Closed By PM Deceased Excess-Chargeback Insufficient KYC Invalid Arrow Eye files Negative Write-off POBox Pre Purge Purged Purged Failed At Processor Ready To Print Arbitration By PM CIP Exception Confirmed Fraud Dispute Lost Lost - Stolen Other Poss Fraud Poss Fraud Warm Address Poss Fraud Warm Source IP Primary Card Suspension Processor Suspected Fraud With Notes Re-disputed Replace Failure Replacement Card Required Represented Stolen Store error Suspected Fraud Suspected Fraud Transaction Completeness Exception Unactivated Card Unactivated Replacement Card Violation
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
UnactivatedReplacementCardExist
Format: Y/N Description: Return yes if current card has at least one related card in status SPND/Unactivated Replacement Card
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
Zip
Format: Numeric, 5
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ACHCalcEffectiveDate
Format: YYYY-MM-DD
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ACHPendingLoads
Format: Numeric, 10
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ACHPendingUnloads
Format: Numeric, 10
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
CardNumber
Format: Numeric, 16
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
CardType
Format: Primary/Secondary(field called CardType in APIs)
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
ContextTransactionType
Format: List of values: Credit, Debit
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
EarlyAccess
Format: Y/N
Not returned
Returned
Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)
HoldExpirationDate
Format: MM-DD-YYYY Description: The date the holds expired
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
MCC
Format: Alphanumeric, 4
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
MCCDescription
(Alphanumeric, 1-200. can contains as well all special characters beside: <, >)
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
TermCity
Format: Alphanumeric, 25
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
TermOwner
Format: Alphanumeric, 25
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
TransactionAmount
Format: Numeric, 11
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
TransactionCode
Format: Alphanumeric, 6
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
TransactionPraxellDate
Format: YYYY-MM-DD
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
TransactionPraxellDescription
Format: Alphanumeric, 100
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
TransactionPraxellDisplayDescription
Alphanumeric, 200
Not returned
Returned
Returned in ~ LastTransactions/Transaction XML tag
AllowSavingAccount
Format: Y/N
Not returned
Returned
AccountCurrentCardStatus
Format options: "ACT" (Active) "CC" (Close) "CII" (Card In Inventory) "LOCK_CII" (Locked Card In Inventory) "LOCK" (Locked) "LST" (Lost) "SPLT" (Spoilt) "SPND" (Suspended) "STLN" (Stolen) Description: All application cards statuses (as ACT, SPND, etc)
Not returned
Returned
Returned in list of Accounts
AccountCurrentCardStatusReasonCode
Format options: CardExpired CardReplaced CIPException CloseCardForDispute Closed ClosedByPM Deceased Excess-Chargeback InsufficientKYC InvalidArrowEyefiles NegativeWriteOff POBox PrePurge PurgedCard PurgedFailedAtProcessor ReadyToPrint Arbitration ByPM CIPExceptionSus Confirmed Fraud Dispute Lost Lost-Stolen Other Poss Fraud Poss Fraud Warm Address Poss Fraud Warm Source IP PrimaryCardSuspension ProcSuspectedFraudWithNotes ReDisputed ReplaceFailure ReplacementCardRequired Represented Stolen StoreError SuspectedFraud TransactionCompletenessException UnactivatedCard UnactivatedReplacementCard Violation
Not returned
Returned
Returned in list of Accounts
AccountCurrentCardProgramType
Format:Inventory or Fullfilemnt
Not returned
Returned
Returned in list of Accounts
AccountCurrentCardSavingBalance
Format: Numeric, 11
Not returned
Returned
Returned in list of Accounts
XML Samples
Input XML
Last updated