# Introduction
## Introduction
The beginning of an awesome article...HTTP Message details When sending a message using POST, build a URL using the Praxell production domain name, which is api.praxell.com and the standard SSL port 443. (e.g. ). Example of request message content: POST / URL HTTP/1.1 \r\n Content-Type: application/x-www-form-urlencoded \r\n Content-Length: LENGTH \r\n Host: api.praxell.com \r\n \r\n data=\ \r\n IP Restriction Systems communicating with Praxell API interfaces must be explicitly allowed on Praxell’ infrastructure. Customers must provide Praxell with its originating IP addressess for API calls.
## XML Content
Praxell APIs are XML messages sent to the server, received by the client, and must adhere to the XML rules. Specifically, all free text fields which send special characters must be encoded properly (e.g. < should be <). Failing to encode the parameters will not pass the initial message parsing and will return an invalid message error response. If "not" required field was not sent (no XML tag) - the field's value will be empty in the database (it will have the same behavior as if the field has been sent with empty value).
## Currencies and Formats
Currently, Praxell supports only the USD currency. The amounts used in the APIs are numbers without decimal points. For example, 99 is 99¢ and 212 is $2.12.
## Common Request Message Structure
All messages are composed of a common part, which is made of the several consistent parameters; this part is made of several logical sub elements. The actual parameters used in this common structure documented below, the relevant sub elements are: • Common (Used in all Request APIs)
#### Authentication details (with an OR relation between them)
* User name based authentication parameters
* Card based authentication details
* Terminal based authentication details
#### ClientSourceIP (Used in all Request APIs)
* Optional field providing Source IP
* Format: XXX.XXX.XXX.XXX (ivp4) (ivp6 values are not supported)
## Non repudiation and duplication
In order to avoid executing multiple requests, which are identical, the API server requests a unique request identifier for each API call.
The uniqueness of a request is checked only after a successful authentication login has been performed, which implies that the user and customer already authenticated and recognized by the system.
This unique identifier managed on the level of the requester
* Customer A can send request ID 111, as can Customer B
* Customer A cannot send request ID 111 more than once
## SQL injection prevention & special characters
In order to prevent SQL injection attacks, all free text fields (e.g. description) are verified using several positive and negative validation components and are limited in the characters they can contain. Specifically, these fields cannot contain the “single quote character” (‘); however “"e;” can be sent, will be stored, and returned upon retrieval a “tab” will be taken as a “null” value and will be ignored.
# ErrorCodes
This is the list of potential error codes returned by the API.
| 40000 | Processor error |
| ----- | -------------------------------------------------------------------------------------------------- |
| 40011 | Invalid Card Number |
| 45004 | Error processing request message |
| 45006 | From Card Status Change Failure |
| 70000 | Processor error |
| 70004 | InvalidPassword |
| 70008 | InvalidIssuer |
| 70009 | Invalid Issuer Active Status |
| 70012 | ServiceNotAllowed |
| 70016 | InvalidCardholder |
| 70019 | CH Already Registered |
| 70021 | Invalid Card Id |
| 70022 | INVALID CARD ACTIVE STATUS |
| 70025 | Invalid Status |
| 70028 | SDO can not be decreased/ Cannot set SDO for an unlimited LAM value |
| 70029 | Data not found (cardholder not found) |
| 70032 |
InvalidParameters
|
| 70033 | TooManyData |
| 70037 | InvalidValidationParameter |
| 70038 | LimitViolation |
| 70043 | DuplicateDefinition |
| 70044 | Could not get inventory data |
| 70046 | AllocationImpossible |
| 70047 | Invalid RPID location |
| 70051 | Relationship Not Found |
| 70052 | InvalidDataDefinition (store by term not find, PT not find) |
| 70055 | Operation Not Supported |
| 70056 | Product Type Not Allowed |
| 70057 | Card Holder Not Verified |
| 70061 | LAM Limits Violation |
| 70062 | Exceeds Daily Load Limit |
| 70063 | Exceeds LAB Limit |
| 70064 | Invalid Product Type |
| 70065 | ProgramConstraintViolation |
| 70068 | LAM is not defined for the entity |
| 70069 | terminal already exists |
| 70071 | SourceAndTargetCardsIdentical |
| 70072 | Card is not Activated |
| 70075 | InvalidCardState |
| 70076 | DocumentTypeNotAllowed |
| 70077 | MaxPTVerifiedLoadAmountReached |
| 70078 | FailedOFACCheck |
| 70079 | MaxPTUnverifiedLoadAmountReached |
| 70080 | CHNotVerifiedDueToPT |
| 70081 | CHNotVerifiedDueToParameter |
| 70082 | InvalidLaOwnerOrgValue |
| 70083 | LaOwnerOfActiveStoresInHierarchy |
| 70084 | RequiredActiveLaOwnerOrgForActiveStores |
| 70085 | BankDetailsRequired |
| 70090 | REPLACEMENT\_CARD\_FAILURE\_DUE\_TO\_GET\_CARD\_BALANCE\_FAILURE |
| 70091 | REPLACEMENT\_CARD\_FAILURE\_DUE\_TO\_SUSPEND\_CARD\_FAILURE |
| 70092 | REPLACEMENT\_CARD\_FAILURE\_DUE\_TO\_CARD\_TO\_CARD\_TRANSFER\_FAILURE |
| 70093 | Replacement Card Failure Due To close Initial Card Failure |
| 70094 | REPLACEMENT\_CARD\_FAILURE\_DUE\_TO\_DDA\_SWAP\_FAILURE |
| 70095 | REPLACEMENT\_CARD\_FAILURE\_DUE\_TO\_INVALID\_AMOUNT\_IN\_INITIAL\_CARD |
| 70111 | Federal Benefit Enrollment Already Exists |
| 70112 | Invalid Cardholder Status |
| 70113 | Invalid Card Number |
| 70115 | Replacement Card Failure Due To InformLostStolen Initial Card Failure |
| 70116 | Invalid Card Status |
| 70117 | Invalid Suspend Reason |
| 70122 | FBE DDA already exists for CardNumber2 |
| 70144 | CardIsNotInStatusOpen |
| 70148 | Effective Date Already Past |
| 70149 | Invalid Effective Date |
| 70150 | Missing OFAC Field Value |
| 70151 | Invalid Settlement Date |
| 70156 | Holds Parameters Conflict |
| 70159 | Holds Retrieve Failure |
| 70161 | Federal Benefit Enrollment Not Exist |
| 70163 | Amount Must Be Positive |
| 70164 | Fee Definition Already Exist |
| 70165 | Fee Definition Not Exist |
| 70166 | Invalid ID |
| 70169 | Invalid Product Type Attribute |
| 70170 | Praxell Code Already Exists |
| 70177 | Invalid Expiration Period |
| 70181 | Invalid Doc Type |
| 70182 | Card To Card Transfer Failure and Card1 was reloaded |
| 70183 | Card To Card Transfer Failure and Card1 cannot be reloaded |
| 70184 | Load Network Not Defined |
| 70185 | Event Not Allowed |
| 70186 | Card Not Suspended |
| 70187 | Invalid ACH Transaction ID |
| 70188 | New Card Created But Card Issuer ID Definition Failed |
| 70198 | Doc Type is not SSN |
| 70199 | Session Not Exist |
| 70200 | Session Already Closed |
| 70201 | Invalid Organization |
| 70203 | Invalid Org To Org Relation |
| 70204 | Org To Org Relation Already Exist |
| 70205 | User Not Allowed to Create Call Center |
| 70206 | Issuing Unverified Card Failure |
| 70207 | OOW Verification Not Allowed |
| 70210 | Cardholder already verified |
| 70211 | Reference ID Failure |
| 70213 | Maximum Time to Answer Questions Failure |
| 70216 | verification error |
| 70217 | Answers verification error |
| 70219 | Invalid Initial Card Status |
| 70220 | Replace Card Link Is Missing |
| 70221 | Initial Card Already Replaced |
| 70223 | Update Cardholder Failure |
| 70226 | Verify By Card Issuer Not Allowed |
| 70228 | Invalid Previous Card Id |
| 70229 | Invalid RPID Format |
| 70230 | RPID Already Exists |
| 70231 | Invalid DOB |
| 70238 | Device Authentication Request Already Exist |
| 70239 | Device Authentication Limit Reached |
| 70240 | Device Authentication Failure Due to Multiple Authentications |
| 70241 | Device Authentication Failure And Authentication Code Created |
| 70242 | Device Authentication Request Already Exist For This Device |
| 70243 | Device Authentication Data Not Found |
| 70244 | Device Authentication Code Error |
| 70245 | Device Authentication Details Error |
| 70246 | Device Authentication Code Expired |
| 70247 | Device Authentication Code Failure Retries |
| 70248 | Device Authentication Not Found |
| 70250 | Replacement Card Status Failure |
| 70251 | Replacement Card Already Ordered |
| 70252 | Invalid Replacement Card ID |
| 70254 | Invalid Card's Bank For Operation |
| 70255 | Replacement Card Failure Since Initial Card Not Active |
| 70256 | Replacement Card Failure |
| 70269 | Card Status Activation Action Failed |
| 70271 | Bill Payment Provider Not Allowed For Product Type |
| 70273 | Biller Not Found For BPPBillerID |
| 70277 | PT Not Eligible For Bill Payment |
| 70278 | Unload For Bill Payment Failure |
| 70279 | Reload After Bill Payment Failure |
| 70282 | File does not exist |
| 70283 | Session Is Not Escalated |
| 70284 | New PIN Identical to current PIN |
| 70285 | File Already Exist For Org |
| 70287 | New Password Identical to current Password |
| 70289 | Org of User Param Unfit Org Param |
| 70290 | User Does Not Exist |
| 70291 | Invalid AML Exception ID |
| 70292 | Organization Not Allowed For Card |
| 70294 | Account does not exist |
| 70304 | Card Number-ID Parameters Failure |
| 70323 | File Cannot Be Deleted |
| 70327 | Invalid File Content |
| 80000 | General error (no balance back from MV) |
| 80002 | UserMustChangePassword |
| 80003 | Invalid Credentials |
| 80006 | UserBlocked |
| 80007 | OrganizationBlocked |
| 80008 | not found organization |
| 80029 | Data not found (Product Type not Found, BIN not Found, Couldn’t find retail pack by ID/DDA number) |
| 80032 | InvalidParameter (Date or Time format from MW is wrong, Card Number is empty) |
| 80204 | Non Repudiation Violated (use for WU) |
| 80206 | LAST\_INVALID\_CREDENTIALS\_BEFORE\_BLOCKED |
| 80210 | Could not Validate data (params) |
# Authentication
Authentication identifies a specific requestor and its authenticate details. The authentication methods include:
```
Praxell User and Password
CSR User and Password
Cardholder and PIN or DOB or CVV (The three are mutually exclusive)
Session
```
Once authenticated, an API caller may continue to send its authentication details or use a Session ID returned in the response to a successful API call. Standard Login policies are applied, including:
```
Lockout on the third unsuccessful login attempt
A required change of password every 60 days
Strong passwords
Users are blocked on 3 failed login attempts
```
## XML Samples:
### Username based authentication
```
//--- (options: Y (default)/N)
NNNNNAPI
```
### Cardholder PIN based authentication
```
NNNNNNNNNNNNNNNNNNNN
```
### Cardholder CVV based authentication
```
NNNNNNNNNNNNNNNNNNN
```
### Session ID based authentication
```
48104914201219021
```
# APIS
# Administration
# Add ACH Transaction
## Add ACH Transaction
The Add ACH Transaction API allows you to add ACH transaction
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| ACHBatchNumber | N | Format: Numeric, 7 | |
| ACHCompanyData | N | Format: Alphanumeric, 20 | |
| ACHCompanyDescription | N | Format: Alphanumeric, 10 | |
| ACHCompanyID | N | Format: Alphanumeric, 10 | |
| ACHCompanyName | N | Format: Alphanumeric,16 | |
| ACHCreationDate | N | Format: YYMMDD | |
| ACHCreationTime | N |
Format: HH:MM Description: 24 hours format
| |
| ACHFileName | N | Format: Alphanumeric, 100 | |
| ACHFullName | N | Format: Alphanumeric, 22 | |
| ACHIndividualID | N | Format: Alphanumeric, 15 | |
| ACHOriginatorBankRoutingNumberDFI | N | Format: Alphanumeric, 8 | |
| ACHProductTypeCode | N |
Format: S = Single; R = Recurring
| |
| ACHSECCode | N | Format: Alphanumeric, 3 | |
| ACHServiceClassCode | N |
| |
| DDA | N | Format: Numeric, 3-16 | |
| EffectiveDate | N | Format: YYYY-MM-DD | |
| IATCity | N | Format: Alphanumeric, 35 | |
| IATCountry | N | Format: Alphanumeric, 35 | |
| IATDFICountryCode | N | Format: Alphanumeric, 2 | |
| IATDFIID | N | Format: Alphanumeric, 34 | |
| IATIdentificationNumber | N | Format: Alphanumeric, 15 | |
| IATDFIIdentificationNumberQualifier | N |
Format options: 01 = National Clearing System Number 02 = BIC Code 03 = IBAN
| |
| IATForeignCorrespondentBankCountryCode1 | N | Format: Alphanumeric, 3 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankCountryCode2 | N | Format: Alphanumeric, 3 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankCountryCode3 | N | Format: Alphanumeric, 3 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankCountryCode4 | N | Format: Alphanumeric, 3 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankCountryCode5 | N | Format: Alphanumeric, 3 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankIDNumber1 | N | Format: Alphanumeric, 34 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankIDNumber2 | N | Format: Alphanumeric, 34 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankIDNumber3 | N | Format: Alphanumeric, 34 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankIDNumber4 | N | Format: Alphanumeric, 34 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankIDNumber5 | N | Format: Alphanumeric, 34 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankIDNumberQualifier1 | N |
Format options: 01 = National Clearing System Number 02 = BIC Code 03 = IBAN
| Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankIDNumberQualifier2 | N |
Format options: 01 = National Clearing System Number 02 = BIC Code 03 = IBAN
| Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankIDNumberQualifier3 | N |
Format options: 01 = National Clearing System Number 02 = BIC Code 03 = IBAN
| Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankIDNumberQualifier4 | N |
Format options: 01 = National Clearing System Number 02 = BIC Code 03 = IBAN
| Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankIDNumberQualifier5 | N |
Format options: 01 = National Clearing System Number 02 = BIC Code 03 = IBAN
| Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankName1 | N | Format: Alphanumeric, 35 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankName2 | N | Format: Alphanumeric, 35 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankName3 | N | Format: Alphanumeric, 35 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankName4 | N | Format: Alphanumeric, 35 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignCorrespondentBankName5 | N | Format: Alphanumeric, 35 | Returned as part of IATForeignCorrespondentBankrecords tag |
| IATForeignExchangeIndicator | N |
Format options: FV (Fixed to Variable) VF (Variable to Fixed) FF (Fixed to Fixed)
| |
| StartBoxId | Y | Format: Alphanumeric, 20 | |
| StartBundleId | Y | Format: Alphanumeric, 20 | |
| StartCaseId | Y | Format: Alphanumeric, 20 | |
| ToEntityName | Y |
Format: Alphanumeric, 60 Description: name of org/user/store/terminal ORGANIZATION
| |
| ToEntityType | Y |
Format: Alphanumeric, 20 Description:ORGANZATION, STORE, USER or TERMINAL Defines what kind of limit should be updated
| |
## Output Parameters:
## XML Samples
### Input XML
```json
FE_PM_MGR1q2w3e4r;
AllocateInventory1211757445ExtAPIFE PM 0001ORGANIZATIONFE_MER_01ORGANIZATION3806538065
```
```json
AllocateInventory740389082008280140StatusOKNA2008-01-20 08:28:4774038908200828014
```
```json
AllocateInventory0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# CardNo to RPCBB Conversion
## CardNo to RPCBB Conversion
The CardNo to RPCBB Conversion API allows converting a CARD Number into it respective RPID and vice versa.
## Input Parameters:
| Name | Required | Definition | Comments |
| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| CardType | Y | Format: Alphanumeric, 10 | Use "Initial" value |
| ConversionType | Y |
Format: CN To RPCBB RPCBB To CN
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ----------- | ------------------- | ------------ | ------------ | -------- |
| ConvertedID | Format: Numeric, 19 | Not returned | Returned | |
## XML Samples
### Input XML
```json
jp_store_fbiz1q2w3e4r;
129573677CardNoRPCBBConversionExtAPI49140InitialRPCBBToCN
```
```json
CardNoRPCBBConversion187651122008511000StatusOKNA2008-10-22 12:51:03187651122008511001675670030289732
```
```json
CardNoRPCBBConversion0707161220073710570000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Change Password
## Change Password
The Change Password API enables a user to change his personal password. There is no need to transfer the user parameter. The application has the session context to identify it.
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| NewPassword | Y |
Format: 8 -10 chars. Alphanumeric, Including char: \_ ! @ # $ % ^ \* + \~ ? Required to have at least - One Upper (e.g. A, B...) - One Lower (e.g. a, b...) - One number (e.g. 1, 2…) - One special character (e.g. \_ ! @...)
Description: New password value provided by the user.
| |
| OldPassword | Y |
Format: Alphanumeric, 6-10 Description: Current password verification.
| |
## Output Parameters:
## XML Samples
### Input XML
```json
Aaronb_CSQ_QA1q2w3e7uChangePassword132636356538ExtAPI123456567890
```
```json
ChangePassword734916092007421140StatusOKNA2007-11-25 09:42:4873491609200742114
```
```json
ChangePassword0707161220073710570004InvalidPasswordInvalidPassword2021-10-01 12:37:5007071612200737105
```
# Check DB Up Request(Monitoring)
## Check DB Up Request(Monitoring)
The Check DB Up Request API allows to test the DB if it is working and responding.
## Input Parameters:
## Output Parameters:
## XML Samples
### Input XML
```json
;
1212121212121213CheckDBUpRequestExtAPI
```
```json
CheckDBUpRequest00000StatusOK2010-10-12T07:27:28
```
```json
CheckDBUpRequest0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# End Card Session
## End Card Session
The End Card Session API is used to end CSR/IVR/CHP sessions
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| CardSessionID | N | Format: Alphanumeric, 30 | |
| Category | C |
Format options: AddressChange CardExpiredWithFunds CardExpiredWithPendingACH CallNotEnded (\*will not be show in UI) CardNotReceived CardStatusProblem Card-to-CardTransfer CloseAccountRequest DirectDepositEnrollmentProblem DirectDepositLoadProblem Dispute EarlyAccess FeeComplaint FeeQuestion HoldRelease(only) IncorrectNameorGovtIDorDOB, Lost/StolenCard Other ProblemwithCardReceivedNameNotRight ProblemwithCardReceived-Other Replacement Card Order ReportofPossibleFraud ResearchbySupervisororPM StoreComplaint TransactionorBalanceQuestion TroubleActivatingaCard/SettingaPIN Unknown Verification VerificationMaxAttemptsReached WesternUnion
| |
| ContactAddress | N |
Format: Alphanumeric,1-30 Description: Required only if Result= Escalated
| Required only if SessionType =CSR |
| WaiveFee | N |
Format: N (default) /Y Description: Allows to waive the fee taken for call
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| --------------- | ----------------------------------------------------- | ------------ | ------------ | -------- |
| SessionDuration | Format: Numeric, 5 (xxx.x - minutes.seconds, as 12.4) | Not returned | Returned | |
## XML Samples
### Input XML
```json
06538513201054070;
EndCardSession06538513201054070~3Portal:csr1234fdsfsffsdfsdfsdfNResolvedCardNotReceivedNone
```
```json
EndCardSession065385132010540700StatusOKNA2010-07-04 13:59:42065398132010590747
```
```json
EndCardSession0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Force Change Password
## Force Change Password
The Force Change Password API enables an Administrator (of a given organization hierarchy) to force a user to change its password.
## Input Parameters:
| Name | Required | Definition | Comments |
| --------------- | -------- | -------------------------- | -------- |
| CardNumber | Y | Format: Numeric, 16 | |
| ChangedUserName | Y | Format: Alphanumeric, 6-30 | |
## Output Parameters:
## XML Samples
### Input XML
```json
ZZ_QA_Test11q2w3e4r5t;
4935451ForceChangePasswordExtAPIZZ_QA_Test1
```
```json
ForceChangePassword298321072008400330StatusOKNA2008-03-11 07:40:3429832107200840033
```
```json
ForceChangePassword0707161220073710570004InvalidPasswordInvalidPassword2021-10-01 12:37:5007071612200737105
```
# Get Billers List
## Get Billers List
The Get Billers List API allows getting the list of billers.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | N | CardNumber (Default), RPID, ANY (add ANY only to ALL APIs - allow to send RPID/DDA number and the application identify it and change it to card number) | |
| BPPBillerCategoryID | N | Format: Alphanumeric, 6 | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| -------------------- | ----------------------------------------------------------------------------------------------- | ------------ | ------------ | ------------------ |
| BPPBillerDescription |
Format: Alphanumeric, 100 Description: The name of the biller to show to the end user
| Not returned | Returned | Billers/Biller tag |
| BPPBillerID |
Format: Alphanumeric, 100 Description: Value got from Get Billers List API
| Not returned | Returned | Billers/Biller tag |
## XML Samples
### Input XML
```json
abuali_QA1q2w3e4r;
4322342366666GetBillersListExtAPI1897890060769839CardNumber
```
```json
GetBillersList188938152011181110StatusOKNA2011-11-27 15:18:1718893815201118111TIO_12-34AmisragasMobilePhoneAndZipPRX_Biller1Israel Electric CorporationAccountNumber
```
```json
GetBillersList0707161220073710570422Biller Category RequiredBiller Category Required2021-10-01 12:37:5007071612200737105
```
# Get Card Effective Fee
## Get Card Effective Fee
The Get Card Effective Fee API allows getting an effective fee for a specific praxell code.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| Amount | N |
Format: Numeric, 1-9, Description: The amount is in cents.
| |
| DateOfBirth | N |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | N | Format: CardNumber, RPID, DDA, FBEDDA | |
| PraxellCode | Y |
Format: Alphanumeric, 6 Description: validates if exists
| |
| ReturnBalance | N | Format: Y/N (default=Y) | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------- |
| AddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | |
| AddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | |
| Balance | Format: Numeric, 11 | Not returned | Returned | |
| City | Format: Alphanumeric, 20 | Not returned | Returned | |
| DateOfBirth |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| Not returned | Returned | |
| FeeAmount | Format: Numeric, 10 | Not returned | Returned | |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | |
| HierarchyEntityType |
Format options: SUBBIN PROGRAM PT ORG\_PROGRAM ORG\_PT CARD
| Not returned | Returned | |
| IsReceiveSms |
Format options: Enabled (the cardholder has requested to receive an SMS for transactions and therefore he get SMS's) Disabled (the cardholder has requested to not receive an SMS for transactions and therefore he does not get SMS's) Blank (the cardholder has not requested to receive an SMS for transactions and therefore he does not get SMS's) Mail (the cardholder has requested to receive an mail for transactions and therefore he get mails)
Description:Defines if the cardholder gets an SMS/Mail.
| Not returned | Returned | |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | |
| Phone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | |
| State | Format: Alphanumeric, 2 | Not returned | Returned | |
| Zip | Format: Numeric, 5 | Not returned | Returned | |
## XML Samples
### Input XML
```json
76036613201151010;
GetCardEffectiveFee76036613201151010~5Portal:pdpXP05DS1675670040615548CardNumber1947-04-21
```
```json
GetCardEffectiveFeeNA
```
```json
GetCardEffectiveFee0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Get Card Session Details
## Get Card Session Details
The Get Card Session Details API allows getting all the details of a session.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------- | -------- | ------------------------ | -------- |
| CardSessionID | Y | Format: Alphanumeric, 30 | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------- |
| CallCenter | Format: Alphanumeric, 30 | Not returned | Returned | |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | |
| Category |
Format options: AddressChange CallNotEnded (\*will not be show in UI) CardNotReceived CardStatusProblem Card-to-CardTransfer CloseAccountRequest DirectDepositEnrollmentProblem DirectDepositLoadProblem Dispute EarlyAccess FeeComplaint FeeQuestion HoldRelease(only) IncorrectNameorGovtIDorDOB Lost/StolenCard Other ProblemwithCardReceivedNameNotRight ProblemwithCardReceived-Other Replacement Card Order ReportofPossibleFraud ResearchbySupervisororPM StoreComplaint TransactionorBalanceQuestion TroubleActivatingaCard/SettingaPIN Unknown NewCardFulfillmentFailure Verification ReviewUploadedVerificationDocuments VerificationMaxAttemptsReached WesternUnion
| Not returned | Returned | |
| Description | Format: Alphanumeric, 1-30 | Not returned | Returned | |
| Dist | Format: Alphanumeric, 30 | Not returned | Returned | |
| FeeAttempted | Format: Numeric, 10 | Not returned | Returned | |
| FeeCollected | Format: Numeric, 10 | Not returned | Returned | |
| FeeReversed | Format: Numeric, 10 | Not returned | Returned | |
| FeeReversedComment | Format: Alphanumeric, 30 | Not returned | Returned | |
| FeeReversedReasonCategory | Format: Alphanumeric, 30 | Not returned | Returned | |
| FeeWaived | Format: Y/N | Not returned | Returned | |
| InboundCallerID | Format: Numeric, 12 | Not returned | Returned | |
| Phone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | |
| PT | Format: Alphanumeric, 30 | Not returned | Returned | |
| Result |
Format options: Resolved Cancelled Escalated NoVerify CallNotEnded CallEnded ResolvedDelay (internal only and should not be supported by API)
| Not returned | Returned | |
| ServiceName |
Format: A closed list of service names. Description: Name of service being executed.
| Not returned | Returned | |
| SessionDuration | Format: Numeric, 5 (xxx.x - minutes.seconds, as 12.4) | Not returned | Returned | |
| SessionEndDate | Format: YYYY-MM-DD | Not returned | Returned | |
| SessionEndTime | Format: HH:MM | Not returned | Returned | |
| SessionStartDate | Format: YYYY-MM-DD | Not returned | Returned | |
| SessionStartTime | Format: HH:MM | Not returned | Returned | |
| SessionType |
Format: CSR IVR CHP
| Not returned | Returned | |
| Store | Format: Alphanumeric, 30 | Not returned | Returned | |
| UserName | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | |
## XML Samples
### Input XML
```json
test_csrtest_csrGetCardSessionDetails1212121212121213Portal:CSR123456789
```
```json
GetCardSessionDetailsStatusNA
```
```json
GetCardSessionDetails0707161220073710570021Invalid Card IdInvalid Card Id2021-10-01 12:37:5007071612200737105
```
# Get Mobile Upgrade
## Get Mobile Upgrade
The Get Mobile Upgrade API allows to get mobile upgrade details for a specific mobile application.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------- | -------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| MobileType | Y |
Format: Alphanumeric, 50 Description: Contains Device Type
| |
| OrgId | Y |
Format: Alphanumeric, 20 Value can be multiple org\_id’s split by commas
| Allow to request relevant Distributor's upgrade information (future: support Reseller |
| Version | Y |
Format: Alphanumeric, 120 Description: New version ID to be install in mobile
| Not returned | Returned | |
| UpgradeDescription |
Format: Alphanumeric, 300 Description: Contains list of features/changes in new version
| Not returned | Returned | Returned in UpgradeDescriptions tag |
| UpgradeLink |
Format: Alphanumeric, 300 Description: Contains the link to the store page containing the upgrade application to be installed
| Not returned | Returned | |
| UpgradeRequired |
Format: Y, N Description: Indicates if the mobile user must do an upgrade or not
| Not returned | Returned | |
## XML Samples
### Input XML
```json
963369551GetMobileUpgradeMobileJPay13.3
```
```json
GetMobileUpgrade380973172011100640StatusOKNA2011-06-05 17:10:403809731720111006413.4YPay Bill, Second New Featurehttp:/mobileshop/shop.com/MobileUpgrade.html
```
```json
GetMobileUpgrade0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Get Product Types
## Get Product Types
The Get Product Types API allows an organization to get the list of permitted product type names to which it has access.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------- | -------- | ------------------- | -------- |
| CardNumber | Y | Format: Numeric, 16 | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------------------------------------------------------- |
| 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 | Returned as part of ProductTypesList/ProductTypeName tag |
## XML Samples
### Input XML
```json
ZZ_QA_Test1_FBZ1q2w3e4r;
1066072GetProductTypesExtAPI
```
```json
GetProductTypes298322072008480350StatusOKNA2008-03-11 07:48:5929832207200848035
```
```json
GetProductTypes0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Login
## Login
The Login API allows login to Praxell applications
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------------------ | -------- | -------------------------------------------------------------------------------------------------------- | -------- |
| AuthenticationCode | C |
Format: Alphanumeric, 10 Description: Required if PortalUserName & Password are provided(PDP)
| Future |
| DeviceAuthenticationCode | C |
Format: Alphanumeric, 10 Description: Required if PortalUserName & Password are provided(PDP)
| Future |
| DeviceBrowserType | C |
Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)
| Future |
| DeviceBrowserVersion | C |
Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)
| Future |
| DeviceColorDepth | C |
Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)
| Future |
| DeviceCookiesEnablement | C |
Format: Y/N Description: Required if PortalUserName & Password are provided(PDP)
| Future |
| DeviceGeolocation | C |
Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)
| Future |
| DeviceOSType | C |
Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)
| Future |
| DeviceOSVersion | C |
Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)
| Future |
| DeviceScreenSize | C |
Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)
| Future |
| DeviceTimeZone | C |
Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)
Format: Alphanumeric, 10 Description: Required if PortalUserName & Password are provided(PDP)
| Not returned | Returned | Future |
| AuthenticationContactDisplayName |
Format: Alphanumeric, 60 Description: Relevant if PortalUserName & Password are provided(PDP)
| Not returned | Returned | Future |
| AuthenticationContactUser |
Format: Alphanumeric, 60 Description: Relevant if PortalUserName & Password are provided(PDP)
| Not returned | Returned | Future |
| AuthenticationRequestStatus |
Format options: Authenticated NotAuthenticatedWarning NotAuthenticated AuthenticationCreated Description: Relevant if PortalUserName & Password are provided(PDP)
| Not returned | Returned | Future |
| BrandStyle | Format: Alphanumeric, 5 | Not returned | Returned | |
| Email |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| Not returned | Returned | Future |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | Future |
| Timeout | Format: Numeric, 3 | Not returned | Returned | |
| UserRoleId | Format: Alphanumeric, 10 | Not returned | Returned | |
| LastLoginTime | Format: YYYY-MM-DD HH:MM:SS | Not returned | Returned | |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | Future |
| OrgAddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | Future |
| OrgAddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | Future |
| OrgCity | Format: Alphanumeric, 20 | Not returned | Returned | Future |
| OrgCountry | Format: Alphanumeric, 3 | Not returned | Returned | Future |
| OrgEmail |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| Not returned | Returned | Future |
| OrgFax | Format: Alphanumeric, 10 | Not returned | Returned | Future |
| OrgId |
Format: Alphanumeric, 20 Value can be multiple org\_id’s split by commas
| Not returned | Returned | Future |
| OrgName | Format: Alphanumeric, 1-30 | Not returned | Returned | Future |
| OrgPhone | Format: Alphanumeric, 10 | Not returned | Returned | Future |
| OrgRoleId | Format: Alphanumeric, 10 | Not returned | Returned | |
| OrgState | Format: Alphanumeric, 2 | Not returned | Returned | Future |
| OrgZip | Format: Alphanumeric, 5 | Not returned | Returned | Future |
## XML Samples
### Input XML
```json
99999999999980001234;
Login1212121212121213ExtAPI
```
```json
Login380124112008570320StatusOKNA2008-03-12 11:57:253801241120085703230CHStore
```
```json
Login0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Manage AML Exception
## Manage AML Exception
The Manage AML Exception API allows to change status of the AML exceptions.
## Input Parameters:
| Name | Required | Definition | Comments |
| -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| ExceptionDescription | N | Format: Alphanumeric, 1-500 | |
| ExceptionID | Y | Format: Alphanumeric, 10 | |
| ExceptionStatus | Y |
Format: options: New (saved as NEW) Approved (saved as APPROVED) CardReporting (saved as REPORT) CardReportingAndClosure (saved as REPORTCC) CardClosure (saved as CC) InProgress (saved as INPROGRESS)
| |
| OperationType | N | Format: Update | |
## Output Parameters:
## XML Samples
### Input XML
```json
;
ManageAMLExceptionExtAPI
```
```json
ManageAMLException446275172010000650StatusOKNA2010-06-01 17:00:5244627517201000065
```
```json
ManageAMLException0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Manage Card Session
## Manage Card Session
The Manage Card Session API is used to manage card sessions.
## Input Parameters:
| Name | Required | Definition | Comments |
| -------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Brand | Y |
Format: Alpha, 3 to 8, lower case letters
| relevant for Operation Types StartCardSessionWithoutCard,StartCardSessionWithoutCardAndClosePreviousSession |
| BrandPhoneNumber | Y | Format: Numeric, 1-15 | relevant for OperationType= StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession |
| CardSessionID | Y | Format: Alphanumeric, 30 | relevant for OperationType= StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, UpdateCardSessionTransferred, GetCardSessionDetails, EndCardSession. This fields is used when there the application cannot use an ID which is not “living” anymore: EndCardSession – for older session (done by CSRPM, for unclosed previous session), StartEscalationSession – for previous escalation, StartSessionWithoutCardAndClosePreviousSession – for previous session, GetCardSessionDetails – for previous session to get details on session (in CSR)) |
| CallTransferred | Y | Format: Y/N (default) | relevant for OperationType= UpdateCardSessionTransferred & CardSessionType=IVR |
| CardSessionType | Y | Format: IVR, CSR, PDP | relevant for all Operation Types |
| Category | C |
Format options: AddressChange CardExpiredWithFunds CardExpiredWithPendingACH CallNotEnded (\*will not be show in UI) CardNotReceived CardStatusProblem Card-to-CardTransfer CloseAccountRequest DirectDepositEnrollmentProblem DirectDepositLoadProblem Dispute EarlyAccess FeeComplaint FeeQuestion HoldRelease(only) IncorrectNameorGovtIDorDOB, Lost/StolenCard Other ProblemwithCardReceivedNameNotRight ProblemwithCardReceived-Other Replacement Card Order ReportofPossibleFraud ResearchbySupervisororPM StoreComplaint TransactionorBalanceQuestion TroubleActivatingaCard/SettingaPIN Unknown Verification VerificationMaxAttemptsReached WesternUnion
| relevant for OperationType= StartCardSessionWithoutCardAndClosePreviousSession, EndCardSession & CardSessionType=CSR |
| CHPhoneNumber | Y | Format: Numeric, 1-15 | relevant for OperationType= StartCardSessionWithoutCard,StartCardSessionWithoutCardAndClosePreviousSession |
| ContactAddress | N |
Format: Alphanumeric,1-30 Description: Required only if Result= Escalated
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| ContactMail | N |
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| ContactName | N |
Format: Alphanumeric, 1-40 Description: Required only if Result = Escalated
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| ContactPhone | N |
Format: Numeric, 1-15 Description: Required only if Result= Escalated
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| Description | Y |
Format: 1-500, Chars: a-zA-Z0-9 .,#$()/:?-%+\*
| &;@!\~=\_' |
| ID | Y |
Format: Numeric, 1-19 require ID based on ID Type value
| relevant for OperationType= UpdateCardInCardSession |
| IDType | C |
Format Options: CardNumber, RPID,DDA, ANY Required if ID provided
| relevant for OperationType= UpdateCardInCardSession |
| IVRCallGUID | Y | Format: numeric 1-20 | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRDuration | Y | Format: numeric, 1-5 | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVREndTime | Y | Format: mm/dd/yyyy hh:mm:ss | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRLanguage | Y | Format Options: english/spanish | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRPageHistory | Y | Format: numeric including “/” 1-4000 | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRSiteNumber | Y | Format: numeric 1-20 | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRStartTime | Y | Format: mm/dd/yyyy hh:mm:ss | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRTerminationStatus | Y |
Format Options: CallerHungUp/ProviderHungUp/CSRTransfer(Office)/CSRTransfer
| relevant for OperationType= EndCardSession & CardSessionType=IVR |
| OperationType | Y |
Format options: EndCardSession GetCardSessionDetails StartCardSessionForPreview UpdateCardInCardSession UpdateCardSessionTransferred (for IVR only) StartCardSessionWithoutCard StartCardSessionWithoutCardAndClosePreviousSession StartEscalationCardSession (for CSR only) StartCardSessionWithCard CreateEscalationCardSession (for Processes - to e used by DNE feature - future)
| |
| Result | Y |
Format options: Resolved Cancelled Escalated NoVerify CallNotEnded CallEnded ResolvedDelay (internal only and should not be supported by API)
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| VerificationType | C |
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| WaiveFee | Y |
Format: N (default) /Y Description: Allows to waive the fee taken for call
| relevant for OperationType= EndCardSession & CardSessionType=IVR |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ActivationDate | Format: YYYY-MM-DD | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ActiveHoldsNumber |
Format: Numeric, 11 Description:Number of active holds existing for Cardholder
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionDuration | Format: Numeric, 5 (xxx.x - minutes.seconds, as 12.4) | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, EndCardSession |
| UnclosedCardSessionID | Format: Numeric, 19 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| UnclosedCardSessionStartDate | Format: YYYY-MM-DD | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| UnclosedCardSessionStartTime | Format: HH:MM:SS | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ActiveFBECard | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ActiveHoldsTotalAmount |
Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, StartCardSessionForPreview |
| ActualExpirationDate |
Format: Alphanumeric, 12, Month YYYY Description: example, April 2013
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| AddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| AddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Brand | Format: Alpha, 1-120 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardAssociation |
Format options: Visa MasterCard Star
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardAvailableBalance | Format: Numeric, 11 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, StartCardSessionForPreview |
| CardDDA | Format: Numeric, 3-16 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, StartCardSessionForPreview |
| CardFBEDDA | Format: Numeric, 16 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardHolderState |
Format options: V V-PNS RNV NRNV
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, StartCardSessionForPreview |
| CardholderUserName | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardIssuingBank | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardIssuingBankCode | Format: Alphanumeric, 5 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardIssuingBankRoutingNumber | Format: Alphanumeric, 9 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, GetCardSessionDetails, StartCardSessionForPreview |
| CardSessionID | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| 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 | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| Category |
Format options: AddressChange CallNotEnded (\*will not be show in UI) CardNotReceived CardStatusProblem Card-to-CardTransfer CloseAccountRequest DirectDepositEnrollmentProblem DirectDepositLoadProblem Dispute EarlyAccess FeeComplaint FeeQuestion HoldRelease(only) IncorrectNameorGovtIDorDOB Lost/StolenCard Other ProblemwithCardReceivedNameNotRight ProblemwithCardReceived-Other Replacement Card Order ReportofPossibleFraud ResearchbySupervisororPM StoreComplaint TransactionorBalanceQuestion TroubleActivatingaCard/SettingaPIN Unknown NewCardFulfillmentFailure Verification ReviewUploadedVerificationDocuments VerificationMaxAttemptsReached WesternUnion
| Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| C-B-B | Format: Alphanumeric, “5-2-2” | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| City | Format: Alphanumeric, 20 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Country |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| DateOfBirth |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard,StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard |
| Description | Format: Alphanumeric, 1-30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| Dist | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| DocExpirationDate |
Format: YYYY-MM-DD Description: must be after DocIssueDate.Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| DocId |
Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| DocIssueDate |
Format: YYYY-MM-DD Description: must be before DocExpirationDateConditional value required only when DocType is 'PASS' or 'MCN'
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| DocIssuer |
Format: Alphanumeric, 2 Description: Country/State code. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| DocState | Format: Alphanumeric, 2 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| 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 | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| EarlyAccess | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Email |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IsFeeLess |
Format: String, Y or N Description: Simple yes\no value indicator
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ExpirationDate | Format: MMYY | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Fax |
Format: Numeric, 6-10 Description: the fax number.
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| FBEEnrollments | Format: Numeric, 2. Number of active FBE Enrollments in statuses Submitted (G), Confirmed (C), Updated (U) and (Enrolled (E) | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| FeeAmount | Format: Numeric, 10 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| FeeAttempted | Format: Numeric, 10 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| FeeCollected | Format: Numeric, 10 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| FeeReversed | Format: Numeric, 10 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| FeeReversedComment | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| FeeReversedReasonCategory | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| FeeWaived | Format: Y/N | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| FileCategory |
Format Options: Primary Secondary Other
Description: Primary files are the following file content types: Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license
| Not returned | Returned | part of Tag Files/File. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| FileContent |
Format options: The FileContent can be any value (allowed per Product Type). For example, It can be one of the following values (or other content types as well for each customer, based on his requirements): Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license, Pay Stub, School/Work ID, Tax Payer ID, Utility Bill, Third Party
The supported characters are: a-z A-Z 0-9 \_- / . ' ( ) It is limited to 100 characters
| Not returned | Returned | part of Tag Files/File. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| FileName | Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! \~ = \_ ' | Not returned | Returned | part of Tag Files/File. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| InboundCallerID | Format: Numeric, 12 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| InvalidPINAttempts | Format: Numeric, 2 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IsPinSet | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IsRegistered | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IsRetailCard |
Format: Y/N Description: Indicates whether the card is part of a retail pack and is it a retail card
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IssueDate | Format: YYYY-MM-DD HH:MM:SS.M | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IssuerEmail |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IssuerName | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IssuerPhone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IsVerified | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| LastActivityDate | Format: YYYY-MM-DD | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| MaxDeclinedTxnsReached | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| MaxPinRetriesReached | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| MiddleInitial |
Format: Alpha,1 Description: Middle name char of the cardholder.
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| MobilePhone |
Format: Numeric, 6-15 Description: Mobile phone for getting SMS (see IsReceiveSms).
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| OrgName | Format: Alphanumeric, 1-30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| Phone | Format: Numeric, 6-15Description: Phone number | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| Phone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ProductType | Format: Alphanumeric, 120 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ProgramType | Format: Saving/Commercial/GPR | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| PT | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| PTAllowDifferentShippingAddress | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| PTExpirationDate | Format: MMYY | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| RCIssueWithoutVerification | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard. Return the IssueWithoutVerification value of the RC PT of the current Card’ PT (if value is Null, return N) |
| ReplacementMessageType |
Format options: The FileContent can be any value (allowed per Product Type). For example, It can be one of the following values (or other content types as well for each customer, based on his requirements): Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license, Pay Stub, School/Work ID, Tax Payer ID, Utility Bill, Third Party
The supported characters are: a-z A-Z 0-9 \_- / . ' ( ) It is limited to 100 characters
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ReplacementStatus |
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Result |
Format options: Resolved Cancelled Escalated NoVerify CallNotEnded CallEnded ResolvedDelay (internal only and should not be supported by API)
| Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| RPID | Format: Numeric, 1-19 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| SendSMS |
Format options: Enable Disable Unspecified Mail
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ServiceName |
Format: A closed list of service names. Description: Name of service being executed.
| Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SessionAgent | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | part of SessionHistory/Session Tag. Return two last CSR sessions done for CH. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionCallCenter | Format: Alphanumeric, 60 | Not returned | Returned | part of SessionHistory/Session Tag. Return two last CSR sessions done for CH. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionCategory |
Format options: AddressChange CallNotEnded (\*will not be show in UI) CardNotReceived CardStatusProblem Card-to-CardTransfer CloseAccountRequest DirectDepositEnrollmentProblem DirectDepositLoadProblem Dispute EarlyAccess FeeComplaint FeeQuestion HoldRelease(only) IncorrectNameorGovtIDorDOB, Lost/StolenCard Other ProblemwithCardReceivedNameNotRight ProblemwithCardReceived-Other Replacement Card Order ReportofPossibleFraud ResearchbySupervisororPM StoreComplaint TransactionorBalanceQuestion TroubleActivatingaCard/SettingaPIN Unknown NewCardFulfillmentFailure Verification ReviewUploadedVerificationDocuments VerificationMaxAttemptsReached WesternUnionType the text for 'Category(Start Card Session)'
| Not returned | Returned | part of SessionHistory/Session Tag.Return two last CSR sessions done for CH. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionDate | format: mm/dd/yy | Not returned | Returned | part SessionHistory/Session Tag.Return two last CSR sessions done for CH. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionDuration | Format: Numeric, 5 (xxx.x - minutes.seconds, as 12.4) | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SessionDuration | Format: Numeric, 5 (xxx.x - minutes.seconds, as 12.4) | Not returned | Returned | part SessionHistory/Session Tag.Return two last CSR sessions done for CH. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionEndDate | Format: YYYY-MM-DD | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SessionEndTime | Format: HH:MM | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SessionResult |
Format options: Resolved Cancelled Escalated NoVerify CallNotEnded CallEnded ResolvedDelay (internal only and should not be supported by API)
| Not returned | Returned | part of SessionHistory/Session Tag.Return two last CSR sessions done for CH. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionStartDate | Format: YYYY-MM-DD | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SessionStartTime | Format: HH:MM | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SessionTime | Format: hh:mm | Not returned | Returned | part of SessionHistory/Session Tag.Return two last CSR sessions done for CH. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionType |
Format: CSR IVR CHP
| Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| ShippingAddressLine1 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ShippingAddressLine2 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ShippingCity |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ShippingState | Format: Alphanumeric, 2 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ShippingZIP | Format: Numeric, 5 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| State | Format: Alphanumeric, 2 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| StatusReasonCode |
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| 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 | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Store | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SubBin | Format: Numeric, 3 (of current card) | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| TCFileName | Format: Alphanumeric, 120, including characters "/" , ":" , "." , "" | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| UpgradeBalance1 | Format: Numeric, 11 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| UpgradeBalance2 | Format: Numeric, 11 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| UserName | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| VerificationAttempts | Format: Numeric, 2 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| VerificationId | Format: Alphanumeric, 50 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| VerificationStatus |
Format options: VerifiedSSN VerifiedThirdParty VerifiedDocumentary VerifiedByIssuer SSNVerificationRequired DocumentaryVerificationRequired OOWVerificationRequired Blank
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Zip | Format: Numeric, 5 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
## XML Samples
### Input XML
```json
OperationType=StartCardSessionWithoutCard
testcsrtest_csrManageCardSession1212121212121213Portal:CSRCSRStartCardSessionWithoutCard123456789987654321usf
OperationType=StartCardSessionWithoutCardAndClosePreviousSession
testcsrtest_csrManageCardSession1212121212121213Portal:CSRCSRStartCardSessionWithoutCardAndClosePreviousSession123456789987654321usfUnknownDispute testb8987f87-7aac-4618-a813-8d8fc927d8b8
OperationType=StartEscalationCardSession
test_csrpmtest_csrpmManageCardSession1212121212121213Portal:CSRCSRStartEscalationCardSession0999999999998354
"OperationType=UpdateCardInCardSession"
12345678901234560ManageCardSession1212121212121213Portal:CSRCSRUpdateCardInCardSession9999999999998353RPID
"OperationType=UpdateCardSessionTransferred"
ivr_pmivr_pmManageCardSession1212121212121213Portal:CSRYIVRUpdateCardSessionTransferred123456789
"OperationType=StartCardSessionWithCard"
testcsrtest_csrManageCardSession1212121212121213Portal:CSRCSRStartCardSessionWithCard9999999999998352RPID
"OperationType=GetCardSessionDetails"
test_csrtest_csrManageCardSession1212121212121213Portal:CSRCSRGetCardSessionDetails123456789
"OperationType=EndCardSession"
12345678901234569ManageCardSession1212121212121213Portal:csrEndCardSessionCSR987654329Description of Card Session.YEscalatedDisputePhone-Name-Address
```
```json
OperationType=EndCardSession
ManageCardSession623456789012345690StatusOKOK2010-06-22 15:15:40381491152010150644
OperationType=StartCardSessionWithCard / StartEscalationCardSession / StartCardSessionWithoutCardAndClosePreviousSession / StartCardSessionWithoutCard
ManageCardSession0428439b-c290-4444-95d4-46d4456269430StatusOKNA2014-02-06 11:13:195464ee73-8783-4c94-98b8-7ecf18f2d81099999999999983535464ee73-8783-4c94-98b8-7ecf18f2d810000031270 BroadwaySuite 1207progressMasterCard19991234111781298VIssuingBanktest900MB789123456New YorkUSACT1980-01-012011-01-011234567892001-01-01USSSNNqa@praxell.com042021262962322Static0YYY2010-06-21 12:55:28.0Store2333222333dev@praxell.comYDataNN2126296040DevOnly999htmls/progress_t_and_c.html10001NYVerifiedByIssuerApril 2020NN999999999999835300-0-0
OperationType=GetCardSessionDetails
ManageCardSession386600102010190730StatusOKOK2010-07-04 10:19:3438660010201019073CSRjjjY2010-07-0111:512010-07-0111:598.1Call Not EndedCall Not EndedCallCentertest_csrCSRViewCHDetailsByCardCSRCardDetailsValidateRPCSRGetUpgradeBalanceGetCardReportViewListResearchCardViewListCSRCallReportCSRCallDetailsViewListSuspendCardSuspendCardCSRCallReportCSRCallDetails9999999999998074DevOnlyStoreProgMngr200126YUser Errorfee desc
OperationType=UpdateCardSessionTransferred / UpdateCardInCardSession
ManageCardSession0ffaf7a1-67a8-402f-8877-8ff29f1cc1d30StatusOKNA2014-02-05 16:41:380ffaf7a1-67a8-402f-8877-8ff29f1cc1d3
```
```json
ManageCardSession0707161220073710570166Invalid IDInvalid ID2021-10-01 12:37:5007071612200737105
```
# Manage Code Group
## Manage Code Group
The Manage Code Group API allows updating code group values.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------- | -------- | -------------------------- | -------- |
| Description | Y | Format: Alphanumeric, 1-30 | |
| Group | Y | Format: Alphanumeric, 20 | |
| Key | Y | Format: Alphanumeric, 30 | |
| Name | Y | Format: Alphanumeric, 22 | |
| OperationType | Y | Format: Update | |
| Param | Y | Format: Alphanumeric, 100 | |
| ShortDescription | Y | Format: Alphanumeric, 100 | |
## Output Parameters:
## XML Samples
### Input XML
```json
st_managerst_manager;
ManageCodeGroup1212121212121213ExtAPIUpdatetest123test12345test 12345tes
R
```
```json
ManageCodeGroup052006370227060281520StatusOKNA2007-05-27 06:17:5405200637022706028152
```
```json
ManageCodeGroup0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Manage Daily Limit
## Manage Daily Limit
The Manage Daily Limit API updates an organization and its default store, user or terminal daily limits. The API sets the limit value based on the business rules of the limits management.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------ | -------- | ------------------------------------------------------- | -------- |
| EntityAmount | Y | Format: Business rules limitation (for example, min 5$) | |
| EntityName | Y | Format: Alphanumeric, 1-120 | |
| EntityType | Y | Format options:SUBBINPTORG\_PTCARD | |
## Output Parameters:
## XML Samples
### Input XML
```json
Avinadav1q2w3e4r;
4129308ManageDailyLimitExtAPIORGANIZATIONDistrib-SDO100000
```
```json
ManageDailyLimit298403042008120340StatusOKNA2008-03-12 04:12:4129840304200812034
```
```json
ManageDailyLimit0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Manage FBE
## Manage FBE
The Manage FBE (Federal Benefits Enrollement) API allows to Create, Change FBE Status, and Update FBE Status of card holders enrollment.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| BenefitType | Y |
Format options: SI (SSI - Suppl. Security Income) SS (Soc Sec - Social Security) BL (Black Lung) IA (Bureau of Indian Affairs) CR (Civil Service Retirement) CS (Civil Service Survivor) MA (Mil. Active) MC (Mil. Civilian Pay) MP (Mil. Pension/Retire) MS (Mil. Survivor) RR (Railroad Retirement) RU (Railroad Unempl. / Sickness) VC (Veterans Compensation/Pension) VE (Veterans Edu. And Sel. Reserve) VM (Veterans Education MGIB) VL (Veterans Life Insurance) VV (Veterans Vocational Rehabilitation)
| |
| CardNumber | C | Format: Numeric, 16 | Required based on CardParameterType value (CardNumber or RPID). Relevant for ManageFBEOperationType values of: Create, ChangeStatus |
| CardParameterType | Y | | Relevant for ManageFBEOperationType values of: Create |
| CheckFBOFirstName | N | Format: Alphanumeric, 2-20 | Relevant for ManageFBEOperationType values of: Create |
| CheckFBOLastName | N | Format: Alphanumeric, 2-20 | Relevant for ManageFBEOperationType values of: Create |
| CheckFirstName | N | Format: Alphanumeric, 2-20 | Relevant for ManageFBEOperationType values of: Create |
| CheckLastName | N | Format: Alphanumeric, 2-20 | Relevant for ManageFBEOperationType values of: Create |
| EarlyAccess | N | Format: Y/N | Relevant for ManageFBEOperationType values of: Create |
| FBEID | C | Format: FBEDetailRecordId - for internal uses | May be required based on FBEParametersType param. Relevant for ManageFBEOperationType values of: ChangeStatus, Update |
| FBEStatus | N |
Format options: Closed list of values (1 char): Submitted (G) Confirmed (C) Error (X) Updated (U) Returned (R) (Enrolled (E) - Initial Status)
| Relevant for ManageFBEOperationType values of: ChangeStatus |
| FBESubmittedFirstName | Y | Format: Alphanumeric, 1-7 | Relevant for ManageFBEOperationType values of: Create |
| FBESubmittedLastName | Y | Format: Alphanumeric, 1-15 | Relevant for ManageFBEOperationType values of: Create |
| ManageFBEOperationType | Y |
Format options: Create ChangeStatus Update
| Relevant for ManageFBEOperationType values of: Create, ChangeStatus, Update |
| ManageFBEParameterType | Y |
Format options: FBEID (required FBEID Parameter) CardNumberSSNBenefit (required Card Number, SSN and BenefitType parameters)
| Relevant for ManageFBEOperationType values of: ChangeStatus, Update |
| NewBenefitType | Y |
Format options: SI (SSI - Suppl. Security Income) SS (Soc Sec - Social Security) BL (Black Lung) IA (Bureau of Indian Affairs) CR (Civil Service Retirement) CS (Civil Service Survivor) MA (Mil. Active) MC (Mil. Civilian Pay) MP (Mil. Pension/Retire) MS (Mil. Survivor) RR (Railroad Retirement) RU (Railroad Unempl. / Sickness) VC (Veterans Compensation/Pension) VE (Veterans Edu. And Sel. Reserve) VM (Veterans Education MGIB) VL (Veterans Life Insurance) VV (Veterans Vocational Rehabilitation)
| |
| NewCheckFBOFirstName | Y | Format: Alphanumeric, 2-20 | Relevant for ManageFBEOperationType values of: Update |
| NewCheckFBOLastName | Y | Format: Alphanumeric, 2-20 | Relevant for ManageFBEOperationType values of: Update |
| NewCheckFirstName | Y | Format: Alphanumeric, 2-20 | Relevant for ManageFBEOperationType values of: Update |
| NewCheckLastName | Y | Format: Alphanumeric, 2-20 | Relevant for ManageFBEOperationType values of: Update |
| NewFBESubmittedFirstName | Y | Format: Alphanumeric, 1-7 | Relevant for ManageFBEOperationType values of: Update |
| NewFBESubmittedLastName | Y | Format: Alphanumeric, 1-15 | Relevant for ManageFBEOperationType values of: Update |
| NewSSN | Y |
Format: Numeric, 9 Description: SSN of Beneficiary
| Relevant for ManageFBEOperationType values of: Update |
| RPID | C | Format: Numeric, 1-19 | Required based on CardParameterType value (CardNumber or RPID), Relevant for ManageFBEOperationType values of: Create |
| SSN | Y |
Format: Numeric, 9 Description: SSN of Beneficiary
| Required in Create request. May be required in Update request & Update FBE Status request based on FBEParametersType param |
## Output Parameters:
## XML Samples
### Input XML
```json
Adx1q2w3e4rNA;
4129308ManageDailyLimitExtAPIYCYNNNNNCNYYYYYYYYYYYYCY
```
```json
ManageDailyLimit123456789012345670StatusOKNA2023-06-26 20:32:4512345678901234567YCYNNNNNCNYYYYYYYYYYYYCY
```
```json
ManageFBE0707161220073710570008InvalidIssuerInvalidIssuer2021-10-01 12:37:5007071612200737105
```
# Manage Fee
## Manage Fee
The Manage Fee API allows adding, updating and deleting fees.
## Input Parameters:
| Name | Required | Definition | Comments |
| -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| Amount | N |
Format: Numeric, 1-9 Description: The amount is in cents.
| Create and Update Request |
| FeeOwner | N |
Format options: Prx (default) Prc
| Create and Update Request |
| HierarchyEntityName1 | Y | Format: Alphanumeric, 1-120 (no validation) | Create, Update, and Delete Request |
| HierarchyEntityName2 | C |
| Create, Update, and Delete Request |
| HierarchyEntityType | Y |
Format options: SUBBIN PROGRAM PT ORG\_PROGRAM ORG\_PT CARD
| Create, Update, and Delete Request |
| OperationType | Y |
Format options: Create Update Delete
| Create, Update, and Delete Request |
| Param1 | N | Format: Alphanumeric, 1-20 (default empty) | Create and Update Request |
| Param2 | N | Format: Alphanumeric, 1-255 (default empty) | Create and Update Request |
| Param3 | N | Format: Alphanumeric, 1-255 (default empty) (future) | Create and Update Request |
| Param4 | N | Format: Alphanumeric, 1-255 (default empty) (future) | Create and Update Request |
| PartialFee | N | Format:Y(default) / N | Create and Update Request |
| PraxellCode | Y |
Format: Alphanumeric, 6 Description: validates if exists
| Create, Update, and Delete Request |
| RetryFee | N | Format:Y(default) / N | Create and Update Request |
| RuleName | N | Format: Alphanumeric, 1-255 (no validation) | Create and Update Request |
| Status | N | Format: ACTIVE (default) ALL | Create and Update Request |
## Output Parameters:
## XML Samples
### Input XML
```json
st_managerst_manager;
ManageFee1212121212121213ExtAPICreateXP66DSSUBBIN9919090001234567shayrubinSimpleFeeRule
```
```json
ManageFee412787152009041230StatusOKNA2009-12-06 15:04:3241278715200904123
```
```json
ManageFee0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Manage File
## Manage File
The Manage File API allows managing files for different entities (as CH, Org, etc). API options are: Add, Delete, View, UpdateFileContent, GetList The GetList option return two lists:
* The cardholder is sometimes required to provide specific files for verification and for non verification purposes. This list, under the "RequiredFiles" tag , design the file content types which can be uploaded for this cardholder.
* The ManageFile/Add API allows to upload file to a cardholder. This list, under the "UploadedFiles" tag, design the uploaded files.
## Input Parameters:
| Name | Required | Definition | Comments | | |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | - |
| Binary\_File | C | Format: Binary | required only for OperationType=Add | | |
| Description | N | Format: 1-500, supported characters: Blank a-z A-Z 0-9 . , # $ ( ) / : ? - % + \* | & ; @ ! \~ = \_ \ ' | relevant only for OperationType=Add | |
| ID | Y | Format: Numeric, 1-19 | | | |
| ID | Y |
Description Input should be OGR\_ID in case IDType = ORG Input should be Order ID in case IDType = Order Input should be Card Number in case IDType = CH-CardNumber Input should be RPID in case IDType = CH-RPID
| | | |
| IDType | N | Format: ORG (Default) - require Org ID in ID field CH-RPID - require RPID in ID field CH-CardNumber - require Card Number in ID field\Order – require Order ID in ID field | | | |
| Name | C | Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! \~ = \_ ' | Required for OperationType=Add, Delete, View, UpdateFileContent | | |
| OperationType | Y |
Format options: Add Delete View UpdateFileContent GetList
|
Description: Add - Allow to add a new file to an organization/cardholder. Delete - Allow to delete a file View - Allow to download a file UpdateFileContent - Allow to change the file content of an existing document GetList - Get list of files for ID (sorted first by group and then by category, in ascending alphabetic order)
| | |
| Content | C | |
Format options: The FileContent can be any value (allowed per Product Type). For example, It can be one of the following values (or other content types as well for each customer, based on his requirements): Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license, Pay Stub, School/Work ID, Tax Payer ID, Utility Bill, Third Party
The supported characters are: a-z A-Z 0-9 \_- / . ' ( ) It is limited to 100 characters
| | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | ------------ | ------------------------------------------------------------------------------------------------ |
| Binary\_File | Format: Binary | Not returned | Returned | relevant only for OperationType=View |
| Category |
Format Options: Primary Secondary Other
Description: Primary files are the following file content types: Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license
Secondary files are the following file content types: Pay Stub, School/Work ID, Tax Payer ID, Utility Bill,
Other files refer to all other file content types (as Third Party)
| Not returned | Returned | relevant only for OperationType=GetList. part of tag UploadedFiles and part of tag RequiredFiles |
| CHState |
Format options: NRNV RNV V-PNS V
| Not returned | Returned | relevant only for OperationType=GetList |
| Content |
Format options: The FileContent can be any value (allowed per Product Type). For example, It can be one of the following values (or other content types as well for each customer, based on his requirements): Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license, Pay Stub, School/Work ID, Tax Payer ID, Utility Bill, Third Party
The supported characters are: a-z A-Z 0-9 \_- / . ' ( ) It is limited to 100 characters
| Not returned | Returned | relevant only for OperationType=GetList. part of tag UploadedFiles and part of tag RequiredFiles |
| Group | Format: 1-100 | Not returned | Returned | relevant only for OperationType=GetList. part of tag UploadedFiles and part of tag RequiredFiles |
| Name | Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! \~ = \_ ' | Not returned | Returned | relevant only for OperationType=GetList. part of tag UploadedFiles |
| Type | Format: any supported type (as txt, jpg, doc, etc) | Not returned | Returned | relevant only for OperationType=GetList. part of tag UploadedFiles |
## XML Samples
### Input XML
```json
st_managerst_manager;
ManageFile7532121212121213praxelldGV4dCB0ZXN0some descriptionsomeOrgIdORGFileName.ExtAdd
```
```json
ManageFile388519112012450150StatusOKNA2012-01-05 11:45:5838851911201245015
```
```json
ManageFile0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Manage Load Account
## Manage Load Account
The Manage Load Account API allows to manage the amount of the LA – allowing to increase, decrease or get balance value.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------- | -------- | ------------------------------------------------------------------- | ---------------------------------------------- |
| Amount | C |
Format: Numeric, 1-9 Description: The amount is in cents.
| Required if Operation Type = Increase/Decrease |
| FundsSource | C | Format: Alphanumeric, 50 | Required if Operation Type = Increase/Decrease |
| OperationType | Y |
Format options: Increase Decrease Get
| |
| OrganizationName | Y | Format: Alphanumeric, 60 | |
| ReferenceNumber | C | Format: Alphanumeric, 32 | Required if Operation Type = Increase/Decrease |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------- |
| LABalance | Format: Numeric, 1-11 | Not returned | Returned | |
| LastUpdateDate |
Format: YYYY-MM-DD HH:MM:SS Description: Required to be returned only if Operation Type = Get. Otherwise, do not return.
| Not returned | Returned | |
| LastUpdateUserName |
Format: Alphanumeric, 6-30 Description: Required to be returned only if Operation Type = Get. Otherwise, do not return.
| Not returned | Returned | |
## XML Samples
### Input XML
```json
;
ManageLoadAccount1212121212121213praxellIncreaseDistrib25710
```
```json
ManageLoadAccount0StatusOKNA2010-06-29 07:20:40167567003027604845052010-10-09 10:23:38.0st_manager
```
```json
ManageLoadAccount0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Manage Order
## Manage Order
The Manage Order API allow to manage orders from creation stage to completion stage
## Input Parameters:
| Name | Required | Definition | Comments |
| --------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ApprovedBy | Y | Format: Alphanumeric, 30 | Relevant for Event values of: APPROVE\_ORDER |
| CardsBoxesInCases | Y | Format: Numeric, 2 | Relevant for Event values of: CREATE\_ORDER |
| CardsBoxesInCasesReceived | Y | Format: Numeric, 2 | Relevant for Event values of: COMPLETE\_ORDER |
| CardsBundlesInBox | Y | Format: Numeric, 2 | Relevant for Event values of: CREATE\_ORDER |
| CardsBundlesInBoxReceived | Y | Format: Numeric, 2 | Relevant for Event values of: COMPLETE\_ORDER |
| CardsNumberInBundle | Y | Format: Numeric, 2 | Relevant for Event values of: CREATE\_ORDER |
| CardsNumberInBundleReceived | Y | Format: Numeric, 2 | Relevant for Event values of: COMPLETE\_ORDER |
| CompletionDescription | N |
| Relevant for all events |
| FromCase | O | Format: Alphanumeric, 20 | Relevant for Event values of: MANUAL\_CREATE\_CARDS |
| FromCaseReceived | Y | Format: Alphanumeric, 20 | Relevant for Event values of: COMPLETE\_ORDER |
| FromRPID | O | Format: Numeric, 1-19 | Relevant for Event values of: MANUAL\_CREATE\_CARDS |
| FromRPIDReceived | Y | Format: Numeric, 1-19 | Relevant for Event values of: COMPLETE\_ORDER |
| Message | N | Format: 1-500, supported characters: Blank a-z A-Z 0-9 . , # $ ( ) / : ? - % + \* | & ; @ ! \~ = \_ \ ' |
| NamePrinted | Y | Format: 2-26, alpha. Can contains as well space | Relevant for Event values of: CREATE\_ORDER, APPROVE\_ORDER |
| OrderArrivalDate | Y | Format: YYYY-MM-DD | Relevant for Event values of: COMPLETE\_ORDER |
| OrderID | Y | Format: Alphanumeric, 20 | Relevant for Event values of: APPROVE\_ORDER, APPROVE\_ORDER, COMPLETE\_ORDER, COMPLETE\_ORDER, CREATE\_CARDS, MANUAL\_CREATE\_CARDS, CANCEL\_ORDER , DECLINE\_ORDER , \~FAILURE |
| OrderShippingDestination | Y | Options: PM/Distributor/DistributorShipping/Reseller by default: None | Relevant for Event values of: CREATE\_ORDER |
| PackageSafetyReceived | Y | Format: Y/N | Relevant for Event values of: COMPLETE\_ORDER |
| PT | Y |
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.
| Relevant for Event values of: CREATE\_ORDER, GET\_ORDER\_INITIAL\_VALUES |
| RequestedCards | Y | Format: numeric, 6 | Relevant for Event values of: CREATE\_ORDER,APPROVE\_ORDER |
| RequestedCardsReceived | Y | Format: numeric, 6 | Relevant for Event values of: COMPLETE\_ORDER |
| ResellerName | N | Format: Alphanumeric, 1-30 | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES, CREATE\_ORDER |
| ShippingAddress1 | Y |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Relevant for Event Event of: CREATE\_ORDER |
| ShippingAddress2 | Y |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Relevant for Event values of: CREATE\_ORDER |
| ShippingCity | Y |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,
| Relevant for Event values of: CREATE\_ORDER |
| ShippingCompany | Y | Format: Alphanumeric, 40 | Relevant for Event values of: CREATE\_ORDER |
| ShippingState | Y | Format: Alphanumeric, 2 | Relevant for Event values of: CREATE\_ORDER |
| ShippingZip | Y | Format: Numeric, 5 | Relevant for Event values of: CREATE\_ORDER |
| ToCase | O | Format: Alphanumeric, 20 | Relevant for Event values of: MANUAL\_CREATE\_CARDS |
| ToCaseReceived | Y | Format: Alphanumeric, 20 | Relevant for Event values of: COMPLETE\_ORDER |
| ToRPID | O | Format: Numeric, 1-19 | Relevant for Event values of: MANUAL\_CREATE\_CARDS |
| ToRPIDReceived | Y | Format: Numeric, 1-19 | Relevant for Event values of: COMPLETE\_ORDER |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ----------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------ | ------------ | --------------------------------------------------------- |
| BIN |
Format: Numeric, 9 Description: includes BIN (6) and SUBBIN (3)
| Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| CardsBoxesInCases | Format: Numeric, 2 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| CardsBundlesInBox | Format: Numeric, 2 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| CardsNumberInBundle | Format: Numeric, 2 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| ExistingInventoryCards | Format: Numeric, 7 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| ExpirationDate | Format: MMYY | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| InvoiceFile | Format: Binary (provided in PDF file format) | Not returned | Returned | Relevant for Event values of: CREATE\_ORDER |
| FFHouseName | Format: Alphanumeric 50 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| IncompletedPreviousOrderIDForPT | Format: Alphanumeric, 30 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| IncompletedPreviousOrderStatusForPT | Format: Alphanumeric, 30 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| NamePrintedOnCard | Format: 2-26, alpha. Can contains as well space | Not returned | Returned | |
| OrderShippingDestination | Options: PM/Distributor/DistributorShipping/Reseller by default: None | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| ShippingAddress1 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| ShippingAddress2 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| ShippingCity |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,
| Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| ShippingCompany | Format: Alphanumeric, 40 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| ShippingState | Format: Alphanumeric, 2 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| ShippingType | Format: Alphanumeric 20 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| ShippingZip | Format: Numeric, 5 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| SUBBIN | Format: Numeric, 3 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
| TotalDistributorPendingOrders | Format: Numeric, 2 | Not returned | Returned | Relevant for Event values of: GET\_ORDER\_INITIAL\_VALUES |
## XML Samples
### Input XML
```json
Create order:
test_sad1test_sadManageOrder1212121212121213ExtApiCREATE_ORDER10Test create orderPMPraxell companyBroadway1200New YorkNY10001Z_Progreso STAR - Low Limit234My Name Cardholder
Approve Order:
st_managerst_managerManageOrder1212121212121213ExtApiAPPROVE_ORDER111Test Update namest_manager231Test approve
Cancel Order:
test_sad1test_sadManageOrder1212121212121213ExtApiCANCEL_ORDER1Test cancel
Complete:
test_sad1test_sadManageOrder1212121212121213ExtApiCOMPLETE_ORDER2Test complete order1012121206872013-12-22222Y
Manual Create Cards:
st_managerst_managerManageOrder1212121212121213ExtApiMANUAL_CREATE_CARDS2Test man create cards order122111214
Get Order Initial Values:
test_sad1test_sadManageOrder1212121212121213ExtApiGET_ORDER_INITIAL_VALUESZ_Progreso STAR - Low Limit
Decline Order:
stmanagerst_managerManageOrder1212121212121213ExtApiDECLINE_ORDER1Test declineTest message
```
```json
Get Order Initial Values:
ManageOrder09ad8525-9148-4943-ab37-f1eba5153d330StatusOKNA2013-12-29 14:00:0209ad8525-9148-4943-ab37-f1eba5153d33DistributorShippingno nameee_ebbbcccAK11111ArrowEyeTest Cardholder24300099190998867999-222
All Others:
ManageOrder09ad8525-9148-4943-ab37-f1eba5153d330StatusOKNA2013-12-29 14:00:0209ad8525-9148-4943-ab37-f1eba5153d33
```
```json
ManageOrder0707161220073710580000General error (no balance back from MV)General error (no balance back from MV)2021-10-01 12:37:5007071612200737105
```
# Manage Org To Orgs Relation
## Manage Org To Orgs Relation
The Manage Org To Orgs Relation API allows to manage relation between organizations
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------- |
| OrganizationSource | Y | Format: Alphanumeric, 1-30 | |
| OrganizationTarget | Y | Format: Alphanumeric, 1-30 | it can be a list of organizations names under tag OrganizationTargets |
| OperationType | Y |
Operation type done in API - closed list of values (per API):
| |
| Approve Card Order API | Approve,Decline | | |
| Instant Issue API | CardNumber, RPID | | |
| Manage Org To Orgs Relation API | Create,Delete | | |
| Manage Store API | Create, Update | | |
| Manage Sub Organization API | Create,Update,View | | |
| Manage Terminal API | Create, Update | | |
| Manage User API | Create, Update | | |
| Research Card API | RPID, Blank (if RPID, RPID is required. If blank, CardNumber is required) | | |
| Manage FBE API | Create, ChangeStatus, Update | | |
| Manage Praxell Code API | View, Create, Update | | |
| Manage Fee API | Create, Update, Delete | | |
| Manage Payee API | Add, GetPayees, Delete, Update | | |
| Approve Card Order API | Approve,Decline | | |
| Instant Issue API | CardNumber, RPID | | |
| Manage Org To Orgs Relation API | Create,Delete | | |
| Manage Store API | Create, Update | | |
| Manage Sub Organization API | Create,Update,View | | |
| Manage Terminal API | Create, Update | | |
| Manage User API | Create, Update | | |
| Research Card API | RPID, Blank (if RPID, RPID is required. If blank, CardNumber is required) | | |
| Manage FBE API | Create, ChangeStatus, Update | | |
| Manage Praxell Code API | View, Create, Update | | |
| Manage Fee API | Create, Update, Delete | | |
| Manage Payee API | Add, GetPayees, Delete, Update | | |
| Approve Card Order API | Approve,Decline | | |
| Instant Issue API | CardNumber, RPID | | |
| Manage Org To Orgs Relation API | Create,Delete | | |
| Manage Store API | Create, Update | | |
| Manage Sub Organization API | Create,Update,View | | |
| Manage Terminal API | Create, Update | | |
| Manage User API | Create, Update | | |
| Research Card API | RPID, Blank (if RPID, RPID is required. If blank, CardNumber is required) | | |
| Manage FBE API | Create, ChangeStatus, Update | | |
| Manage Praxell Code API | View, Create, Update | | |
| Manage Fee API | Create, Update, Delete | | |
| Manage Payee API | Add, GetPayees, Delete, Update | | |
| RelationType | N | Format: CallCenter (default), Bank | |
| Approve Card Order API | Approve,Decline |
| ------------------------------- | ------------------------------------------------------------------------- |
| Instant Issue API | CardNumber, RPID |
| Manage Org To Orgs Relation API | Create,Delete |
| Manage Store API | Create, Update |
| Manage Sub Organization API | Create,Update,View |
| Manage Terminal API | Create, Update |
| Manage User API | Create, Update |
| Research Card API | RPID, Blank (if RPID, RPID is required. If blank, CardNumber is required) |
| Manage FBE API | Create, ChangeStatus, Update |
| Manage Praxell Code API | View, Create, Update |
| Manage Fee API | Create, Update, Delete |
| Manage Payee API | Add, GetPayees, Delete, Update |
## Output Parameters:
## XML Samples
### Input XML
```json
;
ManageOrgToOrgsRelation7532121212121213praxell
```
```json
ManageOrgToOrgsRelation388519112012450150StatusOKNA2012-01-05 11:45:5838851911201245015
```
```json
ManageOrgToOrgsRelation0707161220073710570201Invalid OrganizationInvalid Organization2021-10-01 12:37:5007071612200737105
```
# Manage Praxell Code
## Manage Praxell Code
The Manage Praxell Code API allows to add, update and delete Praxell codes. In addition it allows to get the relevant available SMS and display a template.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| DisplayTemplateID | N | Format: Alphanumeric, 2 (default empty) | Create, Update |
| IsActivity | N | Format: Y/N (default) | Create, Update |
| IsFee | N | Format: Y/N (default) | Create, Update |
| IsGCR | N | Format: Y/N (default) | Create, Update |
| OperationType | N |
Format options: View Create Update
| Create, Update, Delete |
| PraxellCode | Y |
Format: Alphanumeric, Description: validates if exists
| Create, Update, Delete |
| PraxellCodeDescription | Y | Format: Alphanumeric, 80 | Create, Update |
| SMSTemplateID | N | Format: Alphanumeric, 2 (default empty) | Create, Update |
| Type | N |
Format options: Load Unload Other
| Create, Update |
| TransactionType | C |
Format: List of values: Credit, Debit, Auth, Info Description: provide the type of the transaction
Format: Alphanumeric, Description: validates if exists
| Not returned | Returned | Create |
| PraxellCodeDescription | Format: Alphanumeric, 80 | Not returned | Returned | Create |
## XML Samples
### Input XML
```json
PPM_PMA_QA1q2w3e4r;
ManagePraxellCode12121212121212163praxellCreateXP11DFAAANNA5DYOtherInfo
```
```json
```
```json
ManagePraxellCode0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Manage Sub Organization
## Manage Sub Organization
The Manage Sub Organization API allows a given organization to define an additional organizational unit which it manages. It also allows performing update activities on the sub organizations. Note that Update activities are allowed only on the Address and Contact Details (not core organization details, e.g. type)
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------------------------------------- | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| AccountName | N |
Format: Alphanumeric, 1-60 Description: Processor Account Name
| |
| AccountNumber | N | Format: Numeric, 17 | |
| ACHSubmitDelay | N | Format: Numeric, 1-2 | |
| ACHSubmitTime | N |
Format: HH:MM Description: 24 hours format
| |
| AddressLine1 | Y | Format: Alphanumeric, 30 | |
| AddressLine2 | N | Format: Alphanumeric, 30 | |
| AutomaticReconciliation | N | Format: Y/N | |
| BankContactName | N | Format: Alphanumeric, 1-60 | |
| BankContactPhone | N | Format: Numeric, 6-15 | |
| BankName | N | Format: Alphanumeric, 1-60 | |
| BankRouting | N | Format: Numeric,9 | |
| City | Y | Format: Alphanumeric, 20 | |
| ContactEmail | Y |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| |
| ContactFax | N | Format: Numeric, 6-15 | |
| ContactPhone | N |
Format: Numeric, 6-15 Description: Required only if Result= Escalated
| |
| Country | Y |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| |
| DefaultLAOwnerStrategy | N |
Format options: Self Store
| |
| Email | Y |
Format General o An email address is made up of a local part, an @ symbol, then a domain part (XXXXX\@XXXXX) o Full Email Address Maximum Size: 254 chars o Local part & domain consist of labels separated by dots — Each label max size is 64 — Two successive dots are forbidden — mail cannot start or end with a dot — Labels cannot not start with a hyphen, end with a hyphen, or contain two successive hyphens.
Local part o Size: 1-64 chars o Allowed Chars: a-z, A-Z, 0-9, and special characters: - \_ . \~ ! ' \*
Domain part o Size: 1-251 chars o Allowed Chars: a-z, A-Z, 0-9, and special characters: - \_ .
| |
| ExternalOrgId | N | Format: Alphanumeric, 20 | |
| Fax | N |
Format: Numeric, 6-10 Description: the fax number.
| |
| FirstName | N | Format: Alpha, 2-20 | |
| IsLAOwner | Y | Format: Y/N | |
| LAAutoReplenishment | N | Format: Y/N | |
| LAAutoReplenishmentDelay | N | Format: Y/N | |
| LAAutoReplenishmentDelayTimeConsideration | N | Format: Y/N | |
| LAAutoReplenishmentTime | N |
Format: HH:MM Description: 24 hours format
| |
| LAOwnerOrg | N | Format: Alphanumeric, 20 | |
| LastName | N | Format: Alpha, 2-20 | |
| LoadMechanism | N |
Format options: PRAXELL TMLLC
| |
| MiddleInitial | N |
Format: Alpha,1 Description: Middle name char of the cardholder.
| |
| NewBrandStyle | N | Format: Alphanumeric, 5 | |
| NewOrgName | N | Format: Alphanumeric, 6-30 | |
| NewPassword | N |
Format: 8 -15 chars. Alphanumeric, Including char: \_ ! @ # $ % ^ \* + \~ ? Required to have at least - One Upper (e.g. A, B...) - One Lower (e.g. a, b...) - One number (e.g. 1, 2…) - One special character (e.g. \_ ! @...)
Description: New password value provided by the user.
| |
| NewUserName | N | Format: Alphanumeric, 6-30 | |
| OperationType | Y | Operation type done in API - closed list of values (per API): | |
| Approve Card Order API | Approve,Decline | | |
| Instant Issue API | CardNumber, RPID | | |
| Manage Org To Orgs Relation API | Create,Delete | | |
| Manage Store API | Create, Update | | |
| Manage Sub Organization API | Create,Update,View | | |
| Manage Terminal API | Create, Update | | |
| Manage User API | Create, Update | | |
| Research Card API | RPID, Blank (if RPID, RPID is required. If blank, CardNumber is required) | | |
| Manage FBE API | Create, ChangeStatus, Update | | |
| Manage Praxell Code API | View, Create, Update | | |
| Manage Fee API | Create, Update, Delete | | |
| Manage Payee API | Add, GetPayees, Delete, Update | | |
| Approve Card Order API | Approve,Decline | | |
| Instant Issue API | CardNumber, RPID | | |
| Manage Org To Orgs Relation API | Create,Delete | | |
| Manage Store API | Create, Update | | |
| Manage Sub Organization API | Create,Update,View | | |
| Manage Terminal API | Create, Update | | |
| Manage User API | Create, Update | | |
| Research Card API | RPID, Blank (if RPID, RPID is required. If blank, CardNumber is required) | | |
| Manage FBE API | Create, ChangeStatus, Update | | |
| Manage Praxell Code API | View, Create, Update | | |
| Manage Fee API | Create, Update, Delete | | |
| Manage Payee API | Add, GetPayees, Delete, Update | | |
| OrgName | N | Format: Alphanumeric, 6-30 | |
| OrgType | Y |
Format options: Store Reseller Distrib CallCenter
| |
| Phone | Y |
Format: Numeric, 6-15 Description: Phone number
| |
| SettlementMethod | N |
Format options:Praxell Originate Praxell Receive Reserve Description: It is relevant only if LA Owner=Y
| |
| ShouldCreateUser | N | Format: Y/N | |
| State | Y | Format: Alphanumeric, 2 | |
| TargetOrgName | N | Format: Alphanumeric, 6-30 | |
| Zip | N | Format: Numeric, 5-9 | |
| OrderShippingDestination | N |
Options: PM/Distributor/DistributorShipping/Reseller by default: None
| |
| OrderShippingCompany | N | Format: Alphanumeric, 40 | |
| OrderShippingAddress1 | N | Format: Alphanumeric, 30 | |
| OrderShippingAddress2 | N | Format: Alphanumeric, 30 | |
| OrderShippingCity | N | Format: Alphanumeric, 20 | |
| OrderShippingState | N | Format: Alphanumeric, 2 | |
| OrderShippingZip | N | Format: Alphanumeric, 5 | |
| Approve Card Order API | Approve,Decline |
| ------------------------------- | ------------------------------------------------------------------------- |
| Instant Issue API | CardNumber, RPID |
| Manage Org To Orgs Relation API | Create,Delete |
| Manage Store API | Create, Update |
| Manage Sub Organization API | Create,Update,View |
| Manage Terminal API | Create, Update |
| Manage User API | Create, Update |
| Research Card API | RPID, Blank (if RPID, RPID is required. If blank, CardNumber is required) |
| Manage FBE API | Create, ChangeStatus, Update |
| Manage Praxell Code API | View, Create, Update |
| Manage Fee API | Create, Update, Delete |
| Manage Payee API | Add, GetPayees, Delete, Update |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ---------------- | ------------------- | ------------ | ------------ | -------- |
| AvailableBalance | Format: Numeric, 11 | Not returned | Returned | |
## XML Samples
### Input XML
```json
ManageSubOrganization1239076422ExtAPITest123123112:141,streetlane,NYNtest123456United Bank456712312New Yorktest@gmail.com678123897009United StateNretest@yn.inAL123QWAS123897656JohnYNNNNJuice LtdSmithPRAXELLTMLLCBrownJSB123Juice123abc@#$123##adc123Choose from listCallerCallCenter1234567YNYApple Store45001NoneAmazone XYZNy, I23Port-23#qwNYNY12311
```
```json
Manage Sub Organization12345678900StatusOKSuccess2023-06-24 10:00:001234567890Test123123112:141,streetlane,NYNtest123456United Bank456712312New Yorktest@gmail.com678123897009United StateNretest@yn.inAL123QWAS123897656JohnYNNNNJuice LtdSmithPRAXELLTMLLCBrownJSB123Juice123abc@#$123##adc123Choose from listCallerCallCenter1234567YNYApple Store45001NoneAmazone XYZNy, I23Port-23#qwNYNY12311
```
```json
ManageSubOrganization0707161220073710570012ServiceNotAllowedServiceNotAllowed2021-10-01 12:37:5007071612200737105
```
# Manage Terminal
## Manage Terminal
The Manage Terminal API allows a given organization to create or update its own terminal, and its sub-organizations terminals.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------- | -------- | -------------------------------------------------------------------------------------------- | -------- |
| OperationType | Y |
Format options: Create Update
| |
| RoleId | Y |
Format options: Manager Accounting Inventory Full Issuing Reporting
| |
| Status | C | Format: ACTIVE (default) ALL | |
| TargetOrgName | Y | Format: Alphanumeric, 6-30 | |
| TargetStoreId | Y | Format: Alphanumeric, 1-20 | |
| TargetTerminalId | Y | Format: Alphanumeric, 1-10 | |
## Output Parameters:
## XML Samples
### Input XML
```json
test_sadtest_sad;
ManageTerminal1212121212121213ExtAPICreateStoreTERM27
```
```json
ManageTerminal052006370227060281520StatusOKNA2007-07-12 06:55:1399998888777766111
```
```json
ManageTerminal0707161220073710570012ServiceNotAllowedServiceNotAllowed2021-10-01 12:37:5007071612200737105
```
# Manage User
## Manage User
The Manage User API allows a given organization to create or update its users and its sub-organizations users (based on the hierarchy). Users are created by default with limits set to zero, to be later changed by the Limits Management API.
## Input Parameters:
| Name | Required | Definition | Comments |
| --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| Email | C |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| |
| FirstName | C | Format: Alphanumeric, 10 | |
| LastName | C | Format: Alphanumeric, 15 | |
| LimitAmount | C | Format: Business rules limitation (e.g. minimum 5$) | Create Request |
| NewUserPassword | C |
Format: 8 -10 chars. Alphanumeric, Including char: \_ ! @ # $ % ^ \* + \~ ? Required to have at least - One Upper (e.g. A, B...) - One Lower (e.g. a, b...) - One number (e.g. 1, 2…) - One special character (e.g. \_ ! @...)
Description: New password value provided by the user.
| Create Request |
| OperationType | Y |
Format options: Create Update
| |
| RoleId | C |
Format options: Manager Accounting Inventory Full Issuing Reporting
| |
| Status | C | Format: ACTIVE (default) ALL | |
| TargetOrgName | N | Format: Alphanumeric, 6-30 | |
| TargetUserName | C | Format: Alphanumeric, 6-30 | |
## Output Parameters:
## XML Samples
### Input XML
```json
SA_DemoPM1q2w3e4r;
1805654ManageUserExtAPI1q2w3e4rKrautdebitsupport@praxell.comDanFBIZCreatekVZpGXyrXczvfoDGSuTv100
```
```json
ManageUser734061082007561100StatusOKNA2007-11-13 08:56:0273406108200756110
```
```json
ManageUser0707161220073710570012ServiceNotAllowedServiceNotAllowed2021-10-01 12:37:5007071612200737105
```
# Manage White List
## Manage White List
The Manage White List API allows managing the white list for ACH names. In this version, it supports only retrieving names from a white list.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------- | -------- | --------------------- | -------- |
| DDA | Y | Format: Numeric, 3-16 | |
| OperationType | N | Format: View | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ---- | ------------------------ | ------------ | ------------ | ---------------------------------- |
| Name | Format: Alphanumeric, 22 | Not returned | Returned | Returned as part of Names/Name tag |
## XML Samples
### Input XML
```json
test_pmtest_pm;
1212121212121213ManageWhiteListExtAPI1111000235705View
```
```json
managewhitelistStatusNA
```
```json
managewhitelist0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Ping
## Ping
The Ping API allows login to Praxell applications
## Input Parameters:
## Output Parameters:
## XML Samples
### Input XML
```json
;
Ping1212121212121213ExtAPI
```
```json
Ping380124112008570320StatusOKNA2008-03-12 11:57:2538012411200857032
```
```json
Ping0707161220073710570321Ping ErrorPing Error2021-10-01 12:37:5007071612200737105
```
# Reprocess ACH Transaction
## Reprocess ACH Transaction
The Reprocess ACH Transaction API allows resubmitting ACH Transaction to prepare them to run in the next transaction queue run.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------- | -------- | -------------------------- | -------- |
| ACHTransactionID | Y | Format: Alphanumeric, 50 | |
| CheckOFAC | N | Format: Y/N | |
| Description | N | Format: Alphanumeric, 1-30 | |
| ForceOperation | N | Format: N (default) / Y | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------- |
| ID |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| Not returned | Returned | |
## XML Samples
### Input XML
```json
78010710201122064;
ReprocessACHTransaction78010710201122064~10Portal:pdp151155
```
```json
ReprocessACHTransaction780107102011220640StatusOKNA2011-06-13 10:27:23780121102011270621234123184920DDA
```
```json
ReprocessACHTransaction0707161220073710545006From Card Status Change FailureFrom Card Status Change Failure2021-10-01 12:37:5007071612200737105
```
# Reset Password
## Reset Password
The Reset Password API enables an Administrator (of a given organization hierarchy) to reset the password of a user and unlock its lock.
## Input Parameters:
| Name | Required | Definition | Comments |
| --------------- | -------- | -------------------------- | -------- |
| CardNumber | Y | Format: Numeric, 16 | |
| ChangedUserName | Y | Format: Alphanumeric, 6-30 | |
## Output Parameters:
## XML Samples
### Input XML
```json
ZZ_QA_Test11q2w3e4r5t;
3302964ResetPasswordExtAPIZZ_QA_Test1
```
```json
ResetPassword298375102008490310StatusOKNA2008-03-11 10:49:1029837510200849031
```
```json
ResetPassword0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Resolve Card Session
## Resolve Card Session
The Resolve Card Session API allows to resolve and close open sessions (used by CSRPM to manage escalations).
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| CardSessionID | Y | Format: Alphanumeric, 30 | |
| Category | Y |
Format options: AddressChange CardExpiredWithFunds CardExpiredWithPendingACH CallNotEnded (\*will not be show in UI) CardNotReceived CardStatusProblem Card-to-CardTransfer CloseAccountRequest DirectDepositEnrollmentProblem DirectDepositLoadProblem Dispute EarlyAccess FeeComplaint FeeQuestion HoldRelease(only) IncorrectNameorGovtIDorDOB, Lost/StolenCard Other ProblemwithCardReceivedNameNotRight ProblemwithCardReceived-Other Replacement Card Order ReportofPossibleFraud ResearchbySupervisororPM StoreComplaint TransactionorBalanceQuestion TroubleActivatingaCard/SettingaPIN Unknown Verification VerificationMaxAttemptsReached WesternUnion
| |
| Description | Y | Format: Alphanumeric, 1-30 | |
## Output Parameters:
## XML Samples
### Input XML
```json
12345678901234765;
ResolveCardSession1212121212121213Portal:csr789654321DisputeResolving previously escalated call.
```
```json
ResolveCardSession1234567890StatusOKNA2007-06-24 07:20:4064556712200743075
```
```json
ResolveCardSession0707161220073710570199Session Not ExistSession Not Exist2021-10-01 12:37:5007071612200737105
```
# Set Single Day Override
## Set Single Day Override
The Set Single Day Override API enables setting a one day limit (which expires at the end of the day), which is different (and higher) than the one defined for the entity.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------- | -------- | -------------------------------------------------------------------------- | -------- |
| SDOAmount | Y | Format: Numeric, 1-9 | |
| TargetEntityName | Y | Format: Alphanumeric, 60 | |
| TargetEntityType | Y |
Format:Alphanumeric, 20 ORGANZATION STORE USER TERMINAL
| |
## Output Parameters:
## XML Samples
### Input XML
```json
Avinadav1q2w3e4r;
473589SetSingleDayOverrideExtAPIORGANIZATIONZZ_QA_Test1100
```
```json
SetSingleDayOverride298404042008210300StatusOKNA2008-03-12 04:21:0429840404200821030
```
```json
SetSingleDayOverride0707161220073710570012ServiceNotAllowedServiceNotAllowed2021-10-01 12:37:5007071612200737105
```
# Start Card Session
## Start Card Session
The Start Card Session API is used to start CSR/IVR/CHP sessions
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber Input should be Card Session ID in case IDType = CardSessionID
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ---------------------------------------------------------------------------- |
| ActivationDate | Format: YYYY-MM-DD | Not returned | Returned | |
| ActiveFBECard | Format: Y/N | Not returned | Returned | |
| ActiveHoldsTotalAmount |
Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder
| Not returned | Returned | |
| ActualExpirationDate |
Format: Alphanumeric, 12, Month YYYY Description: example, April 2013
| Not returned | Returned | |
| AddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | |
| AddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | |
| Brand | Format: Alpha, 1-120 | Not returned | Returned | |
| CardAssociation |
Format options: Visa MasterCard Star
| Not returned | Returned | |
| CardAvailableBalance | Format: Numeric, 11 | Not returned | Returned | |
| CardDDA | Format: Numeric, 3-16 | Not returned | Returned | |
| CardFBEDDA | Format: Numeric, 16 | Not returned | Returned | |
| CardHolderState |
Format options: V V-PNS RNV NRNV
| Not returned | Returned | |
| CardholderUserName | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | |
| CardIssuingBank | Format: Alphanumeric, 30 | Not returned | Returned | |
| CardIssuingBankCode | Format: Alphanumeric, 5 | Not returned | Returned | |
| CardIssuingBankRoutingNumber | Format: Alphanumeric, 9 | Not returned | Returned | |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | |
| CardSessionID | Format: Alphanumeric, 30 | Not returned | Returned | |
| 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 | |
| C-B-B | Format: Alphanumeric, “5-2-2” | Not returned | Returned | |
| City | Format: Alphanumeric, 20 | Not returned | Returned | |
| Country |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| Not returned | Returned | |
| DateOfBirth |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| Not returned | Returned | |
| DocExpirationDate |
Format: YYYY-MM-DD Description: must be after DocIssueDate. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| Not returned | Returned | |
| DocId |
Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)
| Not returned | Returned | |
| DocIssueDate |
Format: YYYY-MM-DD Description: must be before DocExpirationDate Conditional value required only when DocType is 'PASS' or 'MCN'
| Not returned | Returned | |
| DocIssuer |
Format: Alphanumeric, 2 Description: Country/State code. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| Not returned | Returned | |
| DocState | Format: Alphanumeric, 2 | Not returned | Returned | |
| 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 | |
| EarlyAccess | Format: Y/N | Not returned | Returned | |
| Email |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| Not returned | Returned | |
| ExpirationDate | Format: MMYY | Not returned | Returned | |
| Fax |
Format: Numeric, 6-10 Description: the fax number.
| Not returned | Returned | |
| FBEEnrollments | Format: Numeric, 2. Number of active FBE Enrollments in statuses Submitted (G), Confirmed (C), Updated (U) and (Enrolled (E) | Not returned | Returned | |
| FeeAmount | Format: Numeric, 10 | Not returned | Returned | |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | |
| FileCategory |
Format Options: Primary Secondary Other
Description: Primary files are the following file content types: Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license
Secondary files are the following file content types: Pay Stub, School/Work ID, Tax Payer ID, Utility Bill,
Other files refer to all other file content types (as Third Party)
| Not returned | Returned | part of Tag Files/File |
| FileName | Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! \~ = \_ ' | Not returned | Returned | part of Tag Files/File |
| FileContent |
Format options: The FileContent can be any value (allowed per Product Type). For example, It can be one of the following values (or other content types as well for each customer, based on his requirements): Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license, Pay Stub, School/Work ID, Tax Payer ID, Utility Bill, Third Party
The supported characters are: a-z A-Z 0-9 \_- / . ' ( ) It is limited to 100 characters
| Not returned | Returned | part of Tag Files/File |
| InvalidPINAttempts | Format: Numeric, 2 | Not returned | Returned | |
| IsPinSet | Format: Y/N | Not returned | Returned | |
| IsRegistered | Format: Y/N | Not returned | Returned | |
| IsRetailCard |
Format: Y/N Description: Indicates whether the card is part of a retail pack and is it a retail card
| Not returned | Returned | |
| IssueDate | Format: YYYY-MM-DD HH:MM:SS.M | Not returned | Returned | |
| IssuerEmail |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| Not returned | Returned | |
| IssuerName | Format: Alphanumeric, 30 | Not returned | Returned | |
| IssuerPhone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | |
| IsVerified | Format: Y/N | Not returned | Returned | |
| LastActivityDate | Format: YYYY-MM-DD | Not returned | Returned | |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | |
| MaxDeclinedTxnsReached | Format: Y/N | Not returned | Returned | |
| MaxPinRetriesReached | Format: Y/N | Not returned | Returned | |
| MiddleInitial |
Format: Alpha,1 Description: Middle name char of the cardholder.
| Not returned | Returned | |
| MobilePhone |
Format: Numeric, 6-15 Description: Mobile phone for getting SMS (see IsReceiveSms).
| Not returned | Returned | |
| Phone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | |
| ProductType | Format: Alphanumeric, 120 | Not returned | Returned | |
| PTExpirationDate | Format: MMYY | Not returned | Returned | |
| PTAllowDifferentShippingAddress | Format: Y/N | Not returned | Returned | |
| ReplacementMessageType |
Format options: ToBeReplacedInAnotherBankForVerifiedCH ToBeReplacedInAnotherBankForRNVCH PTExpirationDate CardExpirationDate ReplacementCardOrderedFromAnotherBank ReplacementCardOrderedFromSameBank ReplacedAnotherCardInAnotherBank
| Not returned | Returned | |
| ReplacementStatus |
| Not returned | Returned | |
| RPID | Format: Numeric, 1-19 | Not returned | Returned | |
| SendSMS |
Format options: Enable Disable Unspecified Mail
| Not returned | Returned | |
| SessionAgent | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | part of SessionHistory/Session Tag. Return two last CSR sessions done for CH |
| SessionCallCenter | Format: Alphanumeric, 60 | Not returned | Returned | part of SessionHistory/Session Tag. Return two last CSR sessions done for CH |
| SessionCategory |
Format options: AddressChange CallNotEnded (\*will not be show in UI) CardNotReceived CardStatusProblem Card-to-CardTransfer CloseAccountRequest DirectDepositEnrollmentProblem DirectDepositLoadProblem Dispute EarlyAccess FeeComplaint FeeQuestion HoldRelease(only) IncorrectNameorGovtIDorDOB, Lost/StolenCard Other ProblemwithCardReceivedNameNotRight ProblemwithCardReceived-Other Replacement Card Order ReportofPossibleFraud ResearchbySupervisororPM StoreComplaint TransactionorBalanceQuestion TroubleActivatingaCard/SettingaPIN Unknown NewCardFulfillmentFailure Verification ReviewUploadedVerificationDocuments VerificationMaxAttemptsReached WesternUnionType the text for 'Category(Start Card Session)'
| Not returned | Returned | part of SessionHistory/Session Tag.Return two last CSR sessions done for CH |
| SessionDate | format: mm/dd/yy | Not returned | Returned | part SessionHistory/Session Tag.Return two last CSR sessions done for CH |
| SessionDuration | Format: Numeric, 5 (xxx.x - minutes.seconds, as 12.4) | Not returned | Returned | part SessionHistory/Session Tag.Return two last CSR sessions done for CH |
| SessionResult |
Format options: Resolved Cancelled Escalated NoVerify CallNotEnded CallEnded ResolvedDelay (internal only and should not be supported by API)
| Not returned | Returned | part of SessionHistory/Session Tag.Return two last CSR sessions done for CH |
| SessionTime | Format: hh:mm | Not returned | Returned | part of SessionHistory/Session Tag.Return two last CSR sessions done for CH |
| ShippingAddressLine1 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | |
| ShippingAddressLine2 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | |
| ShippingCity |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,
| Not returned | Returned | |
| ShippingState | Format: Alphanumeric, 2 | Not returned | Returned | |
| ShippingZIP | Format: Numeric, 5 | Not returned | Returned | |
| State | Format: Alphanumeric, 2 | Not returned | Returned | |
| StatusReasonCode |
| Not returned | Returned | |
| 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 | |
| SubBin | Format: Numeric, 3 (of current card) | Not returned | Returned | |
| TCFileName | Format: Alphanumeric, 120, including characters "/" , ":" , "." , "" | Not returned | Returned | |
| UpgradeBalance1 | Format: Numeric, 11 | Not returned | Returned | |
| UpgradeBalance2 | Format: Numeric, 11 | Not returned | Returned | |
| VerificationAttempts | Format: Numeric, 2 | Not returned | Returned | |
| VerificationId | Format: Alphanumeric, 50 | Not returned | Returned | |
| VerificationStatus |
Format options: VerifiedSSN VerifiedThirdParty VerifiedDocumentary VerifiedByIssuer SSNVerificationRequired DocumentaryVerificationRequired OOWVerificationRequired Blank
| Not returned | Returned | |
| Zip | Format: Numeric, 5 | Not returned | Returned | |
## XML Samples
### Input XML
```json
12345678901234567StartCardSession1212121212121213Portal:CSR9919090000000101CSRCardNumber
```
```json
StartCardSession123456789012345670StatusOKNA2010-06-23 13:49:47382346132010490640April 2013Star199911110002356171111000235618NRNVIssuingBanktest900MB07397218138234613201049064CIIN0413PrimaryaPassportPrimarybMilitary ID0NNY2008-06-12 04:21:45.0ProgMngr2333222333dev@praxell.comNNNZ_Progreso STAR - Low Limit000
```
```json
StartCardSession0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Update ACH Transaction Status
## Update ACH Transaction Status
The Update ACH Transaction Status API allows to update the ACH transaction status.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| ACHTransactionEvent | Y |
Format options: OFAC\_HIT\_TXN\_DECLINED FORCE\_RESUBMITTED\_TXN FORCE\_RESUBMITTED\_TXN FORCE\_TXN\_MANUAL\_SUCCESS HOLD\_TXN SUBMIT\_RETURN\_TXN
| |
| ACHTransactionID | Y | Format: Alphanumeric, 50 | |
| Description | N | Format: Alphanumeric, 1-30 | |
| ReturnedErrorCode | N | Format: numeric, 5 | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------- |
| ID |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| Not returned | Returned | |
## XML Samples
### Input XML
```json
st_managerst_manager;
UpdateACHTransactionStatus1212121212121213ExtAPI12345678FORCE_TXN_MANUAL_SUCCESSTest Success
```
```json
UpdateACHTransactionStatus385024072009400740StatusOKNA2009-07-13 07:40:42385024072009400741111000235273DDA
```
```json
UpdateACHTransactionStatus0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Validate Inventory Location
## Validate Inventory Location
The Validate Inventory Location API allows checking whether the given retail pack or card is owned by the requester in the Praxell inventory.
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| CardNumber | C | Format: Numeric, 16 | When selecting SingleCardNumber |
| FromCardNumber | C | Format: Numeric, 16 | When selecting RangeCardNumber |
| FromRetailPackId | C |
| When selecting RangeRetailPack |
## Output Parameters:
## XML Samples
### Input XML
```json
ZZ_QA_Test1_FBZ1q2w3e4r;
4515260ValidateInventoryLocationExtAPI1564560040266854SingleCardNumber
```
```json
ValidateInventoryLocation298381112008040300StatusOKNA2008-03-11 11:04:0229838111200804030
```
```json
ValidateInventoryLocation0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Validate Product Type
## Validate Product Type
The Validate Product Type API checks that the requesting user parent organization can work with the requested product type.
## Input Parameters:
| Name | Required | Definition | Comments |
| --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| CardNumber | Y | Format: Numeric, 16 | |
| ProductTypeName | Y |
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.
| |
## Output Parameters:
## XML Samples
### Input XML
```json
ZZ_QA_Test1_FBZ1q2w3e4r;
947652ValidateProductTypeExtAPI
```
```json
ValidateProductType298380112008010300StatusOKNA2008-03-11 11:01:0229838011200801030
```
```json
ValidateProductType0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# View Debit Organizations Hierarchy
## View Debit Organizations Hierarchy
The View Debit Organizations Hierarchy API returns the organization hierarchy.
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------- | -------- | ---------------------------------------------------------------------------------- | -------- |
| IssuingBank | Y | Format: Alphanumeric, 40 | |
| OrgId | Y |
Format: Alphanumeric, 20 Value can be multiple org\_id’s split by commas
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ----------------------- | ------------------------ | ------------ | ------------ | --------------------------------- |
| ParentOrgId | Format: Alphanumeric, 20 | Not returned | Returned | |
| ParentOrgName | Format: Alphanumeric, 30 | Not returned | Returned | |
| ParentOrgType | Format: Alphanumeric, 30 | Not returned | Returned | |
| UnderOrganizationId | Format: Alphanumeric, 20 | Not returned | Returned | In tag UnderOrgs sub-tag UnderOrg |
| UnderOrganizationName | Format: Alphanumeric, 30 | Not returned | Returned | In tag UnderOrgs sub-tag UnderOrg |
| UnderOrganizationStatus | Format: Alphanumeric, 1 | Not returned | Returned | In tag UnderOrgs sub-tag UnderOrg |
| UnderOrganizationType | Format: Alphanumeric, 30 | Not returned | Returned | In tag UnderOrgs sub-tag UnderOrg |
## XML Samples
### Input XML
```json
test_pm1212121212121213Praxell- internal: web portal API05200637022706028152ViewDebitOrganizationsHierarchy1234
```
```json
ViewDebitOrganizationsHierarchy0StatusOK2010-07-25 17:10:0640618217201010070052006370227060281520002ProgMngrProgMngr12345Reseller1ResellerA123456Reseller2ResellerN
```
```json
ViewDebitOrganizationsHierarchy0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Card Issuance
# Activate-Card
## ActivateCard
The Activate Card API requests to activate a card, this operation sets the card's initial PIN. The activation is done by providing the Date of birth and the CVV (the CVV parameter is part of the general XML Authentication part - see XML sample)
## Input Parameters:
| Name | Required | Definition | Comments |
| --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| CardNumber | C | Format: Numeric, 16 | Mutually exclusive with ID. Deprecated (use ID/ID Type) |
| DateOfBirth | C |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| must provide DateOfBirth or Last4OfID |
| Last4OfID | C |
Format: 4 characters long, numbers or alphanumeric. Description: Last 4 characters of the SSN (or any other Government Issue ID) the cardholder registered with
| must provide DateOfBirth or Last4OfID |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| Mutually exclusive with CardNumber. Required if IDType is provided |
| IDType | N |
Format options: CardNumber RPID SavingAccount
| relevant only for ID parameter (CardNumber is default) |
| NewPin | C |
Format: Numeric, 4 Description: New PIN value of private code, represented as 4 digits
| Optional only if NoPINActivation=Y. Otherwise, Required |
| NewPin2 | C |
Format: Numeric, 4 Description: New PIN value verification, repeats the NewPin value
| Optional only if NoPINActivation=Y. Otherwise, Required |
| NoPINActivation | N | | |
| OrgId | N |
Format: Alphanumeric, 20 Value can be multiple org\_id’s split by commas
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------- |
| CardBalance | Format: Numeric, 11 | Not returned | Returned | |
| CardIssuingBank | Format: Alphanumeric, 30 | Not returned | Returned | |
| CardStatus |
"Active" (ACT) "Suspended" (SPND) "Card In Inventory" (CII) "Spoilt" (SPLT) "Cardholder Close" (CC) "Lost" (LST) "Locked" (LOCK) "Locked Card In Inventory" (LOCK\_CII) "Stolen" (STLN) Description: All application cards status descriptions (as Active, Suspended)
| Not returned | Returned | |
| CardStatusId | Format options: ACT, CC, CII, LOCK\_CII, LOCK, LST, SPLT, SPND, STLN | Not returned | Returned | |
| CardType | Format: Alphanumeric, 10 | Not returned | Returned | |
| ExpirationDate | Format: MMYY | Not returned | Returned | |
| IsAssigned | Format: Y/N | Not returned | Returned | |
| IsRetailCard |
Format: Y/N Description: Indicates whether the card is part of a retail pack and is it a retail card
| Not returned | Returned | |
| IssueDate | Format: YYYY-MM-DD HH:MM:SS.M | Not returned | Returned | |
| IssuerName | Format: Alphanumeric, 30 | Not returned | Returned | |
| ReplacementMessageType |
Format options: ToBeReplacedInAnotherBankForVerifiedCH ToBeReplacedInAnotherBankForRNVCH PTExpirationDate CardExpirationDate ReplacementCardOrderedFromAnotherBank ReplacementCardOrderedFromSameBank ReplacedAnotherCardInAnotherBank
| Not returned | Returned | |
| ReplacementStatus |
| Not returned | Returned | |
## XML Samples
### Input XML
```json
12345678900000121231978-04-08963369551ActivateCardExtAPI1978-04-081234567890123456CardNumber604560451234
```
```json
ActivateCard380973172011100640StatusOKNA2021-02-25 17:10:4038097317201110064ActiveACTYY2021-02-25 15:20:19.0IssuingBanktest90004139999999991999StoreReplacedAnotherCardInSameBank
```
```json
ActivateCard3855381120110706370022INVALID CARD ACTIVE STATUSNA2021-02-25 11:07:3938553811201107063
```
# Instant-Issue-Card
## InstantIssueCard
The Instant Issue Card API performs enablement by card number for cards, which are anonymous. In addition, the API gets cardholder registration details and register an existing anonymous card to that cardholder.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| AddressLine1 | Y |
Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >
| |
| AddressLine2 | N |
Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >
| |
| Amount | N |
Format: Numeric, 1-9 Description: The amount is in cents.
| |
| CardNumber | C | Format: Numeric, 16 | |
| City | Y |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period, &
| |
| Country | Y |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| Value "US" expected |
| DateOfBirth | Y |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| |
| Description | N | Format: Alphanumeric, 1-30 | |
| DocExpirationDate | C |
Format: YYYY-MM-DD Description: must be after DocIssueDate. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| |
| DocId | Y |
Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)
| |
| DocIssueDate | C |
Format: YYYY-MM-DD Description: must be before DocExpirationDate Conditional value required only when DocType is 'PASS' or 'MCN'
| |
| DocIssuer | C |
Format: Alphanumeric, 2 Description: Country/State code. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| |
| DocType | Y |
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.
| |
| Email | N |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| |
| Fax | N |
Format: Numeric, 6-10 Description: the fax number.
| |
| FirstName | Y |
Format: Alpha, 2-50 Can contains as well these special characters: /, -, space, comma, period, &
| |
| IsReceiveSms | N |
Format options: Enabled (the cardholder has requested to receive an SMS for transactions and therefore he get SMS's) Disabled (the cardholder has requested to not receive an SMS for transactions and therefore he does not get SMS's) Blank (the cardholder has not requested to receive an SMS for transactions and therefore he does not get SMS's) Mail (the cardholder has requested to receive an mail for transactions and therefore he get mails)
Description:Defines if the cardholder gets an SMS/Mail.
| |
| IssueWithoutVerification | N |
Format: Y/N Description: Allows to issue a card without verification. Closed list values
| |
| LastName | Y |
Format: Alpha, 2-50 Can contains as well these special characters: /, -, space, comma, period, &
| |
| MiddleInitial | N |
Format: Alpha,1 Description: Middle name char of the cardholder.
| |
| MobilePhone | C |
Format: Numeric, 6-10 Description: Mobile Phone number
| MobilePhone is required only if IsReceiveSms=Enabled |
| OOWAnswer | C | Field:TBD | future |
| OOWQuestionType | N | Field:TBD | future |
| OperationType | N |
Format options: CardNumber RPID
| |
| Phone | Y |
Format: Numeric, 6-10 Description: Phone number
| |
| ReturnOOWQuestions | N | Format: Y/N (N is default). | future |
| RPID | C | Format: Numeric, 1-19 | |
| ShippingAddressLine1 | Y |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| |
| ShippingAddressLine2 | Y |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| |
| ShippingCity | Y |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,
| |
| ShippingState | Y | Format: Alphanumeric, 2 | |
| ShippingZIP | Y | Format: Numeric, 5 | |
| SkipVerification | N |
Format Options: Y/N (default: N) Description: Allow to skip verification attempt done by API. in such cases, the cardholder will be created in RNV (Registered Not Verified) mode
| |
| State | Y | Format: Alphanumeric, 2 | |
| UserDefined1 | N |
| |
| UseShippingDetails | Y | Format: Y/N (default) | |
| VerifyByIssuer | Y | Format: Y/N (default) | future |
| Zip | Y | Format: Numeric, 5 | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ------------ |
| BankRoutingNumber | Format: Alphanumeric, 9 | Not returned | Returned | |
| CardHolderState |
Format options: V V-PNS RNV NRNV
| Not returned | Returned | |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | |
| DDA | Format: Numeric, 3-16 | Not returned | Returned | |
| OOWEligible | Format: Y/N | Not returned | Returned | |
| 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 | |
| VerificationAttempts | Format: Numeric, 2 | Not returned | Returned | |
| VerificationID | Format: Alphanumeric, 50 | Not returned | Returned | |
| VerificationStatus |
Format options: If CH is verified, the options are: VerifiedSSN VerifiedByIssuer
If CH is not verified, the options are: SSNVerificationRequired (if DocType is SSN & SkipVerification=Y) DocumentaryVerificationRequired (if DocType is SSN & SkipVerification=N) DocumentaryVerificationRequired (if DocType is not SSN)
| Not returned | Returned | |
| CardAvailableBalance | Format: Numeric, 11 | Not returned | Returned | |
| RPID | Format: Numeric, 1-19 | Not returned | Returned | |
| IVRPhoneNumber | Format: Numeric, 6-15 | Not returned | Returned | |
| ProgramURL | Format: Alphanumeric, 1000 (including ? : . ) | Not returned | Returned | |
| FeeAmount | Format: Numeric, 10 | Not returned | Returned | Fees.Fee tag |
| ContextTransactionDescription | Format: Alphanumeric, 80 | Not returned | Returned | Fees.Fee tag |
| ContextTransactionType | Format: List of values: Credit, Debit | Not returned | Returned | Fees.Fee tag |
| FeeAmount | Format: Numeric, 10 | Not returned | Returned | Fees.Fee tag |
| FailedFee | Format: Y/N. Provide yes if there are some fees which are not taken for any reason | Not returned | Returned | Fee tag |
## XML Samples
### Input XML
```json
hccne_fb_QA1q2w3e4rInstantIssueCard5435435436Portal:pdpfail10495sdfsdfUS1980-01-01231231231SSNsdfsdfsdfNsdsdfsdfCardNumber2342342234ALY234234234234234234
```
```json
InstantIssueCard385538112011070630StatusOKNA2011-06-29 11:07:3938553811201107063V-PNS9772761VerifiedSSN1N
```
```json
InstantIssueCard3855381120110706370000Processor errorNA2021-02-23 11:07:3938553811201107063
```
# New-Card
## NewCard
The New Card API creates a new card for the given cardholder. The card will be sent through fullfilemnt (probably post mail) and its number and account are created in realtime. Card physical creation is done once, daily, by a batch file sent to the fulfillment house. The API contains all data relevant to cardholder (as address, city, etc).
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| AddressLine1 | Y |
Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >
| |
| AddressLine2 | N |
Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >
| |
| CampaignCode | N | Format: Alphanumeric, 1-120 | |
| City | Y |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period, &
| |
| DateOfBirth | Y |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| |
| DocExpirationDate | C |
Format: YYYY-MM-DD Description: must be after DocIssueDate. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN' AND SecondaryCard param exist and is different than “Y” |
| DocId | Y |
Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)
| |
| DocIssueDate | C |
Format: YYYY-MM-DD Description: must be before DocExpirationDate Conditional value required only when DocType is 'PASS' or 'MCN'
| Conditional value required only when DocType is 'PASS' or 'MCN' AND SecondaryCard param exist and is different than “Y” |
| DocIssuer | C |
Format: Alphanumeric, 2 Description: Country/State code. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN' AND SecondaryCard param exist and is different than “Y” |
| DocType | Y |
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.
| |
| Email | N |
Format General o An email address is made up of a local part, an @ symbol, then a domain part (XXXXX\@XXXXX) o Full Email Address Maximum Size: 254 chars o Local part & domain consist of labels separated by dots — Each label max size is 64 — Two successive dots are forbidden — mail cannot start or end with a dot — Labels cannot not start with a hyphen, end with a hyphen, or contain two successive hyphens.
Local part o Size: 1-64 chars o Allowed Chars: a-z, A-Z, 0-9, and special characters: - \_ . \~ ! ' \*
Domain part o Size: 1-251 chars o Allowed Chars: a-z, A-Z, 0-9, and special characters: - \_ .
| |
| EnrollCashback | N |
Format:Y/N
| |
| EnrollMailNotification | N | Format:Y/N | |
| Fax | N |
Format: Numeric, 6-10 Description: the fax number.
| |
| FirstName | Y |
Format: Alpha, 2-50 Can contains as well these special characters: /, -, space, comma, period, &
| |
| IsReceiveSms | N |
Format options: Enabled (the cardholder has requested to receive an SMS for transactions and therefore he get SMS's) Disabled (the cardholder has requested to not receive an SMS for transactions and therefore he does not get SMS's) Blank (the cardholder has not requested to receive an SMS for transactions and therefore he does not get SMS's) Mail (the cardholder has requested to receive an mail for transactions and therefore he get mails)
Description:Defines if the cardholder gets an SMS/Mail.
| |
| LastName | Y |
Format: Alpha, 2-50 Can contains as well these special characters: /, -, space, comma, period, &
| |
| 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).
| |
| MiddleInitial | N |
Format: Alpha,1 Description: Middle name char of the cardholder.
| |
| MobilePhone | C |
Format: Numeric, 6-10 Description: Mobile Phone number
| MobilePhone is required only if IsReceiveSms=Enabled |
| Phone | Y |
Format: Numeric, 6-10 Description: Phone number
| |
| ProductTypeName | C |
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.
| It is not required and not relevant if Secondary Card param is Y. Otherwise, it is required |
| ReferralCode | N | Format: Alphanumeric, 1-120 | |
| SecondaryCard | N | Format: Y/N (default) | |
| ShippingAddressLine1 | C |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| relevant if UseShippingDetails=Y |
| ShippingAddressLine2 | C |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| relevant if UseShippingDetails=Y |
| ShippingCity | C |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,
| relevant if UseShippingDetails=Y |
| ShippingState | C | Format: Alphanumeric, 2 | relevant if UseShippingDetails=Y |
| ShippingZIP | C | Format: Numeric, 5 | relevant if UseShippingDetails=Y |
| SkipVerification | N |
Format Options: Y/N (default: N) Description: Allow to skip verification attempt done by API. in such cases, the cardholder will be created in RNV (Registered Not Verified) mode
| |
| State | Y | Format: Alphanumeric, 2 | |
| Title | Y | Format: List “Ms.”, “Mr.” | |
| Token | N |
Format: Number, 6 Description: Six digits value (should be unique for a period of N minutes (where N is a system parameter)
| |
| UseShippingDetails | N | Format: Y/N (default) | |
| Zip | Y | Format: Numeric, 5 | |
| CardDDA | Format: Numeric, 3-16 | | |
| RoutingNumber | Format: Numeric,16 | | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ------------------------------------------------------------- |
| CardDDA | Format: Numeric, 3-16 | Not returned | Returned | |
| CardHolderState (New Card) |
Format options: V V-PNS RNV
| Not returned | Returned | |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | |
| RPID | Format: Numeric, 1-19 | Not returned | Returned | |
| VerificationID | Format: Alphanumeric, 50 | Not returned | Returned | |
| VerificationStatus |
Format options: If CH is verified, the options are: VerifiedSSN VerifiedByIssuer
If CH is not verified, the options are: SSNVerificationRequired (if DocType is SSN & SkipVerification=Y) DocumentaryVerificationRequired (if DocType is SSN & SkipVerification=N) DocumentaryVerificationRequired (if DocType is not SSN)
| Not returned | Returned | in current New Card version, only SSN is supported as DocType |
## XML Samples
```json
Keren_Full_QANewCardExtAPIKerenMAharon33 Hayetzira st.PO Box 1234Tel AvivOH45251036126066111425799998765432191978-04-08qa@praxell.com231231231SSNKeren NFF CardsEnabledN
```
```json
NewCard461444162011080600StatusOKNA2021-06-30 16:08:05461444162011080600V-PNS9772761VerifiedSSN9800000051
```
```json
NewCard3855381120110706370064Invalid Product TypeNA2021-02-23 11:07:3938553811201107063
```
# Card Status & Management
# Change-Card-Pin
## Change Card PIN
The Change Card PIN API allows to change the card PIN.
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------- | -------- | ------------------------------------------------------------------------------------------------ | -------- |
| CardNumber | Y | Format: Numeric, 16 | |
| CurrentPIN | Y |
Format: Numeric, 4 Description: A private code
| |
| DateOfBirth | N |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| |
| NewPin | Y |
Format: Numeric, 4 Description: New PIN value of private code, represented as 4 digits
| |
## Output Parameters:
No Output Parameters
## XML Samples
### Input XML
```json
4321;
2584564ChangeCardPINExtAPI123456789012345612346045
```
```json
ChangeCardPIN070716122007371050StatusOKNA2007-10-01 12:37:5007071612200737105
```
```json
ChangeCardPIN0707161220073710570284New PIN Identical to current PINNew PIN Identical to current PIN2021-10-01 12:37:5007071612200737105
```
# Close-Card
## Close Card
The Close Card API allows closing a card.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| CardNumber | C | Format: Numeric, 16 | Deprecated. Will be removed in the future |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ---------------- | ------------------- | ------------ | ------------ | -------- |
| AvailableBalance | Format: Numeric, 11 | Not returned | Returned | |
## XML Samples
### Input XML
```json
Yair_CSR_PM1q2w3e4r;
2598800CloseCardExtAPI
```
```json
CloseCard298330082008070320StatusOKNA2008-03-11 08:07:2029833008200807032902
```
```json
CloseCard0707161220073710570000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Free Card
## Free Card
The Free Card API allows to reset a card PIN
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------------------- | -------- | ------------------- | -------- |
| CardNumber | Y | Format: Numeric, 16 | |
| ResetMaxConseqRejectedTxn | Y | Format Options: Y/N | |
| ResetMaxPINAttempts | Y | Format Options: Y/N | |
## Output Parameters:
## XML Samples
### Input XML
```json
test_csrpmtest_csrpm;
FreeCard1212121212121213ExtAPI9999999999998011YY
```
```json
FreeCard052006370227060281520StatusOKNA2007-05-27 06:17:5405200637022706028152
```
```json
```
# Get Card Balance
## Get Card Balance
The Get Card Balance API calls Get Card Report API, but its response contains card balances only.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| CardNumber | C | Format: Numeric, 16 | Deprecated. Will be removed in the future |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | C |
Format options: CardNumber RPID SavingAccount
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ---------------------- | --------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------- |
| CardAvailableBalance | Format: Numeric, 11 | Not returned | Returned | |
| ActiveHoldsTotalAmount |
Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder
| Not returned | Returned | |
## XML Samples
### Input XML
```json
FB_PRX_ER;
2757570GetCardBalanceExtAPI
```
```json
GetCardBalance730431102007390910StatusOKNA2007-09-16 10:39:13730431102007390911999120865
```
```json
GetCardBalance0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Get Card Details
## Get Card Details
The Get Card Details API provides all required information about the card and its cardholder.
## Input Parameters:
| Name | Required | Definition | Comments |
| -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| CVV | N | Format: Numeric, 3 | |
| GetHoldsBalance | N | Format: Y/N (Default = N) | |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | N |
Format options: CardNumber RPID SavingAccount
| Default=CardNumber |
| 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).
| |
| GetExtraCardDetails | N |
Format: Y/N (default) allow to return transactions belonging to praxell codes group: CHTXN
| |
| GetGroupsFiles | N |
Format: Names of Groups (containing list of file contents). If parameter provided, the API will return all cardholder' files having a file content existing in this File Group. It support as well multiple groups (group, group, ..)
The supported characters are: a-z A-Z 0-9 \_- . , It is limited to 100 characters
| |
| GetUserDefinedParams | N | Format: N (default)/Y. if value is Yes, API provide all user defined data (UserDefined1-15) | |
| OrgId | N |
Format: Alphanumeric, 20 Value can be multiple org\_id’s split by commas
| for internal uses |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ---------------------------------------------------------------------------------------------------------- |
| ActivationDate | Format: YYYY-MM-DD | Not returned | Returned | |
| ActiveHoldsNumber |
Format: Numeric, 11 Description:Number of active holds existing for Cardholder
| Not returned | Returned | |
| ActiveHoldsTotalAmount |
Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder
| Not returned | Returned | |
| ActualExpirationDate |
Format: Alphanumeric, 12, Month YYYY Description: example, April 2013
| Not returned | Returned | |
| AddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | |
| AddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | |
| Brand | Format: Alpha, 1-120 | Not returned | Returned | |
| CardAvailableBalance | Format: Numeric, 11 | Not returned | Returned | |
| CardDDA | Format: Numeric, 3-16 | Not returned | Returned | |
| CardIssuingBank | Format: Alphanumeric, 30 | Not returned | Returned | |
| CardIssuingBankCode | Format: Alphanumeric, 5 | Not returned | Returned | |
| CardIssuingBankRoutingNumber | Format: Alphanumeric, 9 | Not returned | Returned | |
| 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 | |
| CardStatusId | Format options: ACT, CC, CII, LOCK\_CII, LOCK, LST, SPLT, SPND, STLN | Not returned | Returned | |
| CHState |
Format options: NRNV RNV V-PNS V
| Not returned | Returned | |
| City | Format: Alphanumeric, 20 | Not returned | Returned | |
| Country |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| Not returned | Returned | |
| DateOfBirth |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| Not returned | Returned | |
| DocId |
Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)
| Not returned | Returned | |
| 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 | |
| Email |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| Not returned | Returned | |
| ExpirationDate | Format: MMYY | Not returned | Returned | |
| Fax |
Format: Numeric, 6-10 Description: the fax number.
| Not returned | Returned | |
| FBEDDA | Format: Numeric, 16 | Not returned | Returned | |
| FileName | Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! \~ = \_ ' | Not returned | Returned | part of Tag Files/File |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | |
| IsPinSet | Format: Y/N | Not returned | Returned | |
| IsReceiveSms |
Format options: Enabled (the cardholder has requested to receive an SMS for transactions and therefore he get SMS's) Disabled (the cardholder has requested to not receive an SMS for transactions and therefore he does not get SMS's) Blank (the cardholder has not requested to receive an SMS for transactions and therefore he does not get SMS's) Mail (the cardholder has requested to receive an mail for transactions and therefore he get mails)
Description:Defines if the cardholder gets an SMS/Mail.
| Not returned | Returned | |
| IsRegistered | Format: Y/N | Not returned | Returned | |
| IssueDate | Format: YYYY-MM-DD HH:MM:SS.M | Not returned | Returned | |
| IssuerName | Format: Alphanumeric, 30 | Not returned | Returned | |
| IsVerified | Format: Y/N | Not returned | Returned | |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | |
| MiddleInitial |
Format: Alpha,1 Description: Middle name char of the cardholder.
| Not returned | Returned | |
| MobilePhone |
Format: Numeric, 6-15 Description: Mobile phone for getting SMS (see IsReceiveSms).
| Not returned | Returned | |
| Phone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | |
| 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 | |
| PT | Format: Alphanumeric, 30 | Not returned | Returned | |
| PTExpirationDate | Format: MMYY | Not returned | Returned | |
| PTFriendlyName |
Format: Alphanumeric, 1-120 Description: Product Type known name.
| Not returned | Returned | |
| ReplacementMessageType |
Format options: ToBeReplacedInAnotherBankForVerifiedCH ToBeReplacedInAnotherBankForRNVCH PTExpirationDate CardExpirationDate ReplacementCardOrderedFromAnotherBank ReplacementCardOrderedFromSameBank ReplacedAnotherCardInAnotherBank
| Not returned | Returned | |
| ReplacementStatus |
| Not returned | Returned | |
| RPID | Format: Numeric, 1-19 | Not returned | Returned | |
| ShippingAddressLine1 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | |
| ShippingAddressLine2 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | |
| ShippingCity |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,
| Not returned | Returned | |
| ShippingState | Format: Alphanumeric, 2 | Not returned | Returned | |
| ShippingZIP | Format: Numeric, 5 | Not returned | Returned | |
| State | Format: Alphanumeric, 2 | Not returned | Returned | |
| StatusReasonCode |
| Not returned | Returned | |
| Zip | Format: Numeric, 5 | Not returned | Returned | |
| CardholderUsername | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| ReplacedCard | | 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) |
| 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) |
## XML Samples
### Input XML
```json
test_pmtest_pm;
GetCardDetails1212121212121213ExtAPIDist19999999999998068CardNumber12.114.2YGroupName
```
```json
GetCardDetails379966062008180940StatusOKNA2008-09-21 06:18:473799660620081809403120865February 20111270 BroadwaySuite 120719991234111778452 // (sorted by by file content group and then by file name)
IssuingBanktest900MB789123456ACTACTVNew YorkUS1980-01-01123456789SSNqa@praxell.com02112126296232StaticYY2010-07-20 18:25:02.0StoreYData2126296040DevOnly1360DevOnlyCardExpirationDate9999999999998068NY100011000110001
```
```json
GetCardDetails0707161220073710570021Invalid Card IdInvalid Card Id2021-10-01 12:37:5007071612200737105
```
# Get Card Holder Spend Limits
## Get Card Holder Spend Limits
The Get Card Holds API can be used to retrieve Spend Limits on a card.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------ | -------- | --------------------------------------------------- | -------- |
| ID | Y | Identifier for the service, e.g., card ID, user ID. | |
| IDType | Y | Type of identifier used, e.g., RPID (Retailer ID). | |
## Output Parameters:
| Name | Required | Definition | Comments |
| ---------------------------------- | -------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| ServiceName | Y | Name of the service being requested. | |
| SessionId | Y | Format: UUID | Unique identifier for the session. |
| StatusCode | Y | Numerical code indicating the result of the service request. | Common HTTP status codes may be used. |
| StatusName | Y | Human-readable status name corresponding to the status code. | Descriptive status name. |
| StatusDescription | Y | Detailed description of the status, providing additional context. | Explanation of the status result. |
| ServiceDate | Y | Format: YYYY-MM-DD HH:mm:ss | Date and time of the service request. |
| ServiceId | Y | Format: UUID | Unique identifier for the service request. |
| AllowCardNotPresentTransaction | Y | Indicates whether card-not-present transactions are allowed. | Y/N |
| AllowCashAccess | Y | Indicates whether cash access is allowed. | Y/N |
| AllowContactlessTransaction | Y | Indicates whether contactless transactions are allowed. | Y/N |
| AllowInternationalUse | Y | Indicates whether international use is allowed. | Y/N |
| AllowOnlineTransaction | Y | Indicates whether online transactions are allowed. | Y/N |
| AllowPINPurchase | Y | Indicates whether PIN purchases are allowed. | Y/N |
| AllowPOSTransaction | Y | Indicates whether point-of-sale (POS) transactions are allowed. | Y/N |
| AllowRecurringTransaction | Y | Indicates whether recurring transactions are allowed. | Y/N |
| BypassCardMonetaryLimit | Y | Indicates whether card monetary limits are bypassed. | Y/N |
| BypassCardMonetaryPeriod | | Duration for bypassing card monetary limits. | Comment: Specify the duration if applicable. |
| BypassMerchantCategoryPeriod | | Duration for bypassing merchant category restrictions. | Comment: Specify the duration if applicable. |
| BypassMerchantCategoryRestrictions | Y | Indicates whether merchant category restrictions are bypassed. | Y/N |
| CardDailyAmount | | Maximum allowed daily spending amount for the card. | Comment: Specify the limit if applicable. |
| CardDailyCount | | Maximum allowed count of daily transactions for the card. | Comment: Specify the limit if applicable. |
| CardMonthlyAmount | | Maximum allowed monthly spending amount for the card. | Comment: Specify the limit if applicable. |
| CardMonthlyCount | | Maximum allowed count of monthly transactions for the card. | Comment: Specify the limit if applicable. |
| CardSingleTransaction | | Maximum allowed amount for a single transaction for the card. | Comment: Specify the limit if applicable. |
| CardWeeklyAmount | | Maximum allowed weekly spending amount for the card. | Comment: Specify the limit if applicable. |
| CardWeeklyCount | | Maximum allowed count of weekly transactions for the card. | Comment: Specify the limit if applicable. |
| ContactlessCardDailyAmount | | Maximum allowed daily spending amount for contactless transactions. | Comment: Specify the limit if applicable. |
| ContactlessCardDailyCount | | Maximum allowed count of daily contactless transactions. | Comment: Specify the limit if applicable. |
| ContactlessCardMonthlyAmount | | Maximum allowed monthly spending amount for contactless transactions. | Comment: Specify the limit if applicable. |
| ContactlessCardMonthlyCount | | Maximum allowed count of monthly contactless transactions. | Comment: Specify the limit if applicable. |
| ContactlessCardSingleTransaction | | Maximum allowed amount for a single contactless transaction. | Comment: Specify the limit if applicable. |
| ContactlessCardWeeklyAmount | | Maximum allowed weekly spending amount for contactless transactions. | Comment: Specify the limit if applicable. |
| ContactlessCardWeeklyCount | | Maximum allowed count of weekly contactless transactions. | Comment: Specify the limit if applicable. |
| NotPresentCardDailyAmount | | Maximum allowed daily spending amount for card-not-present transactions. | Comment: Specify the limit if applicable. |
| NotPresentCardDailyCount | | Maximum allowed count of daily card-not-present transactions. | Comment: Specify the limit if applicable. |
| NotPresentCardMonthlyAmount | | Maximum allowed monthly spending amount for card-not-present transactions. | Comment: Specify the limit if applicable. |
| NotPresentCardMonthlyCount | | Maximum allowed count of monthly card-not-present transactions. | Comment: Specify the limit if applicable. |
| NotPresentCardSingleTransaction | | Maximum allowed amount for a single card-not-present transaction. | Comment: Specify the limit if applicable. |
| NotPresentCardWeeklyAmount | | Maximum allowed weekly spending amount for card-not-present transactions. | Comment: Specify the limit if applicable. |
| NotPresentCardWeeklyCount | | Maximum allowed count of weekly card-not-present transactions. | Comment: Specify the limit if applicable. |
| PINPOSCardDailyAmount | | Maximum allowed daily spending amount for PIN POS transactions. | Comment: Specify the limit if applicable. |
| PINPOSCardDailyCount | | Maximum allowed count of daily PIN POS transactions. | Comment: Specify the limit if applicable. |
| PINPOSCardMonthlyAmount | | Maximum allowed monthly spending amount for PIN POS transactions. | Comment: Specify the limit if applicable. |
| PINPOSCardMonthlyCount | | Maximum allowed count of monthly PIN POS transactions. | Comment: Specify the limit if applicable. |
| PINPOSCardSingleTransaction | | Maximum allowed amount for a single PIN POS transaction. | Comment: Specify the limit if applicable. |
| PINPOSCardWeeklyAmount | | Maximum allowed weekly spending amount for PIN POS transactions. | Comment: Specify the limit if applicable. |
| PINPOSCardWeeklyCount | | Maximum allowed count of weekly PIN POS transactions. | Comment: Specify the limit if applicable. |
| SignPOSCardDailyAmount | | Maximum allowed daily spending amount for Signature POS transactions. | Comment: Specify the limit if applicable. |
| SignPOSCardDailyCount | | Maximum allowed count of daily Signature POS transactions. | Comment: Specify the limit if applicable. |
| SignPOSCardMonthlyAmount | | Maximum allowed monthly spending amount for Signature POS transactions. | Comment: Specify the limit if applicable. |
| SignPOSCardMonthlyCount | | Maximum allowed count of monthly Signature POS transactions. | Comment: Specify the limit if applicable. |
| SignPOSCardSingleTransaction | | Maximum allowed amount for a single Signature POS transaction. | Comment: Specify the limit if applicable. |
| SignPOSCardWeeklyAmount | | Maximum allowed weekly spending amount for Signature POS transactions. | Comment: Specify the limit if applicable. |
| SignPOSCardWeeklyCount | | Maximum allowed count of weekly Signature POS transactions. | Comment: Specify the limit if applicable. |
| Limit | Y | Object containing detailed spending limits. | Comment: Define spending limits for various transaction types. |
| MCCs | Y | List of Merchant Category Codes (MCCs) | Comment: Specify Merchant Category Codes and associated plans. |
| EnablePlan | Y | Indicates whether the plan is enabled for the specific MCC. | Y/N |
| MCCDescription | Y | Description of the Merchant Category Code (MCC). | Comment: Provide a brief description. |
| Plan | Y | Plan code associated with the MCC. | Comment: Specify the plan code. |
| PlanDescription | Y | Description of the plan associated with the MCC. | Comment: Provide a brief description. |
| PlanLimitDailyAmount | | Maximum allowed daily spending amount for the plan and MCC combination. | Comment: Specify the limit if applicable. |
| PlanLimitDailyCount | | Maximum allowed count of daily transactions for the plan and MCC combination. | Comment: Specify the limit if applicable. |
| PlanLimitMonthlyAmount | | Maximum allowed monthly spending amount for the plan and MCC combination. | Comment: Specify the limit if applicable. |
| PlanLimitMonthlyCount | | Maximum allowed count of monthly transactions for the plan and MCC combination. | Comment: Specify the limit if applicable. |
| PlanLimitWeeklyAmount | | Maximum allowed weekly spending amount for the plan and MCC combination. | Comment: Specify the limit if applicable. |
| PlanLimitWeeklyCount | | Maximum allowed count of weekly transactions for the plan and MCC combination. | Comment: Specify the limit if applicable. |
## XML Samples
### Input XML
```json
xxxxxxxxxxGetCardHolderSpendLimitsxxxxxxxxxxxxRPID
```
```json
GetCardHolderSpendLimits35a716c2-f162-4d31-8cbb-9e6f18ed51d40StatusOKNA2024-01-18 09:25:1135a716c2-f162-4d31-8cbb-9e6f18ed51d4YYYNYNYYYNYPawn Shop100Pawn ShopYPets101PetsYDiscount & Variety Store102Discount & Variety StoreYGambling Casino Betting136Gambling Casino BettingYFood, Food Delivery, Restaurant139Food, Food Delivery, RestaurantYCharitable Donations103Charitable DonationsYJewelry104JewelryYHome Repair Maintenance105Home Repair MaintenanceYHearing Aids106Hearing AidsYPharmacy107PharmacyYDating and Escort108Dating and EscortYBars Liquor Shop109Bars Liquor ShopYGas Station110Gas StationYLaundry111LaundyYAgricultral Services112Agricultural ServicesYPhone TV Cable113Phone TV CableYEducation114EducationYRecreation & Entertainment115Recreation & EntertainmentYBeauty116BeautyYGrocery Stores117Grocery StoreYProfessional_Services118Professional_ServicesYMedical Care119Medical CareYInsurance120InsuranceYClothing Stores121Clothing StoreYCar Rental122Car RentalYMoney Transfer123Money TransferYHotels134HotelsYAirlines133AirlinesYAuto Repairs126Auto RepairsYContracted Services127Contracted ServicesYGovernment Services129Government ServicesYTransportational Services130Transportational ServicesYBusiness Services132Business ServicesYUtility Services125Utility ServicesYMisc Stores131Misc StoresYRetail Services128Retail ServicesYDirect Sales124Direct Sales
```
```json
1001Authentication FailureThe provided authentication details are invalid or missing.2024-01-18 10:15:30
```
# Get Card Holds
## Get Card Holds
The Get Card Holds API provides a list of existing holds for a specific card.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder
| Not returned | Returned | |
| Amount |
Format: Numeric, 1-9 Description: The amount is in cents.
| Not returned | Returned | Returned as part of Holds/Hold tag |
| Date | Format: YYYY-MM-DD | Not returned | Returned | Returned as part of Holds/Hold tag |
| ExpirationDate | Format: MMYY | Not returned | Returned | Returned as part of Holds/Hold tag |
| HoldAccountNumber | Format: Alphanumeric, 11 | Not returned | Returned | Returned as part of Holds/Hold tag |
| HoldAccountType | Format: Alphanumeric, 1 | Not returned | Returned | Returned as part of Holds/Hold tag |
| HoldCardNumber |
| Not returned | Returned | Returned as part of Holds/Hold tag |
| HoldsNumber | Format: Numeric, 11 | Not returned | Returned | |
| Merchant | Format: Alphanumeric, 25 | Not returned | Returned | Returned as part of Holds/Hold tag |
| MerchantCategoryCode | Format: Alphanumeric, 4 | Not returned | Returned | Returned as part of Holds/Hold tag |
| ReferenceNumber | Format: Alphanumeric, 32 | Not returned | Returned | Returned as part of Holds/Hold tag |
| Status |
Format: ACTIVE (default) ALL
| Not returned | Returned | Returned as part of Holds/Hold tag |
| Time | Format: HH:MM:SS | Not returned | Returned | Returned as part of Holds/Hold tag |
| Terminal | Format: Alphanumeric, 8 | Not returned | Returned | Returned as part of Holds/Hold tag |
## XML Samples
### Input XML
```json
;
GetCardHolds
```
```json
GetCardHolds407076192009401130StatusOKNA2009-11-25 19:40:3840707619200940113120865032009-10-25NAPLAZA BAGELS AND DELI0.0510/28/2009A20295991030093856D999999999999806058122009-10-25NAKINGS SUPERMKTS #463.6011/03/2009A01028291030093856D999999999999806054112009-10-25NATIRE TECH & AUTO REPAI1205.0011/03/2009A00424691030093856D99999999999980605541
```
```json
GetCardHolds0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Get Card Report
## Get Card Report
There is a newer version of this report (GetCardsReport) that has better performance and better output. Please access it [Here](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Card%20Status%20&%20Management/APIS/Card%20Status%20&%20Management/Get%20Cards%20Report.md)\
The Get Card Report API produces the relevant response, including card general details and a list of transactions.
There is a possibility to get the results in paging mode (used mainly for UI). When using paging, NextPosition will return the number of the first transaction on the next page. For example: in case and Count=5 , first Get Card Report call will return 5 first transaction and NextPosition=5 (0 based). there is a need to send this value for the second Get Card Report call.
Specific information regarding paging mode used with GetHolds=Y:
1. Holds returns ONLY for the first result set (position =0) and ALL holds are always returns independent of the Count value provided.
2. If first result set contains holds, at least 1 transaction will be returned in addition to holds.
3. If first result set contains holds, TransactionNumber parameter will return results size minus holds count (at least 1 transaction will be returned).
## Input Parameters:
| Name | Required | Definition | Comments |
| --------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| CardNumber | C | Format: Numeric, 16 | Mutually exclusive with ID. Deprecated (use ID/ID Type) |
| Count | N |
Format: Numeric 1-100 Description: Number of transactions to be retrieved. Used for pagination & better use of server resources.
| |
| CountMaxHoldsToReturn | N |
Format: Numeric, 3, By default 0 Description: Define the maximum of holds to be returned by API in case and GetHolds=Y.
| |
| FromDate | N |
Format: YYYY-MM-DD Description: The default value is Today's date
| |
| GetHolds | N |
Format: N(default)/Y Description: GetCardReport API provides (among other transactions) the list of authorizations & purchases done by the cardholder.
Every authorization may be a Hold. The Get Card Report will return these authorizations as well (if not filtered out) but without hold information as hold expiration date.
In order to be able to get only the active holds, it is possible to define the relevant Get Card Report API’ parameter GetHolds as Y. Then, the Get Card Report API will provide all active holds. When a hold has expired the API response will no longer list that hold. Holds will be returned with Praxell code containing “P85” (PP85DS).
In order to avoid showing “pending transactions” twice (as authorization and as hold), it is possible to filter out authorization Praxell codes and to get holds. In this way, the cardholder see his pending transactions (holds) and his settlements (non-authorization transactions)
| if GetLinkedCardsHistory=Y and GetHolds=Y, the holds will be returned for the default account' current card |
| GetLinkedCardsHistory | N | Format: N(default)/Y | Return history of all cards linked to the required card |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| Mutually exclusive with CardNumber. Required if IDType is provided |
| IDType | C |
Format options: CardNumber RPID SavingAccount
| relevant only for ID parameter |
| Order | N |
Format: Closed list of values. ASC DESC Description: Indicates whether the query should be executed in ascending or descending order (Date is the order field).
| |
| Position | N |
Format: Numeric, 1-4, >0 Description: Number of position in list of values\records. For example, if Position=30 and Count=5, then the Response Transaction List begins with top (30+5) transactions. In the XML Response only records 31, 32, 33, 34 and 35 from that Transaction List are included. Default 0.
| |
| ResponseType | N |
Format: Closed list of values. All (default) Trx Details BalanceOnly Description: Operation response type
| |
| SearchText | N |
Format: Alphanumeric, 1-30 Description: Text to search.
| |
| ToDate | N |
Format: YYYY-MM-DD Description: the date should be after FromDate
| |
| TransactionCodes | C |
Format: 6 characters Description:List of Praxell codes. Each Praxell code is 6 characters. Filter list of required transaction codes to filter by: Praxell code, Praxell Code, etc or PP0DS, PP01DS, etc.
| |
| TransactionsCodeGroup | O | Format: Praxell code group name (e.g. PINSuspiciousTransactions, CHTXN (used by GetCardDetails, CHP, IVR Interface), Savings (used by CHP, IVR Interface for savings statement))Allow to return of transactions with Praxell codes belong to this group | |
| TransactionCodesMode | C |
Format: Included /Excluded Description: Requires TransactionCodes parameter
Format: Alphanumeric, 17 Description: Processor Account Number
| Not returned | Returned | |
| ActivationDate | Format: YYYY-MM-DD | Not returned | Returned | |
| ActiveHoldsNumber |
Format: Numeric, 11 Description:Number of active holds existing for Cardholder
| Not returned | Returned | |
| ActiveHoldsTotalAmount |
Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder
| Not returned | Returned | |
| ActiveHoldsUnreturnedNumber |
Format: Numeric, 2 Description: Total amount of all active holds which have not be returned for Cardholder
| Not returned | Returned | |
| ActualExpirationDate |
Format: Alphanumeric, 12, Month YYYY Description: example, April 2013
| Not returned | Returned | |
| AddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | |
| AddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | |
| Amount |
Format: Numeric, 1-9 Description: The amount is in cents.
| Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| ApprovalCode | Format:Alphanumeric, 8 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| AvailableBalance | Format: Numeric, 11 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| Brand | Format: Alpha, 1-120 | Not returned | Returned | |
| CardAssociation |
Format options: Visa MasterCard Star
| Not returned | Returned | |
| CardAvailableBalance | Format: Numeric, 11 | Not returned | Returned | |
| CardBalance | Format: Numeric, 11 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| CardDDA | Format: Numeric, 3-16 | Not returned | Returned | |
| CardHolderState |
Format options: V V-PNS RNV NRNV
| Not returned | Returned | |
| CardholderUserName | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | |
| CardIssuingBank | Format: Alphanumeric, 30 | Not returned | Returned | |
| CardIssuingBankCode | Format: Alphanumeric, 5 | Not returned | Returned | |
| CardIssuingBankRoutingNumber | Format: Alphanumeric, 9 | Not returned | Returned | |
| CardNumber |
| Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| CardStatus | Format Options: O (Open, for ACT and SPND card statuses), C (Close, for all other card statuses) | Not returned | Returned | |
| CardType |
Format: Primary/Secondary (field called CardType in APIs)
| Not returned | Returned | |
| City | Format: Alphanumeric, 20 | Not returned | Returned | |
| Country |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| Not returned | Returned | |
| Currency | Format: Alphanumeric, 3 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| CurrentStatus |
Format options: CII LOCKED\_CII LOCK ACT SPND LST STLN CC
| Not returned | Returned | |
| Date | Format: YYYY-MM-DD | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| DateOfBirth |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| Not returned | Returned | |
| Description | Format: Alphanumeric, 1-30 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| DisplayDescription | Format: Alphanumeric, 200 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| DocId |
Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)
| Not returned | Returned | |
| 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 | |
| Email |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| Not returned | Returned | |
| ExpirationDate | Format: MMYY | Not returned | Returned | |
| Fax |
Format: Numeric, 6-10 Description: the fax number.
| Not returned | Returned | |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | |
| HoldsBalance | Format: Numeric, 11 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| HoldExpirationDate |
Format: MM-DD-YYYY Description: The date the holds expired
| Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| InvalidPINAttempts | Format: Numeric, 2 | Not returned | Returned | |
| IsPinSet | Format: Y/N | Not returned | Returned | |
| IsReceiveSms |
Format options: Enabled (the cardholder has requested to receive an SMS for transactions and therefore he get SMS's) Disabled (the cardholder has requested to not receive an SMS for transactions and therefore he does not get SMS's) Blank (the cardholder has not requested to receive an SMS for transactions and therefore he does not get SMS's) Mail (the cardholder has requested to receive an mail for transactions and therefore he get mails)
Description:Defines if the cardholder gets an SMS/Mail.
| Not returned | Returned | |
| IsRegistered | Format: Y/N | Not returned | Returned | |
| IsRetailCard |
Format: Y/N Description: Indicates whether the card is part of a retail pack and is it a retail card
| Not returned | Returned | |
| IssueDate | Format: YYYY-MM-DD HH:MM:SS.M | Not returned | Returned | |
| IssuerName | Format: Alphanumeric, 30 | Not returned | Returned | |
| IssuerUser | Format: Alphanumeric, 6-30 | Not returned | Returned | |
| IsVerified | Format: Y/N | Not returned | Returned | |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | |
| MaxDeclinedTxnsReached | Format: Y/N | Not returned | Returned | |
| MaxPinRetiresReached | Format: Y/N | Not returned | Returned | |
| MCC | Format: Alphanumeric, 4 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| MCCDescription | | Not returned | Returned | |
| MiddleInitial |
Format: Alpha,1 Description: Middle name char of the cardholder.
| Not returned | Returned | |
| MobilePhone |
Format: Numeric, 6-15 Description: Mobile phone for getting SMS (see IsReceiveSms).
| Not returned | Returned | |
| NextPosition | Format: Numeric, 2 | Not returned | Returned | |
| Phone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | |
| PINTriesExceeded | Format: Y/N | Not returned | Returned | |
| PostedBalance | Format: Numeric, 11 (balance after transaction was done, before fees were taken) | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| PrimaryVerificationUploadedDocuments |
The number of uploaded primary verification documents. Format: numeric,2
| Not returned | Returned | |
| 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 | |
| ProgramType | Format: Saving/Commercial/GPR | Not returned | Returned | |
| PTExpirationDate | Format: MMYY | Not returned | Returned | |
| ReplacementMessageType |
Format options: ToBeReplacedInAnotherBankForVerifiedCH ToBeReplacedInAnotherBankForRNVCH PTExpirationDate CardExpirationDate ReplacementCardOrderedFromAnotherBank ReplacementCardOrderedFromSameBank ReplacedAnotherCardInAnotherBank
| Not returned | Returned | |
| ReplacementStatus |
| Not returned | Returned | |
| ResponseType | Format: approved/declined | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| RPID | Format: Numeric, 1-19 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| SecondaryVerificationUploadedDocuments |
The number of uploaded secondary verification documents. Format: numeric,2
| Not returned | Returned | |
| ServiceId |
Format: Exact 17 chars. Description: A unique identifier which represents a transaction in the Praxell system.
| Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| ShippingAddressLine1 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | |
| ShippingAddressLine2 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | |
| ShippingCity |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,
| Not returned | Returned | |
| ShippingState | Format: Alphanumeric, 2 | Not returned | Returned | |
| ShippingZIP | Format: Numeric, 5 | Not returned | Returned | |
| State | Format: Alphanumeric, 2 | Not returned | Returned | |
| StatusReasonCode |
| Not returned | Returned | |
| 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 | |
| TCFileName | Format: Alphanumeric, 120, including characters "/" , ":" , "." , "" | Not returned | Returned | |
| TermAddress | Format: Alphanumeric, 30 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermCity | Format: Alphanumeric, 25 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermCountry | Format: Alphanumeric, 3 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermNameLocation | Format: Alphanumeric, 25 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermOwner | Format: Alphanumeric, 25 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermState | Format: Alphanumeric, 3 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermZIP | Format: Alphanumeric, 10 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| Time | Format: HH:MM:SS | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TotalTransactionNumber | Format: Numeric, 2 | Not returned | Returned | |
| TransactionCode | Format: Alphanumeric, 6 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TransactionDescription | Format: Alphanumeric, 100 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TransactionId | Format: Alphanumeric, 50 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TransactionNumber | Format: Numeric, 2 | Not returned | Returned | |
| TransactionOrigin | Format: Alphanumeric, 1 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TransactionType |
Format: List of values: Credit, Debit, Auth, Info Description: provide the type of the transaction
| Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TxnAmount | Format: Numeric, 11 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| UniqueRequestId | Format: Alphanumeric, 30 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| Zip | Format: Numeric, 5 | Not returned | Returned | |
## XML Samples
### Input XML
```json
FB_FMI_TSRG_KS011q2w3e4r;
GetCardReportExtAPI12345678901234562008-04-302008-06-0640ASC
```
```json
GetCardReport388002042009420720StatusOKNA2009-07-28 04:42:223880020420094207299900000002902011-03-2403120865April 2013gdxfxvxvcxvcxMA19999990000000290V-PNScardholder usernameIssuingBanktest900MB789123456OvxvcxUSACT1980-01-01100000000000DLgfdgd@gffgfdg.fgd0413testSearchtestSearch0NYY2006-04-27 15:20:19.0StoreYcardholdersNNa1235432543253N0Progreso Prepaid MasterCard (408) Flag - Sp0CO823535445340.00121212121212121301111USD09/04/2008DepositDeposit - ProgMngr (Oregon, TX)NA18201820approved1111111111111111110Address..OregonUSNAProgMngrTX12345XP29DSRetail Reload0PCredit012121212121212130.00121212121212121301111USD09/04/2008DepositDeposit - ProgMngr (Oregon, TX)NA1808approved1111111111111111110OregonUSNAProgMngrTXPP87DSPIN Purchase0PDebit01212121212121213
```
```json
GetCardReport0707161220073710570008InvalidIssuerInvalidIssuer2021-10-01 12:37:5007071612200737105
```
# Get Cards Report
## Get Cards Report
The Get CardS Report API produces the relevant response, including card general details and a list of transactions.
There is a possibility to get the results in paging mode (used mainly for UI). When using paging, NextPosition will return the number of the first transaction on the next page. For example: in case and Count=5 , first Get Card Report call will return 5 first transaction and NextPosition=5 (0 based). there is a need to send this value for the second Get Card Report call.
Specific information regarding paging mode used with GetHolds=Y:
1. Holds returns ONLY for the first result set (position =0) and ALL holds are always returns independent of the Count value provided.
2. If first result set contains holds, at least 1 transaction will be returned in addition to holds.
3. If first result set contains holds, TransactionNumber parameter will return results size minus holds count (at least 1 transaction will be returned).
## Input Parameters:
| Name | Required | Definition | Comments |
| --------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| CardNumber | C | Format: Numeric, 16 | Mutually exclusive with ID. Deprecated (use ID/ID Type) |
| Count | N |
Format: Numeric 1-100 Description: Number of transactions to be retrieved. Used for pagination & better use of server resources.
| |
| CountMaxHoldsToReturn | N |
Format: Numeric, 3, By default 0 Description: Define the maximum of holds to be returned by API in case and GetHolds=Y.
| |
| FromDate | N |
Format: YYYY-MM-DD Description: The default value is Today's date
| |
| GetHolds | N |
Format: N(default)/Y Description: GetCardReport API provides (among other transactions) the list of authorizations & purchases done by the cardholder.
Every authorization may be a Hold. The Get Card Report will return these authorizations as well (if not filtered out) but without hold information as hold expiration date.
In order to be able to get only the active holds, it is possible to define the relevant Get Card Report API’ parameter GetHolds as Y. Then, the Get Card Report API will provide all active holds. When a hold has expired the API response will no longer list that hold. Holds will be returned with Praxell code containing “P85” (PP85DS).
In order to avoid showing “pending transactions” twice (as authorization and as hold), it is possible to filter out authorization Praxell codes and to get holds. In this way, the cardholder see his pending transactions (holds) and his settlements (non-authorization transactions)
| if GetLinkedCardsHistory=Y and GetHolds=Y, the holds will be returned for the default account' current card |
| GetLinkedCardsHistory | N |
Format: N(default)/ Description: If provided Y, this will return the details of all historical cards linked to the card holder and gives you the ability to see if any new replacement cards have been issued. Y
| Return history of all cards linked to the required card |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| Mutually exclusive with CardNumber. Required if IDType is provided |
| IDType | C |
Format options: CardNumber RPID SavingAccount
| relevant only for ID parameter |
| Order | N |
Format: Closed list of values. ASC DESC Description: Indicates whether the query should be executed in ascending or descending order (Date is the order field).
| |
| Position | N |
Format: Numeric, 1-4, >0 Description: Number of position in list of values\records. For example, if Position=30 and Count=5, then the Response Transaction List begins with top (30+5) transactions. In the XML Response only records 31, 32, 33, 34 and 35 from that Transaction List are included. Default 0.
| |
| ResponseType | N |
Format: Closed list of values. All (default) Trx Details BalanceOnly Description: Operation response type
| |
| SearchText | N |
Format: Alphanumeric, 1-30 Description: Text to search.
| |
| ToDate | N |
Format: YYYY-MM-DD Description: the date should be after FromDate
| |
| TransactionCodes | C |
Format: 6 characters Description:List of Praxell codes. Each Praxell code is 6 characters. Filter list of required transaction codes to filter by: Praxell code, Praxell Code, etc or PP0DS, PP01DS, etc.
| |
| TransactionsCodeGroup | O | Format: Praxell code group name (e.g. PINSuspiciousTransactions, CHTXN (used by GetCardDetails, CHP, IVR Interface), Savings (used by CHP, IVR Interface for savings statement))Allow to return of transactions with Praxell codes belong to this group | |
| TransactionCodesMode | C |
Format: Included /Excluded Description: Requires TransactionCodes parameter
Format: Alphanumeric, 17 Description: Processor Account Number
| Not returned | Returned | |
| ActivationDate | Format: YYYY-MM-DD | Not returned | Returned | |
| ActiveHoldsNumber |
Format: Numeric, 11 Description:Number of active holds existing for Cardholder
| Not returned | Returned | |
| ActiveHoldsTotalAmount |
Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder
| Not returned | Returned | |
| ActiveHoldsUnreturnedNumber |
Format: Numeric, 2 Description: Total amount of all active holds which have not be returned for Cardholder
| Not returned | Returned | |
| ActualExpirationDate |
Format: Alphanumeric, 12, Month YYYY Description: example, April 2013
| Not returned | Returned | |
| AddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | |
| AddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | |
| Amount |
Format: Numeric, 1-9 Description: The amount is in cents.
| Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| ApprovalCode | Format:Alphanumeric, 8 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| AvailableBalance | Format: Numeric, 11 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| Brand | Format: Alpha, 1-120 | Not returned | Returned | |
| CardAssociation |
Format options: Visa MasterCard Star
| Not returned | Returned | |
| CardAvailableBalance | Format: Numeric, 11 | Not returned | Returned | |
| CardBalance | Format: Numeric, 11 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| CardDDA | Format: Numeric, 3-16 | Not returned | Returned | |
| CardHolderState |
Format options: V V-PNS RNV NRNV
| Not returned | Returned | |
| CardholderUserName | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | |
| CardIssuingBank | Format: Alphanumeric, 30 | Not returned | Returned | |
| CardIssuingBankCode | Format: Alphanumeric, 5 | Not returned | Returned | |
| CardIssuingBankRoutingNumber | Format: Alphanumeric, 9 | Not returned | Returned | |
| CardNumber |
| Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| CardStatus | Format Options: O (Open, for ACT and SPND card statuses), C (Close, for all other card statuses) | Not returned | Returned | |
| CardType |
Format: Primary/Secondary (field called CardType in APIs)
| Not returned | Returned | |
| City | Format: Alphanumeric, 20 | Not returned | Returned | |
| Country |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| Not returned | Returned | |
| Currency | Format: Alphanumeric, 3 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| CurrentStatus |
Format options: CII LOCKED\_CII LOCK ACT SPND LST STLN CC
| Not returned | Returned | |
| Date | Format: YYYY-MM-DD | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| DateOfBirth |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| Not returned | Returned | |
| Description | Format: Alphanumeric, 1-30 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| DisplayDescription | Format: Alphanumeric, 200 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| DocId |
Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)
| Not returned | Returned | |
| 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 | |
| Email |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| Not returned | Returned | |
| ExpirationDate | Format: MMYY | Not returned | Returned | |
| Fax |
Format: Numeric, 6-10 Description: the fax number.
| Not returned | Returned | |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | |
| HoldsBalance | Format: Numeric, 11 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| HoldExpirationDate |
Format: MM-DD-YYYY Description: The date the holds expired
| Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| InvalidPINAttempts | Format: Numeric, 2 | Not returned | Returned | |
| IsPinSet | Format: Y/N | Not returned | Returned | |
| IsReceiveSms |
Format options: Enabled (the cardholder has requested to receive an SMS for transactions and therefore he get SMS's) Disabled (the cardholder has requested to not receive an SMS for transactions and therefore he does not get SMS's) Blank (the cardholder has not requested to receive an SMS for transactions and therefore he does not get SMS's) Mail (the cardholder has requested to receive an mail for transactions and therefore he get mails)
Description:Defines if the cardholder gets an SMS/Mail.
| Not returned | Returned | |
| IsRegistered | Format: Y/N | Not returned | Returned | |
| IsRetailCard |
Format: Y/N Description: Indicates whether the card is part of a retail pack and is it a retail card
| Not returned | Returned | |
| IssueDate | Format: YYYY-MM-DD HH:MM:SS.M | Not returned | Returned | |
| IssuerName | Format: Alphanumeric, 30 | Not returned | Returned | |
| IssuerUser | Format: Alphanumeric, 6-30 | Not returned | Returned | |
| IsVerified | Format: Y/N | Not returned | Returned | |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | |
| MaxDeclinedTxnsReached | Format: Y/N | Not returned | Returned | |
| MaxPinRetiresReached | Format: Y/N | Not returned | Returned | |
| MCC | Format: Alphanumeric, 4 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| MCCDescription | | Not returned | Returned | |
| MiddleInitial |
Format: Alpha,1 Description: Middle name char of the cardholder.
| Not returned | Returned | |
| MobilePhone |
Format: Numeric, 6-15 Description: Mobile phone for getting SMS (see IsReceiveSms).
| Not returned | Returned | |
| NextPosition | Format: Numeric, 2 | Not returned | Returned | |
| Phone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | |
| PINTriesExceeded | Format: Y/N | Not returned | Returned | |
| PostedBalance | Format: Numeric, 11 (balance after transaction was done, before fees were taken) | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| PrimaryVerificationUploadedDocuments |
The number of uploaded primary verification documents. Format: numeric,2
| Not returned | Returned | |
| 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 | |
| ProgramType | Format: Saving/Commercial/GPR | Not returned | Returned | |
| PTExpirationDate | Format: MMYY | Not returned | Returned | |
| ReplacementMessageType |
Format options: ToBeReplacedInAnotherBankForVerifiedCH ToBeReplacedInAnotherBankForRNVCH PTExpirationDate CardExpirationDate ReplacementCardOrderedFromAnotherBank ReplacementCardOrderedFromSameBank ReplacedAnotherCardInAnotherBank
| Not returned | Returned | |
| ReplacementStatus |
| Not returned | Returned | |
| ResponseType | Format: approved/declined | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| RPID | Format: Numeric, 1-19 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| SecondaryVerificationUploadedDocuments |
The number of uploaded secondary verification documents. Format: numeric,2
| Not returned | Returned | |
| ServiceId |
Format: Exact 17 chars. Description: A unique identifier which represents a transaction in the Praxell system.
| Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| ShippingAddressLine1 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | |
| ShippingAddressLine2 |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| Not returned | Returned | |
| ShippingCity |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,
| Not returned | Returned | |
| ShippingState | Format: Alphanumeric, 2 | Not returned | Returned | |
| ShippingZIP | Format: Numeric, 5 | Not returned | Returned | |
| State | Format: Alphanumeric, 2 | Not returned | Returned | |
| StatusReasonCode |
| Not returned | Returned | |
| 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 | |
| TCFileName | Format: Alphanumeric, 120, including characters "/" , ":" , "." , "" | Not returned | Returned | |
| TermAddress | Format: Alphanumeric, 30 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermCity | Format: Alphanumeric, 25 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermCountry | Format: Alphanumeric, 3 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermNameLocation | Format: Alphanumeric, 25 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermOwner | Format: Alphanumeric, 25 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermState | Format: Alphanumeric, 3 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TermZIP | Format: Alphanumeric, 10 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| Time | Format: HH:MM:SS | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TotalTransactionNumber | Format: Numeric, 2 | Not returned | Returned | |
| TransactionCode | Format: Alphanumeric, 6 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TransactionDescription | Format: Alphanumeric, 100 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TransactionId | Format: Alphanumeric, 50 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TransactionNumber | Format: Numeric, 2 | Not returned | Returned | |
| TransactionOrigin | Format: Alphanumeric, 1 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TransactionType |
Format: List of values: Credit, Debit, Auth, Info Description: provide the type of the transaction
| Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| TxnAmount | Format: Numeric, 11 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| UniqueRequestId | Format: Alphanumeric, 30 | Not returned | Returned | Returned as part of TransactionList/Transaction tag |
| Zip | Format: Numeric, 5 | Not returned | Returned | |
## XML Samples
### Input XML
```json
FB_FMI_TSRG_KS011q2w3e4r;
GetCardReportExtAPI12345678901234562008-04-302008-06-0640ASC
```
```json
GetCardReport388002042009420720StatusOKNA2009-07-28 04:42:2238800204200942072118845747801234569JaneDoeSPNDOtherGPR873821512345602025-03-24 11:40:53.0478012345692024-12-12 13:40:24.0389912345682024-07-25 19:34:17.0571512345672020-01-30 11:59:08.099900000002902011-03-2403120865April 2013gdxfxvxvcxvcxMA19999990000000290V-PNScardholder usernameIssuingBanktest900MB789123456OvxvcxUSACT1980-01-01100000000000DLgfdgd@gffgfdg.fgd0413testSearchtestSearch0NYY2006-04-27 15:20:19.0StoreYcardholdersNNa1235432543253N0Progreso Prepaid MasterCard (408) Flag - Sp0CO823535445340.00121212121212121301111USD09/04/2008DepositDeposit - ProgMngr (Oregon, TX)NA18201820approved1111111111111111110Address..OregonUSNAProgMngrTX12345XP29DSRetail Reload0PCredit012121212121212130.00121212121212121301111USD09/04/2008DepositDeposit - ProgMngr (Oregon, TX)NA1808approved1111111111111111110OregonUSNAProgMngrTXPP87DSPIN Purchase0PDebit01212121212121213
```
```json
GetCardReport0707161220073710570008InvalidIssuerInvalidIssuer2021-10-01 12:37:5007071612200737105
```
# Get Card Text Info
## Get Card Text Info
The Get Card Text Info API provides all required information which is for the two-way SMS messaging in the Praxell product.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| MobilePhone | Y |
Format: Numeric, 6-15 Description: Mobile phone for getting SMS (see IsReceiveSms).
| |
| RequestedInfo | Y |
Format: String, 50 Description: List of actions available for two way SMS. List of options: "BAL", "LAST", "" \[Numeric 6 digits], "PEND", "ENR", "RMV", "STA", "HELP"
| |
## Output Parameters:
## XML Samples
### Input XML
```json
test_pmtest_pm;
GetCardTextInfo1212121212121213ExtAPI1234567890BAL
```
```json
GetCardTextInfo379966062008180940StatusOKNA2008-09-21 06:18:4737996606200818094
```
```json
GetCardTextInfo0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Inform Lost Stolen Card
## Inform Lost Stolen Card
The Inform Lost Stolen Card API allows informing a lost or stolen card, and optionally request replacement card.
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| CardNumber | C | Format: Numeric, 16 | Deprecated. Will be removed in the future |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | C |
Format options: CardNumber RPID SavingAccount
| |
| Category | Y |
Format: Lost Stolen (not available for CFF Status)
| |
| CreateReplacement | Y |
Format: Y/N Description:(for future use)
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| --------------------- | ------------------- | ------------ | ------------ | -------- |
| AvailableBalance | Format: Numeric, 11 | Not returned | Returned | |
| ReplacementCardNumber | Format: Numeric, 16 | Not returned | Returned | |
## XML Samples
### Input XML
```json
;
4017639InformLostStolenCardExtAPILostN
```
```json
InformLostStolenCard143513102007551200StatusOKNA2007-12-13 10:55:02143513102007551201999
```
```json
InformLostStolenCard0707161220073710570008InvalidIssuerInvalidIssuer2021-10-01 12:37:5007071612200737105
```
# Load Network Verify Card
## Load Network Verify Card
The Load Network Verify Card API verifies card status and cardholder state, and returns information on card and cardholder.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| Amount | Y |
Format: Numeric, 1-9 Description: The amount is in cents.
| |
| AmountVerificationMode | N | Options: VerifyAmountParameter, ReturnedAllowedAmount (default) | |
| CardNumber | Y | Format: Numeric, 16 | |
| LoadNetwork | Y |
Format options: ACH (Automated Clearing House) IAT (International ACH Transaction) GD (Green Dot) PRX (Praxell) WU (Western Union)
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------- |
| Address | Format: Alphanumeric, 30 | Not returned | Returned | |
| CardNumber |
| Not returned | Returned | |
| City | Format: Alphanumeric, 20 | Not returned | Returned | |
| Country |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| Not returned | Returned | |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | |
| MaxCurrentLoadingAmount |
Format: Numeric, 1-20 Description: Maximum amount currently allowed to be loaded on card (based on balance and on maximum loading definitions).
| Not returned | Returned | |
| Phone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | |
| RPID | Format: Numeric, 1-19 | Not returned | Returned | |
| State | Format: Alphanumeric, 2 | Not returned | Returned | |
| Zip | Format: Numeric, 5 | Not returned | Returned | |
## XML Samples
### Input XML
```json
;
LoadNetworkVerifyCard1212121212121213ExtAPIWU
```
```json
LoadNetworkVerifyCard384997062009560740StatusOKNA2009-07-13 06:56:4238499706200956074jgffhfgfhgf
gdxfxvx vcxvcx
vxvcxCO353544534235432543253US8001
```
```json
LoadNetworkVerifyCard0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Lock Card
## Lock Card
The Lock Card API moves a card from ACT/SPND to LOCK.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| CardNumber | C | Format: Numeric, 16 | Deprecated. Will be removed in the future |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | C |
Format options: CardNumber RPID SavingAccount
| |
## Output Parameters:
## XML Samples
### Input XML
```json
test_csrpmtest_csrpm;
LockCard1212121212121213ExtAPI
```
```json
LockCard052006370227060281520StatusOKNA2007-05-27 06:17:5405200637022706028152
```
```json
LockCard0707161220073710570000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Reopen Card
## Reopen Card
The Reopen Card API allows reopening a card.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| CardNumber | C | Format: Numeric, 16 | Deprecated. Will be removed in the future |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | C |
Format options: CardNumber RPID SavingAccount
| |
## Output Parameters:
## XML Samples
### Input XML
```json
;
1754736ReopenCardExtAPIxxxRPID
```
```json
ReopenCard052006370227060281520StatusOKNA2007-05-27 06:17:5405200637022706028152
```
```json
ReopenCard0707161220073710570000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Request OTP
The **Request OTP** API is used to request access to sensitive information. Calling this endpoint triggers a One‑Time Password (OTP) that is delivered to the cardholder via SMS. The OTP must be supplied on a subsequent **Verify OTP** request.
> **NOTE:** An SMS message is always sent to the cardholder’s registered mobile number. If an email address is on file and email OTP is enabled, the OTP will also be sent to the registered email address.
***
## ✍️ Authentication Methods
Exactly **one** of the following authentication schemes must be supplied in the `` block.
| Scheme | Field | Format | Required | Notes |
| -------------------- | ------------------------------------------- | ------------------ | -------- | -------------------------------------------------- |
| **Card Credentials** | `AuthCardNumber` | PAN (16–19 digits) | ✓ | |
| | `AuthExpirationDate` | `YYYY‑MM` | ✓ | |
| | `AuthDOB` | `YYYY‑MM‑DD` | ✓ | Date of birth on file |
| **Cardholder Login** | `Username` | String | ✓\* | Use if the cardholder has self‑service credentials |
| | `Password` | String | ✓\* | |
| | \*Only required when using the Login scheme | | | |
***
### 📥 Input Parameters
| Name | Required | Definition | Comments |
| ----------------- | -------- | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `Purpose` | Y |
String (≤50) Allowed value: Dispute Management
| |
| `ID` | Y |
Numeric (1‑19) RPID when IDType = RPID
| |
| `IDType` | Y | `CardNumber` \| `RPID` \| `SavingAccount` | **Avoid** `CardNumber` here to prevent unencrypted storage |
| `RequestedResult` | Y |
| |
### 💻 Output Parameters
| Name | Definition | Failure Case | Success Case | Comments |
| ------ | ---------- | ------------ | ------------ | -------------------------------------------------- |
| *None* | | | | All values are returned inside `` |
***
## 📄 XML Samples
### Card‑Credentials Authentication
```xml
*******************2028-031996-11-289633-6955-1RequestOTPExtAPIDispute Management1234565789RPIDChangeCardPin
```
```xml
RequestOTP380973172011100640StatusOKOK2025-05-29 05:10:4038097317201110064
```
```xml
RequestOTP0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2025-05-29 05:12:5007071612200737105
```
### Login‑Credentials Authentication (alternative)
```xml
jane.doeAq1!xyz123984653217RequestOTPExtAPIDispute Management1234567890RPIDChangeCardPin
```
***
ℹ️ Use the returned **SessionId** when calling **VerifyOTP**. The OTP expires after 10 minutes.
For additional error codes see the *Common Errors* section of the API reference.
# Research Card
## Research Card
The Research Card API gets details on the card.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------- | -------- |
| CardNumber | C | Format: Numeric, 16 | |
| OperationType | Y |
Format options: RPID Blank Description: if RPID, RPID is required. If blank, CardNumber is required.
| |
| RPID | C | Format: Numeric, 1-19 | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------- |
| C-B-B | Format: Alphanumeric, “5-2-2” | Not returned | Returned | |
| 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 | |
| CardHolderState |
Format options: V V-PNS RNV NRNV
| Not returned | Returned | |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | |
| ExpirationDate | Format: MMYY | Not returned | Returned | |
| ExpectedACHTransactionDate | Format: YYYY-MM-DD | Not returned | Returned | Future |
| ExpectedACHTransactionType | Format: Options: FBE, ACH | Not returned | Returned | Future |
| ExpectedACHTransactionDescription |
Format: If ExpectedACHTransactionType=FBE, show relevant "BenefitType" If ExpectedACHTransactionType=ACH, show relevant "ACHCompanyName (ACHCompanyDescription)"
| Not returned | Returned | Future |
| ExpectedACHTransactionAmount | Format: Numeric, 11 | Not returned | Returned | Future |
| LastNetworkTransactionDate | Format: YYYY-MM-DD | Not returned | Returned | Future |
| LastNetworkTransactionDescription | Format: Alphanumeric,100 | Not returned | Returned | Future |
| LastNetworkTransactionAmount | Format: Numeric, 11 | Not returned | Returned | Future |
| LastPraxellTransactionDate | Format: YYYY-MM-DD | Not returned | Returned | Future |
| LastPraxellTransactionDescription | Format: Alphanumeric,100 | Not returned | Returned | Future |
| LastPraxellTransactionAmount | Format: Numeric, 11 | Not returned | Returned | Future |
| LastProcessorTransactionDate | Format: YYYY-MM-DD | Not returned | Returned | Future |
| ProcessorCardStatus |
Format options: a. 7(Card Activation) b. 1(Active) c. 9(Closed) d. 4(Warm Card) e. 2(Hot)
| Not returned | Returned | |
| ProcessorPINFailuresCount | Format: Alphanumeric, 3 | Not returned | Returned | |
| ProcessorDeclinedTransactionCount | Format: Alphanumeric, 5 | Not returned | Returned | |
| ProductType | Format: Alphanumeric, 120 | Not returned | Returned | |
| RPID | Format: Numeric, 1-19 | Not returned | Returned | |
| ValidPraxellStatuses | Format: Alphanumeric, 50 | Not returned | Returned | |
## XML Samples
### Input XML
```json
test_csrtest_csr;
ResearchCard1212121212121213ExtAPICardNumber
```
```json
ResearchCard380347072009170530StatusOKNA2009-05-05 07:17:3738034707200917053DevOnlyACTV99999999999980370-0-005101(Active)002008-01-02ACTStore
```
```json
ResearchCard0707161220073710570008InvalidIssuerInvalidIssuer2021-10-01 12:37:5007071612200737105
```
# Reset Card PIN
## Reset Card PIN
The Reset Card PIN API resets the card PIN.
*Beginning on 10/15/2023, The ResetCardPIN API has been enhanced to accept RPID in addition to the standard CardNumber. While the API traditionally requires CardNumber, it now accommodates an alternative identifier: by including the IDType, you can specify RPID to utilize RPID for identification within the API.*
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| CardNumber | Y | Format: Numeric, 16 | |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | Y |
Format options: CardNumber RPID SavingAccount
| |
## Output Parameters:
## XML Samples
### Input XML
```json
;
2371831ResetCardPINExtAPI9800267072RPID
```
```json
ResetCardPIN298367102008260300StatusOKNA2008-03-11 10:26:0329836710200826030
```
```json
ResetCardPIN0707161220073710570000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Return To Inventory
## Return To Inventory
The Return To Inventory API allows "fixing" a card that was spoiled in the inventory (which means its status changed to SPLT), this API will set its status to CII (Card In Inventory) and will allow using it again.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------- | -------- |
| RetailPackId | C |
Format: RPID CARD Description: Type of transaction for charge fee
| |
## Output Parameters:
## XML Samples
### Input XML
```json
test_pmtest_pm;
ReturnToInventory1212121212121213ExtAPIRPID9999999999998036
```
```json
ReturnToInventory052006370227060281520StatusOKNA2007-05-27 06:17:5405200637022706028152
```
```json
ReturnToInventory0707161220073710570000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Search Cardholder
## Search Cardholder
The Search Cardholder API produces a list of cardholder matching the search criteria, including card details.
The FirstName and LastName parameters are converted based on the following rules: i. All \* characters are replaced with % ii. All ? characters are replaced with \_ iii. All characters that are NOT a-zA-Z0-9\_% are removed
## Input Parameters:
| Name | Required | Definition | Comments |
| --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| CardNumber | C | Format: Numeric, 4 | relevant only if Indicator Type=CardPT or CardDOB or NameCard or CardDocID or CardDist |
| DateOfBirth | C |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| relevant only if Indicator Type=CardDOB or DocIdDOB or NameDOB |
| DistributorName | C | Format: Alphanumeric, 1-30 | relevant only if Indicator Type=NameDist or CardDocID or CardDist |
| DocId | C | Format: Alphanumeric, 4 | relevant only if Indicator Type=DocIdDOB |
| FirstName | C | Format: Alphanumeric and \* , 2-20 | relevant only if Indicator Type=NameDOB or NameCard or NameDist |
| IndicatorType | Y |
Format: DocIdDOB – allow to search cardholder by DocId & Date of Birth fields NameDOB – allow to search cardholder by First Name or Last Name & Date of Birth fields CardDOB – allow to search cardholder by CardNumber & Date of Birth fields CardPT – allow to search cardholder by CardNumber & PT fields NameCard - allow to search cardholder by First Name or Last Name & card (4 last) fields NameDist - allow to search cardholder by First Name or Last Name & Dist fields CardDocID - - allow to search cardholder by card (last 4) & DocID (last 4) fields CardDist - allow to search cardholder by card (last 4) & Dist fields
Description: Provide indication on which of the multiple options to execute
| |
| LastName | C | Format: Alphanumeric and \* , 2-20 | relevant only if Indicator Type=NameDOB or NameCard or NameDist |
| PT | C | Format: Alphanumeric, 30 | relevant only if Indicator Type=CardPT |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ------------------------------------------------ |
| AddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| AddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| CardBalance | Format: Numeric, 11 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| CardExpirationDate | Format: MMDD | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| CHState |
Format options: NRNV RNV V-PNS V
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| City | Format: Alphanumeric, 20 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| Country |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| CurrentStatus |
Format options: CII LOCKED\_CII LOCK ACT SPND LST STLN CC
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| DateOfBirth |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| DocId | Format: Alphanumeric, 4 | Not returned | Returned | Returned as part of SearchResults/Cardholder 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 | Returned as part of SearchResults/Cardholder tag |
| Email |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| Fax |
Format: Numeric, 6-10 Description: the fax number.
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| MiddleInitial |
Format: Alpha,1 Description: Middle name char of the cardholder.
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| Phone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| PT | Format: Alphanumeric, 30 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| PTFriendlyName |
Format: Alphanumeric, 1-120 Description: Product Type known name.
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| State | Format: Alphanumeric, 2 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| Status |
Format: ACTIVE (default) ALL
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| StatusReasonCode |
| Not returned | Returned | Returned as part of SearchResults/Cardholder 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 | Returned as part of SearchResults/Cardholder tag |
| TotalRows | Format: Alphanumeric, 5 | Not returned | Returned | |
| Zip | Format: Numeric, 5 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
## XML Samples
### Input XML
```json
;
920994SearchCardholderExtAPINameDOB1980-01-01DanKraut
```
```json
SearchCardholder404337132009541110StatusOKNA2009-11-19 13:54:16404337132009541116testSearchacardholdersgdxfxvxvcxvcxvxvcxCO353544534US2354325432531980-01-01 00:00:00.0gfdgd@gffgfdg.fgd100000000000DLACTNA1020Progreso Prepaid MasterCard (408) Flag - SpV-PNStestSearchacardholdersvvvpppeeemnmnkdnmnmdkCO353544534US2354325432531980-01-01 00:00:00.0gfdgd@gffgfdg.fgd100000000000DLACTNA1020Progreso Prepaid MasterCard (408) Flag - SpV-PNS
```
```json
SearchCardholder0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Suspend Card
## Suspend Card
The Suspend Card API suspends a card.
*Beginning on 10/15/2023, The Suspend Card API has been enhanced to accept RPID in addition to the standard CardNumber. While the API traditionally requires CardNumber, it now accommodates an alternative identifier: by including the IDType, you can specify RPID to utilize RPID for identification within the API.*
## Input Parameters:
| Name | Required | Definition | Comments |
| -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| CardNumber | C | Format: Numeric, 16 | Deprecated. Will be removed in the future |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | C |
Format options: CardNumber RPID SavingAccount
| |
| Description | N | Format: Alphanumeric, 1-30 | |
| ReasonCode | Y |
Format options: 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
| |
| ReasonCodeType | C |
Format options: LN DefinitionViolation SystemViolation PeriodViolation BalanceViolation
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ---------------- | ------------------- | ------------ | ------------ | -------- |
| AvailableBalance | Format: Numeric, 11 | Not returned | Returned | |
## XML Samples
### Input XML
```json
test_pmtest_pm;
SuspendCard1212121212121213ExtAPILost
```
```json
SuspendCard052006370227060281520StatusOKNA2007-05-27 06:17:54052006370227060281521999
```
```json
SuspendCard0707161220073710570000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Swap Cards DDAs
## Swap Cards DDAs
The Swap Cards DDAs API allows swapping the DDAs (Direct Deposit Accounts) between a Suspend Card (with Stolen/Lost reason code) and another card. The DDAs are swapped and the card is moved to STLN/LST status.
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| CardNumber1 | C | Format: Numeric, 16 | |
| CardNumber2 | C | Format: Numeric, 16 | |
| FromID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| FromIDType | C |
Format options: CardNumber RPID SavingAccount
| |
| ToID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| ToIDType | C |
Format options: CardNumber RPID SavingAccount
| |
## Output Parameters:
## XML Samples
### Input XML
```json
st_managerst_manager;
;
SwapCardsDDAs1212121212121213ExtAPI
```
```json
SwapCardsDDAs734916092007421140StatusOKNA2007-11-25 09:42:4873491609200742114
```
```json
SwapCardsDDAs0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Unlock Card
## Unlock Card
The Unlock Card API moves a card from status LOCKED or LOCKED\_CII to ACT to CII respectively.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------- | -------- | ------------------- | -------- |
| CardNumber | Y | Format: Numeric, 16 | |
## Output Parameters:
## XML Samples
### Input XML
```json
test_csrpmtest_csrpm;
UnlockCard1212121212121213ExtAPI
```
```json
UnlockCard052006370227060281520StatusOKNA2007-05-27 06:17:5405200637022706028152
```
```json
UnlockCard0707161220073710570000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Unsuspend Card
## Unsuspend Card
The Unsuspend Card API moves a card from status SPND to ACT.
*Beginning on 10/15/2023, The Unsuspend Card API has been enhanced to accept RPID in addition to the standard CardNumber. While the API traditionally requires CardNumber, it now accommodates an alternative identifier: by including the IDType, you can specify RPID to utilize RPID for identification within the API.*
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| CardNumber | Y | Format: Numeric, 16 | |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | Y |
Format options: CardNumber RPID SavingAccount
| |
## Output Parameters:
## XML Samples
### Input XML
```json
Yair_CSR_PM;
UnsuspendCard789993ExtAPI9800267072RPID
```
```json
UnsuspendCardStatusNA
```
```json
UnsuspendCard0707161220073710570000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Update Card Holder Spend Limits
## Update Card Holder Spend Limits
The Update Card Holder Spend Limits API can be used to Update Spend Limits on a card.
## Input Parameters:
| Name | Required | Definition | Comments |
| ------ | -------- | -------------------------------- | -------- |
| ID | Y | Identifier for the service. | |
| IDType | Y | Type of identifier (e.g., RPID). | |
## Output Parameters:
| Name | Required | Definition | Comments |
| ----------------- | -------- | ------------------------------------- | --------------------------- |
| ServiceName | Y | Name of the service being requested. | |
| SessionId | Y | Unique identifier for the session. | |
| StatusCode | Y | Status code of the response. | |
| StatusName | Y | Status name of the response. | |
| StatusDescription | Y | Description of the status. | NA means Not Applicable |
| ServiceDate | Y | Date and time of the service request. | Format: YYYY-MM-DD HH:mm:ss |
| ServiceId | Y | Unique identifier for the service. | |
## XML Samples
### Input XML
```json
xxxxxxxxxxUpdateCardHolderSpendLimits{{$randomInt}}{{$randomInt}}{{$randomInt}}Chetan:PostmanxxxRPIDNNNNNNNNN0050011500105010005Y1240.11330.33Y1280.11330.33Y1310.11330.33Y1250.11330.33Y1320.11330.33Y1300.11330.33Y1290.11330.33Y1270.11330.33Y1330.11330.33Y1260.11330.33Y1340.11330.33Y1230.11330.33Y1220.11330.33Y1210.11330.33Y1200.11330.33Y1190.11330.33Y1180.11330.33Y1170.11330.33Y1160.11330.33Y1150.11330.33Y1140.11330.33Y1130.11330.33Y1110.11330.33Y1120.11330.33Y1090.11330.33Y1100.11330.33Y1080.11330.33Y1070.11330.33Y1060.11330.33Y1050.11330.33Y1040.11330.33Y1030.11330.33Y1020.11330.33Y1010.11330.33Y1000.11330.33N971.013.032.02N981.013.032.02N961.013.032.02N1351.013.032.02
```
```json
UpdateCardHolderSpendLimits708ae58c-0e27-495f-864e-51d34d9eddad0StatusOKNA2024-01-18 09:29:03708ae58c-0e27-495f-864e-51d34d9eddad
```
```json
1001Authentication FailureThe provided authentication details are invalid or missing.2024-01-18 10:15:30
```
# Update Card Replacement Status
## Update Card Replacement Status
The Update Card Replacement Status API allow to update the replacement status
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| Mutually exclusive with CardNumber. Required if IDType is provided |
| IDType | N |
| |
## Output Parameters:
## XML Samples
### Input XML
```json
Eyal_PM_QA1q2w3e4r;
UpdateCardReplacementStatus5543543534234235ExtAPI
```
```json
UpdateCardReplacementStatus388027132010410940StatusOKNA2010-09-05 13:41:4938802713201041094
```
```json
```
# Update Cardholder DOB
## Update Cardholder DOB
The Update Cardholder DOB API updates cardholder's Date Of Birth.
*Beginning on 10/15/2023, The Update Cardholder DOB API has been enhanced to accept RPID in addition to the standard CardNumber. While the API traditionally requires CardNumber, it now accommodates an alternative identifier: by including the IDType, you can specify RPID to utilize RPID for identification within the API.*
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| CardNumber | Y | Format: Numeric, 16 | |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | Y |
Format options: CardNumber RPID SavingAccount
| |
| CardNumber | Y | Format: Numeric, 16 | |
| ChallengeQuestionType | N | Field:TBD | |
| ChallengeAnswer | C | Field:TBD | |
| DateOfBirth | Y |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| |
| ForceUpdateWithoutVerification | N | Format: Y/N | Future |
| OOWAnswer | C | Field:TBD | |
| OOWQuestionType | N | Field:TBD | |
| ReturnOOWQuestions | N | Format: Y/N (N is default). | |
## Output Parameters:
## XML Samples
### Input XML
```json
MGR_PPM_QA1q2w3e4r;
UpdateCardholderDOB5465645ExtAPI9800267072RPID1980-01-01
```
```json
UpdateCardholderDOB052006370227060281520StatusOKNA2007-06-26 12:57:0164405512200757060
```
```json
UpdateCardholderDOB0707161220073710570008InvalidIssuerInvalidIssuer2021-10-01 12:37:5007071612200737105
```
# Update Cardholder
## Update Cardholder
The Update Cardholder API produces updates of cardholder details.
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| AddressLine1 | Y |
Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >
| |
| AddressLine2 | N |
Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >
| |
| CardAnniversaryDate | N | Format: YYYY-MM-DD | Future |
| CardNumber | Y | Format: Numeric, 16 | |
| City | Y |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period, &
| |
| Country | Y |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| |
| DateOfBirth | N |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| |
| DocExpirationDate | C |
Format: YYYY-MM-DD Description: must be after DocIssueDate. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| |
| DocId | N |
Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)
| |
| DocIssueDate | C |
Format: YYYY-MM-DD Description: must be before DocExpirationDate Conditional value required only when DocType is 'PASS' or 'MCN'
| |
| DocIssuer | C |
Format: Alphanumeric, 2 Description: Country/State code. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| |
| DocType | N |
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.
| |
| EarlyAccess | N | Format: Y/N | |
| Email | N |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| |
| Fax | N |
Format: Numeric, 6-10 Description: the fax number.
| |
| FirstName | Y |
Format: Alpha, 2-50 Can contains as well these special characters: /, -, space, comma, period, &
| |
| IsReceiveSms | N |
Format options: Enabled (the cardholder has requested to receive an SMS for transactions and therefore he get SMS's) Disabled (the cardholder has requested to not receive an SMS for transactions and therefore he does not get SMS's) Blank (the cardholder has not requested to receive an SMS for transactions and therefore he does not get SMS's) Mail (the cardholder has requested to receive an mail for transactions and therefore he get mails)
Description:Defines if the cardholder gets an SMS/Mail.
| |
| LastName | Y |
Format: Alpha, 2-50 Can contains as well these special characters: /, -, space, comma, period, &
| |
| MiddleInitial | N |
Format: Alpha,1 Description: Middle name char of the cardholder.
| |
| MobilePhone | Y |
Format: Numeric, 6-10 Description: Mobile Phone number
| |
| Phone | N |
Format: Numeric, 6-10 Description: Phone number
| |
| ShippingAddressLine1 | N |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| |
| ShippingAddressLine2 | N |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| |
| ShippingCity | N |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,
| |
| ShippingState | N | Format: Alphanumeric, 2 | |
| ShippingZIP | N | Format: Numeric, 5 | |
| State | Y | Format: Alphanumeric, 2 | |
| ShouldUpdateUserDefined | Y |
Format: Char (Y or N) Description: If you want to update field : Y If you don't want to update field : N
Format options: UpdateAndVerify (allowed only when doc id type= SSN) UpdateOnly NoUpdateOnVerificationError (allowed only when doc id type = SSN)
| |
| Zip | Y | Format: Numeric, 5 | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ---------- |
| VerificationID | Format: Alphanumeric, 50 | Not returned | Returned | |
| VerificationStatus |
Format options: VerifiedSSN VerifiedThirdParty VerifiedDocumentary VerifiedByIssuer SSNVerificationRequired DocumentaryVerificationRequired OOWVerificationRequired Blank
| Not returned | Returned | |
| VerificationAttempts | Format: Numeric, 2 | Not returned | Returned | |
| QuestionSequence | Format: Numeric, 1 | Not returned | Returned | Future Use |
| QuestionPrompt | Format: Alphanumeric, 255 | Not returned | Returned | Future Use |
| QuestionType | Format: Alphanumeric, 255 | Not returned | Returned | Future Use |
| AnswerOption | Format: Alphanumeric, 255 | Not returned | Returned | Future Use |
| OOWEligible | Format: Y/N | Not returned | Returned | Future Use |
| FreeTextErrors | Format: Alphanumeric, 255 | Not returned | Returned | |
| CardHolderState |
Format options: V V-PNS RNV NRNV
| Not returned | Returned | |
## XML Samples
### Input XML
```json
Eyal_PM_QA1q2w3e4r;
UpdateCardholder167565446597669ExtAPIdanaSdanaQuestionslalaACOAL12348US12345681234568sharon@gmail.comEnabled9729999994SSN1234567891944-01-20YUpdateAndVerify
```
```json
UpdateCardholder0StatusOKNA2007-05-27 06:17:5464303207200728062
```
```json
UpdateCardholder0707161220073710570008InvalidIssuerInvalidIssuer2021-10-01 12:37:5007071612200737105
```
# Update Fee Less Card
## Update Fee Less Card
The Update Fee Less Card API allows to turn the "Fee Less" indication on a card on or off. This is used primarily by Praxell Account managers on behalf of customers for turning on\off the benefit of no fees mainly on employee cards.
## Input Parameters:
| Name | Required | Definition | Comments |
| --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| IsFeeLess | Y |
Format: String, Y or N Description: Simple yes\no value indicator
| |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | C |
Format options: CardNumber RPID SavingAccount
| |
## Output Parameters:
## XML Samples
### Input XML
```json
test_csrpmtest_csrpm;
UpdateFeeLessCard1212121212121213ExtAPI
```
```json
UpdateFeeLessCard052006370227060281520StatusOKNA2007-05-27 06:17:5405200637022706028152
```
```json
UpdateFeeLessCard0707161220073710570008InvalidIssuerInvalidIssuer2021-10-01 12:37:5007071612200737105
```
# Verify Card PIN
## Verify Card PIN
The Verify Card PIN API verifies the card PIN.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------- | -------- | ------------------------------------------------------ | -------- |
| CardNumber | Y | Format: Numeric, 16 | |
| PIN | Y |
Format: Numeric, 4 Description: Private code
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ----------- | ----------- | ------------ | ------------ | -------- |
| PinVerified | Format: Y/N | Not returned | Returned | |
## XML Samples
### Input XML
```json
ZZ_QA_Test1_FBZ1q2w3e4r;
4384879VerifyCardPINExtAPI
```
```json
VerifyCardPIN298371102008370350StatusOKNA2008-03-11 10:37:5129837110200837035Y
```
```json
VerifyCardPIN0707161220073710570008InvalidIssuerInvalidIssuer2021-10-01 12:37:5007071612200737105
```
# Verify Cardholder
## Verify Cardholder
The Verify Cardholder API allows marking a cardholder as verified,just in Praxell, not making the verification in front of verification providers as a provider.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Answer | C | Format: Alphanumeric, 255 | part of OOW/OOWSet tag |
| Description | C | Format: 1-500, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) / : ? - % + \* | & ; @ ! \~ = \_ \ ' |
| FileName1 | C | Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! \~ = \_ ' | required & relevant only if VerificationType=VerifyManuallyByDocumentary or VerifyManuallyByThirdParty. If VerificationType=VerifyManuallyByDocumentary, the file content must be primary verification' FileCategory. If VerificationType=VerifyManuallyByThirdParty, the file content must be TP (Third Party) |
| FileName2 | C | Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! \~ = \_ ' | required & relevant only if VerificationType=VerifyManuallyByDocumentary. The file must be primary or secondary verification' FileCategory and must be different than FileName1 |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | Y |
Format options: CardNumber RPID SavingAccount
| |
| QuestionSequence | N | Format: Numeric, 1 | part of OOW/OOWSet tag |
| QuestionType | C | Format: Alphanumeric, 255 | part of OOW/OOWSet tag |
| VerificationDate | C | Format: YYYY-MM-DD | Description: Required field only if VerificationType=VerifyManuallyBySSN. Otherwise, the field cannot not be provided. Verification date <=Today |
| VerificationID | C | Format: Alphanumeric, 50 | Description: Required field only if VerificationType=VerifyManuallyBySSN or VerifyByOOWQuestionsReply. Otherwise, the field cannot not be provided |
| VerificationType | Y |
Format options: VerifyByCHDetails VerifyByOOWQuestionsReply VerifyManuallyByDocumentary VerifyManuallyByThirdParty VerifyManuallyBySSN (VerifiyByIssuer - future)
| Not returned | Returned | |
| OOWEligible | Format: Y/N | Not returned | Returned | |
| VerificationAttempts | Format: Numeric, 2 | Not returned | Returned | |
| VerificationID | Format: Alphanumeric, 50 | Not returned | Returned | |
| VerificationStatus |
Format options: VerifiedSSN VerifiedThirdParty VerifiedDocumentary VerifiedByIssuer SSNVerificationRequired DocumentaryVerificationRequired OOWVerificationRequired Blank
| Not returned | Returned | |
## XML Samples
### Input XML
```json
Eyal_PM_QA1q2w3e4r;
VerifyCardholder5543543534234235ExtAPICardNumberVerifyManuallyByDocumentaryvID1some.typesome answer
```
```json
VerifyCardholder388027132010410940StatusOKNA2010-09-05 13:41:49388027132010410949772761VerifiedSSN1NV
```
```json
VerifyCardholder0707161220073710570008InvalidIssuerInvalidIssuer2021-10-01 12:37:5007071612200737105
```
# Verify OTP
The **Verify OTP** API validates the One-Time Password previously generated by **Request OTP** and either returns the requested sensitive data **or** sets a new card PIN, depending on the original `RequestedResult`.
* **Retrieve data** – `RequestedResult` was `CardNumberCvv` or `ProcessorAccountNumber`.
* **Change PIN** – `RequestedResult` was `ChangeCardPin`; include `` in the request.
> **NOTE:** A valid `SessionId` from the successful **Request OTP** call is mandatory.
## 📥 Input Parameters
| Name | Required | Definition | Comments |
| -------- | -------- | ----------------------------------------------------------------------- | --------------------------------------------------- |
| `Token` | Y |
Numeric (6) Six-digit OTP supplied by the cardholder
| Unique within the OTP validity window |
| `NewPin` | — |
Numeric (4) New PIN value
| **Required when** `RequestedResult = ChangeCardPin` |
## 💻 Output Parameters
| Name | Definition | Failure Case | Success Case | Comments |
| ----------------- | --------------------------------------------------------------- | ------------ | ------------------------ | ----------------------------------- |
| `RequestedResult` | One of: `CardNumber`, `ProcessorAccountNumber`, `ChangeCardPin` | — | Returned | Mirrors the original purpose |
| `RequestedValue` | Sensitive value corresponding to `RequestedResult` (e.g. PAN) | Not returned | Returned when applicable | Not present for PIN-change requests |
***
## 📄 XML Samples
### Retrieve Card Number (data access)
```xml
38097317201110064963369551VerifyOTPExtAPI123456
```
**Success response**
```xml
VerifyOTP380973172011100640StatusOKOK2025-05-29 05:20:4038097317201110064CardNumberCvv5434640304073511,123
```
### Change Card PIN
```xml
2a995fa8-7a61-4322-95da-1a85af108806875221VerifyOTPExtAPI9965223511
```
**Success response**
```xml
VerifyOTP2a995fa8-7a61-4322-95da-1a85af1088060StatusOKOK2025-05-29 05:22:06f0336c90-68e8-4981-9237-c7c289b64950ChangeCardPin
```
***
ℹ️ The OTP is valid for 10 minutes. A second failed attempt will invalidate the `SessionId`, requiring a new **Request OTP** cycle.
# Update Cardholder Data
## Update Cardholder
The Update Cardholder Data API produces updates of cardholder details capable of handling update partially and removing data by using `__EMPTY__` key word.
## :magic:Input Parameters:
| Name | Required | Definition | Condition | Comments | |
| -------------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ----------------------------------- | ----------------------------------- |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| | | |
| IDType | N |
Format options: CardNumber RPID
| | Default=CardNumber | |
| AddressLine1 | Y |
Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >
| | | |
| AddressLine2 | N |
Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >
| | | |
| City | Y |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period, &
| | | |
| Country | Y |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list. \[...]
| | | |
| DateOfBirth | N |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| | | |
| DocExpirationDate | C |
Format: YYYY-MM-DD Description: must be after DocIssueDate. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| | | |
| DocId | N |
Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)
| | | |
| DocIssueDate | C |
Format: YYYY-MM-DD Description: must be before DocExpirationDate Conditional value required only when DocType is 'PASS' or 'MCN'
| | | |
| DocIssuer | C |
Format: Alphanumeric, 2 Description: Country/State code. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| | | |
| DocType | N |
Format options: SSN PASS UDL MCN INMATE EIN Description: Closed list of values.Type of government identification document used: SSN- Social Security Number, PA\[...]
| | | |
| EarlyAccess | N | Format: Y/N | | | |
| Email | N |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| | | |
| Fax | N |
Format: Numeric, 6-10 Description: the fax number.
| | | |
| FirstName | Y |
Format: Alpha, 2-20 Can contains as well these special characters: /, -, space, comma, period, &
| | | |
| IsReceiveSms | N |
Format options: Enabled (the cardholder has requested to receive an SMS for transactions) Disabled (the cardholder has requested not to receive an SMS) Blank (the car\[...]
| | | |
| LastName | Y |
Format: Alpha, 2-20 Can contains as well these special characters: /, -, space, comma, period, &
| | | |
| MiddleInitial | N |
Format: Alpha,1 Description: Middle name char of the cardholder.
| | | |
| MobilePhone | Y |
Format: Numeric, 6-10 Description: Mobile Phone number
| | | |
| IntPhoneNumber | N |
International phone number Numeric with optional ("+") prefix Format: ^(?!+?0+$)+?\d{6,}$ Example: +972546644445
| | Can send `__EMPTY__` to reset value | |
| Phone | N |
Format: Numeric, 6-10 Description: Phone number
| | | |
| ShippingAddressLine1 | N |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| | | |
| ShippingAddressLine2 | N |
Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >
| | | |
| ShippingCity | N |
Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period
| | | |
| ShippingState | N | Format: Alphanumeric, 2 | | | |
| ShippingZIP | N | Format: Numeric, 5 | | | |
| State | Y | Format: Alphanumeric, 2 | | | |
| VerificationRequest | Y |
Format options: UpdateAndVerify (allowed only when doc id type= SSN) UpdateOnly NoUpdateOnVerificationError (allowed only when doc id type = SSN)
| | | |
| Zip | Y | Format: Numeric, 5 | | | |
| SubscribeToEmail | N |
Format: Y/N Options: Y - Yes, will send OTP in email N - No, will not send OTP in email Optional, Can be undefined Default: N
| | Can send `__EMPTY__` to reset value | |
| CardholderBankRouting | N | Format: Numeric, 9 | | Can send `__EMPTY__` to reset value | |
| ExtPaymentProviderFields | N |
Format: Alphanumeric, Date ^\[0-9A-Za-z /:.,+-]{0,30}$
| | Can send `__EMPTY__` to reset value | |
| IntAddressLine1 | C | Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, > | Must be supplied if IntAddress is Y (Yes) | Can send `__EMPTY__` to reset value | |
| IntCity | C | Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period, & | Must be supplied if IntAddress is Y (Yes) | Can send `__EMPTY__` to reset value | |
| IntCountry | C | Format: ISO Country code. Two characters. | Must be supplied if IntAddress is Y (Yes) | Can send `__EMPTY__` to reset value | |
| IntZipPostalCode | C | Format: Alphanumeric, 1-20 | Must be supplied if IntAddress is Y (Yes) | Can send `__EMPTY__` to reset value | |
| IntDocId | C | Format: Alphanumeric, 1-50 | Must be supplied if IntAddress is Y (Yes) | Can send `__EMPTY__` to reset value | |
| IntAddress | N | Format: Y/N (Default N) | | | |
| Language | N | | | Can send `__EMPTY__` to reset value | |
| MiddleName | N | | | Can send `__EMPTY__` to reset value | |
| SurName | N | | | Can send `__EMPTY__` to reset value | |
| AdditionalIDExpirationDate | N | | | Can send `__EMPTY__` to reset value | |
## :laptop-code:Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ---------- |
| VerificationID | Format: Alphanumeric, 50 | Not returned | Returned | |
| VerificationStatus |
Format options: VerifiedSSN VerifiedThirdParty VerifiedDocumentary VerifiedByIssuer SSNVerificationRequired DocumentaryVerificationRequired OOWVerificationRequired Blank
| Not returned | Returned | |
| VerificationAttempts | Format: Numeric, 2 | Not returned | Returned | |
| QuestionSequence | Format: Numeric, 1 | Not returned | Returned | Future Use |
| QuestionPrompt | Format: Alphanumeric, 255 | Not returned | Returned | Future Use |
| QuestionType | Format: Alphanumeric, 255 | Not returned | Returned | Future Use |
| AnswerOption | Format: Alphanumeric, 255 | Not returned | Returned | Future Use |
| OOWEligible | Format: Y/N | Not returned | Returned | Future Use |
| FreeTextErrors | Format: Alphanumeric, 255 | Not returned | Returned | |
| CardHolderState |
Format options: V V-PNS RNV NRNV
| Not returned | Returned | |
## XML Samples
### Input XML
```json
test_csrpmUpdateCardholderDatae461e304-ec98-43d0-9ff9-4544909f954aExtAPI9900001025RPIDTomer MadmonP.P 11234567892024/11/2656647747447__EMPTY____EMPTY____EMPTY__
Response:
UpdateCardholderData62b72256-e524-40a2-b7ce-33ca4a1988520StatusOKOK2026-02-17 08:39:3062b72256-e524-40a2-b7ce-33ca4a1988521
```
```json
Request:
test_csrpmUpdateCardholderDataf31c81d9-157b-41e1-ab3e-aab35cdb85ecExtAPI9900001025RPIDSMadmon
Response:
UpdateCardholderDatab3c41c7a-adb5-43b7-bdec-6004d2833ac670223UpdateCardholderFailedUpdate cardholder failure Err19: 40001 (Access denied.)2026-02-17 08:34:51b3c41c7a-adb5-43b7-bdec-6004d2833ac6
```
# Cardholder Management
# Change Cardholder Password
## Change Cardholder Password
The Change Cardholder Password API allows changing the cardholder password and returning the needed information for login logic.
## Input Parameters:
| Name | Required | Definition | Comments |
| --------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| 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).
Format: Alphanumeric, 20 Value can be multiple org\_id’s split by commas
| |
## Output Parameters:
| **Name** | **Definition** | **Failure Case** | **Success Case** | **Comments** |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [CardholderUserName](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | |
| [DefaultAccountID](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 20 | Not returned | Returned | |
| [DefaultAccountCardNumber](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 16 | Not returned | Returned | Returned in list of DefaultAccountCards/DefaultAccountCard which return all cards related to the default account |
| [DefaultAccountCardRPID](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 1-19 | Not returned | Returned | Returned in list of DefaultAccountCards/DefaultAccountCard which return all cards related to the default account |
| [LoginCardStatus](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
| Not returned | Returned | The status reason of the card provided in input parameter (before the API has run) |
| [AccountID](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
Format: Numeric, 20 Description: Praxell Account ID
| Not returned | Returned | Returned in list of Accounts (default account for [UserName](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) is saved in field [DefaultAccountID](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)) |
| [AccountCurrentCardNumber](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 16 | Not returned | Returned | Returned in list of Accounts |
| [AccountCurrentCardRPID](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 1-19 | Not returned | Returned | Returned in list of Accounts |
| [AccountCurrentCardFirstName](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 10 | Not returned | Returned | Returned in list of Accounts |
| [AccountCurrentCardLastName](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 15 | Not returned | Returned | Returned in list of Accounts |
| [ActivationDate](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: YYYY-MM-DD | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [ActiveHoldsNumber](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 30 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [AddressLine2](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 30 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [Brand](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alpha, 1-120 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [CardAvailableBalance](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 11 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [CardDDA](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 3-16 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [CardIssuingBank](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 30 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [CardIssuingBankCode](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 5 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [CardIssuingBankRoutingNumber](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 9 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [CardNumber](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 16 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [CardStatus](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | 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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
Format options: NRNV RNV V-PNS V
| Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [City](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 20 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [Country](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [DateOfBirth](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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) |
| [Email](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [ExpirationDate](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: MMYY | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [Fax](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 16 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [FirstName](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 10 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [IsPinSet](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Y/N | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [IsReceiveSms](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Y/N | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [IssueDate](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | 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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 30 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [IsVerified](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Y/N | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [LastName](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 15 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [MiddleInitial](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [ProductTypeName](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Saving/Commercial/GPR | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [PT](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 30 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [PTExpirationDate](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: MMYY | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [PTFriendlyName](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
| Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [RPID](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 1-19 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [State](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 2 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [StatusReasonCode](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
| Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [StatusReasonDesc](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 5 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [ACHCalcEffectiveDate](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: [YYYY-MM-DD](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [ACHPendingLoads](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 10 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [ACHPendingUnloads](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 10 | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [CardNumber](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 16 | Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [CardType](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: List of values: Credit, Debit | Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [EarlyAccess](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Y/N | Not returned | Returned | Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag) |
| [HoldExpirationDate](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
Format: MM-DD-YYYY Description: The date the holds expired
| Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [MCC](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 4 | Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [MCCDescription](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | (Alphanumeric, 1-200. can contains as well all special characters beside: <, >) | Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [TermCity](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 25 | Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [TermOwner](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 25 | Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [TransactionAmount](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 11 | Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [TransactionCode](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 6 | Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [TransactionPraxellDate](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: [YYYY-MM-DD](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [TransactionPraxellDescription](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Alphanumeric, 100 | Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [TransactionPraxellDisplayDescription](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Alphanumeric, 200 | Not returned | Returned | Returned in \~ [LastTransactions](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md)/Transaction XML tag |
| [AllowSavingAccount](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Y/N | Not returned | Returned | |
| [AccountCurrentCardStatus](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
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](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) |
| Not returned | Returned | Returned in list of Accounts |
| [AccountCurrentCardProgramType](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format:Inventory or Fullfilemnt | Not returned | Returned | Returned in list of Accounts |
| [AccountCurrentCardSavingBalance](https://github.com/chetanmadaan/Juice-Financial-Docs/blob/main/APIS/Cardholder%20Management/javascript:;/README.md) | Format: Numeric, 11 | Not returned | Returned | Returned in list of Accounts |
## XML Samples
### Input XML
```json
12345678900000121231978-04-08;
ChangeCardholderPassword1212121212121213ExtAPIY12.114.212345611111111111111111111
```
```json
ChangeCardholderPassword379966062008180940StatusOKNA2008-09-21 06:18:4737996606200818094ACTmyUserName111111111111111111111111111111111111
2222222222222222222
3333333333333333
5555555555555555555
2222222222222222222211111111111111112222222222222222222namename03120865February 20111270 BroadwaySuite 120719991234111778452IssuingBanktest900MB7891234561111111111111111ACTACTVNew YorkUS1980-01-01123456789SSNqa@praxell.com02112126296232StaticYY2010-07-20 18:25:02.0StoreYData2126296040DevOnly1360DevOnlyCardExpirationDate9999999999998068NY10001
```
```json
ChangeCardholderPassword070716122007371057000InvalidPasswordInvalidPassword2021-10-01 12:37:5007071612200737105
```
# 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:
| Name | Required | Definition | Comments |
| --------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| 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).
Format: Alphanumeric, 20 Value can be multiple org\_id’s split by commas
| |
| CardActivationMode | N | Format: Y (default)/N | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ---------------------------------------------------------------------------------------------------------------- |
| 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 |
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 | 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.
| 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) |
| Email |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| 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 |
| 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 |
| 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 |
| 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
```json
12345678900000121231978-04-08;
EnrollCardholder1212121212121213ExtAPIY12.114.2123456myUserName11111111111111111111N
```
```json
EnrollCardholder379966062008180940StatusOKNA2008-09-21 06:18:4737996606200818094myUserName1111ACT111111111111111111111111111111111111
2222222222222222222
3333333333333333
5555555555555555555
2222222222222222222211111111111111112222222222222222222namename03120865February 20111270 BroadwaySuite 120719991234111778452IssuingBanktest900MB7891234561111111111111111ACTACTVNew YorkUS1980-01-01123456789SSNqa@praxell.com02112126296232StaticYY2010-07-20 18:25:02.0StoreYData2126296040DevOnly1360DevOnlyCardExpirationDate9999999999998068NY10001
```
```json
EnrollCardholder0707161220073710570000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Get Cardholder Details
## Get Cardholder Details
The Get Cardholder Details API allow log in and getting a list of cards for the cardholder with their required details (as status, state, DDA, etc)
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| CardholderUserName | C | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | |
| 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).
| |
| OrgId | N |
Format: Alphanumeric, 20 Value can be multiple org\_id’s split by commas
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ---------------------------------------------------------------------------------------------------------------- |
| 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 |
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 | 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.
| 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) |
| Email |
Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern:
| 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 |
| 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 |
| 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 |
| 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
```json
test_pmtest_pm;
GetCardholderDetails1212121212121213ExtAPImyUserNameY12.114.211111111111111111111
```
```json
GetCardholderDetails379966062008180940StatusOKNA2008-09-21 06:18:4737996606200818094myUserName111111111111111111111111111111111111
2222222222222222222
3333333333333333
5555555555555555555
12347099999999999982419999999999998241StaticDataACTNAGPR003120865February 20111270 BroadwaySuite 120719991234111778452IssuingBanktest900MB7891234561234567890123456ACTACTVNew YorkUS1980-01-01123456789SSNqa@praxell.com02112126296232StaticYY2010-07-20 18:25:02.0StoreYData2126296040DevOnly1360DevOnlyCardExpirationDate9999999999998068NY10001
```
```json
GetCardholderDetails0707161220073710570021Invalid Card IdInvalid Card Id2021-10-01 12:37:5007071612200737105
```
# Reset Cardholder Password
## Reset Cardholder Password
The Reset Cardholder Password API allows reset the cardholder password
## Input Parameters:
| Name | Required | Definition | Comments |
| ------------------ | -------- | -------------------------------------------------------- | -------- |
| CardholderUserName | Y | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | |
## Output Parameters:
## XML Samples
### Input XML
```json
test_pmtest_pm;
ResetCardholderPassword1212121212121213ExtAPImyUserName
```
```json
ResetCardholderPassword379966062008180940StatusOKNA2008-09-21 06:18:4737996606200818094
```
```json
ResetCardholderPassword0707161220073710570166Invalid IDInvalid ID2021-10-01 12:37:5007071612200737105
```
# Get Cardholder Data
## Get Cardholder Data
## :magic:Input Parameters:
| Name | Required | Definition | Comments |
| ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| ID | Y |
Format: Numeric, 1–19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | Y |
Format options: CardNumber RPID
| |
## :laptop-code:Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| -------------------------------------- | ------------------------------------------------------------ | ------------ | ------------ | -------- |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | |
| MiddleInitial |
Format: Alpha,1 Middle name char of the cardholder
| Not returned | Returned | |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | |
| AddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | |
| AddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | |
| City | Format: Alphanumeric, 20 | Not returned | Returned | |
| State | Format: Alphanumeric, 2 | Not returned | Returned | |
| Zip | Format: Numeric, 5 | Not returned | Returned | |
| Country | ISO Country code (2 chars) | Not returned | Returned | |
| Phone | Format: Numeric, 6-15 | Not returned | Returned | |
| Fax | Format: Numeric, 6-10 | Not returned | Returned | |
| Email | Format: 5-40 chars (email pattern) | Not returned | Returned | |
| IsReceiveSms | Enabled / Disabled / Blank / Mail | Not returned | Returned | |
| MobilePhone | Format: Numeric, 6-15 | Not returned | Returned | |
| IntPhoneNumber | International format (+ optional) | Not returned | Returned | |
| EarlyAccess | Format: Y/N | Not returned | Returned | |
| DateOfBirth | Format: yyyy-mm-dd | Not returned | Returned | |
| VerificationRequest | UpdateAndVerify / UpdateOnly / NoUpdateOnVerificationError | Not returned | Returned | |
| VerificationType | Multiple verification modes | Not returned | Returned | |
| DocExpirationDate | Format: YYYY-MM-DD | Not returned | Returned | |
| DocIssueDate | Format: YYYY-MM-DD | Not returned | Returned | |
| DocIssuer | Format: Alphanumeric, 2 | Not returned | Returned | |
| DocId | Format: Alphanumeric, 3-16 | Not returned | Returned | |
| DocType | SSN / PASS / UDL / MCN / INMATE / EIN | Not returned | Returned | |
| UseShippingDetails | Format: Y/N | Not returned | Returned | |
| ShippingAddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | |
| ShippingAddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | |
| ShippingCity | Format: Alpha, 1-20 | Not returned | Returned | |
| ShippingState | Format: Alphanumeric, 2 | Not returned | Returned | |
| ShippingZip | — | Not returned | Returned | |
| SubscribeToEmail | Y/N (default N) | Not returned | Returned | |
| UserDefined1 | Size: 255 | Not returned | Returned | |
| UserDefined2 | Size: 255 | Not returned | Returned | |
| UserDefined3 | Size: 255 | Not returned | Returned | |
| UserDefined4 | Size: 255 | Not returned | Returned | |
| UserDefined5 | Size: 255 | Not returned | Returned | |
| UserDefined6 | Size: 255 | Not returned | Returned | |
| UserDefined7 | Size: 255 | Not returned | Returned | |
| UserDefined8 | Size: 255 | Not returned | Returned | |
| UserDefined9 | Size: 255 | Not returned | Returned | |
| UserDefined10 | Size: 255 | Not returned | Returned | |
| UserDefined11 | Size: 255 | Not returned | Returned | |
| UserDefined12 | Size: 255 | Not returned | Returned | |
| UserDefined13 | Size: 255 | Not returned | Returned | |
| UserDefined14 | Size: 255 | Not returned | Returned | |
| UserDefined15 | Size: 255 | Not returned | Returned | |
| AuthorizedUser | — | Not returned | Returned | |
| CardholderBankRouting | Format: Numeric, 9 | Not returned | Returned | |
| CardholderBankName | Format: Alphanumeric, 100 | Not returned | Returned | |
| CardholderAccountNumber | Format: Alphanumeric, 0-34 | Not returned | Returned | |
| CardholderAccountName | Format: Alphanumeric, 100 | Not returned | Returned | |
| ExternalPaymentProviderName1 | — | Not returned | Returned | |
| ExternalPaymentProviderID1 | — | Not returned | Returned | |
| ExternalPaymentProviderCreationDate1 | — | Not returned | Returned | |
| ExternalPaymentProviderLastUpdateDate1 | — | Not returned | Returned | |
| ExternalPaymentProviderAdditionalInfo1 | — | Not returned | Returned | |
| ExternalPaymentProviderName2 | — | Not returned | Returned | |
| ExternalPaymentProviderID2 | — | Not returned | Returned | |
| ExternalPaymentProviderCreationDate2 | — | Not returned | Returned | |
| ExternalPaymentProviderLastUpdateDate2 | — | Not returned | Returned | |
| ExternalPaymentProviderAdditionalInfo2 | — | Not returned | Returned | |
| ExternalPaymentProviderName3 | — | Not returned | Returned | |
| ExternalPaymentProviderID3 | — | Not returned | Returned | |
| ExternalPaymentProviderCreationDate3 | — | Not returned | Returned | |
| ExternalPaymentProviderLastUpdateDate3 | — | Not returned | Returned | |
| ExternalPaymentProviderAdditionalInfo3 | — | Not returned | Returned | |
| ExternalPaymentProviderName4 | — | Not returned | Returned | |
| ExternalPaymentProviderID4 | — | Not returned | Returned | |
| ExternalPaymentProviderCreationDate4 | — | Not returned | Returned | |
| ExternalPaymentProviderLastUpdateDate4 | — | Not returned | Returned | |
| ExternalPaymentProviderAdditionalInfo4 | — | Not returned | Returned | |
| ExternalPaymentProviderName5 | — | Not returned | Returned | |
| ExternalPaymentProviderID5 | — | Not returned | Returned | |
| ExternalPaymentProviderCreationDate5 | — | Not returned | Returned | |
| ExternalPaymentProviderLastUpdateDate5 | — | Not returned | Returned | |
| ExternalPaymentProviderAdditionalInfo5 | — | Not returned | Returned | |
| IntAddressLine1 | Format: Alphanumeric, 1-30 | Not returned | Returned | |
| IntAddressLine2 | Format: Alphanumeric, 1-30 | Not returned | Returned | |
| IntCity | Format: Alpha, 1-20 | Not returned | Returned | |
| IntStateProvinceRegion | Format: Alphanumeric, 1-30 | Not returned | Returned | |
| IntCountry | ISO Country code (2 chars) | Not returned | Returned | |
| IntZipPostalCode | Format: Alphanumeric, 1-20 | Not returned | Returned | |
| IntDocId | Format: Alphanumeric, 1-50 | Not returned | Returned | |
| IntDocType | Format: Alphanumeric, 1-50 | Not returned | Returned | |
| IntAddress | Format: Y/N | Not returned | Returned | |
| Language | English / Spanish | Not returned | Returned | |
| MiddleName | Format: Alpha, 0-20 | Not returned | Returned | |
| SurName | Format: Alpha, 0-20 | Not returned | Returned | |
| AdditionalIDExpirationDate | Format: YYYY-MM-DD | Not returned | Returned | |
## XML Samples
### Input XML
```json
fe22d8c2-12cc-4684-a3d0-06b831038736fe22d8c2-12cc-4684-a3d0-06b831038736GetCardholderDataPortal:csr205RPID
```
```json
GetCardholderDatafe22d8c2-12cc-4684-a3d0-06b8310387360StatusOKOK2026-03-02 18:39:45fe22d8c2-12cc-4684-a3d0-06b831038736Hazel ElaineConnerFakeAddressFakeCityCA54321US123459876Y123459876972546644115Y1979-05-05123456789SSNjuice_3550.epssencilla_cha_01_form_0272345Tomer MadmonMadmon Bank1234567890P.P 12024/11/26Bla Bla Bla56647747447HaGalil 4Beit DaganHaMerkazIL5020000ID034450106YSpanish
```
# repCardholders
### 📘 Cardholders Report API (`repCardholders`)
This API retrieves a list of cardholders based on selected date criteria and optional filters.
***
#### 🔹 Overview
* Returns a cardholders report
* Supports filtering by date type, card status, product type, and user details
* Output is returned in IXML format
* Each record represents a single cardholder
***
#### 🔑 Required Parameters
| Parameter | Description |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `dateType` | Defines the date filter type (e.g., `issuance`, `creation`, `activation`, `setpin`, `verification`, `fulfillment`, `lastactivity`, `closure` ) |
| `fromDate` | Start date (format: `YYYY-MM-DD`) |
| `toDate` | End date (format: `YYYY-MM-DD`) |
⚠️ dateType, fromDate, and toDate are mandatory fields. The API will not return results without these parameters.
***
#### ⚙️ Optional Filter Parameters
All other `` fields are optional and can be used to refine results.
**🧑 Cardholder Filters**
* `firstName`, `lastName`
* `govtIssuedId`
* `PhoneNumber`, `address`
**💳 Card Filters**
* `keyType`, `keyValue` (e.g., card number)
* `cardStatus`
* `replacementStatus`
* `reasonCodeGroup`
**🏢 Organization / Product Filters**
* `productType`
* `bankOrgName`
* `repInternalUserOrgId`
* `repInternalOrgRole`
**🔎 Additional Filters**
* `portalUserName`, `issuerUser`
* `verificationStatus`
* `primaryRpid`, `secondaryRpid`
* `account_id`
* `SubscriptionType`
* `sourceIP`
* `chState`, `feeLess`
💡 If no optional filters are provided, the API returns all cardholders within the selected date range.
***
#### 📤 Response
* Format: IXML
* Includes:
* Report headers (field definitions)
* Cardholder entries (rows)
* Each row represents a single cardholder record
***
#### 🧾 Key Features
* Flexible filtering across multiple attributes
* Supports pagination:
* `RowsPerPage`
* `FromPos`
* Consistent schema (empty fields are still returned)
* Supports different date types via `dateType`
***
#### ✅ Summary
| Type | Fields |
| -------- | -------------------------------- |
| Required | `dateType`, `fromDate`, `toDate` |
| Optional | All other parameters (filters) |
| Output | Cardholders report in XML format |
## XML Samples
### Input XML
```json
destServer=debitAppServer2&data=
test_pmtest_pmReport1212121212121213Portal:pdprepCardholdersDefaultAdvancedDefaultDefaultIXMLProgMngr501
```
### Output XML
```json
Report002026-04-15T12:26:41159111de-008c-4a34-a2b2-bb05c17f0307159111de-008c-4a34-a2b2-bb05c17f0307ActionsCard NumberNameRPIDDDAFBE DDAVirtualStatusStatus ReasonCH StateBal.Holds Bal.Last ActivityUsernameFirst NameMiddle InitialLast NameAddress 1Address 2CityStateZipShipping Address Line 1Shipping Address Line 2Shipping CityShipping StateShipping ZipMailPhoneMobileInternational Phone NumberSMS EnabledSubscribe To E-mailEarly AccessDate of BirthIssuerProduct TypeIssuing BankProcessor AccountGov't Issued IDGov't ID TypeGov't ID Issue DateGov't ID Expiration DateSPND Reason TypeReplacement StatusVerification StatusVerification Detailed StatusVerification IDVerifiedESign Acceptance DateAlt ESign Acceptance DateCard CreatedCard Expiration DateLast Set PIN DateCard activation dateCard Issue dateCH Activation DateClose DateIs Fee LessAccount IdSource IPCard Issuance DescriptionCard Fulfillment FileCard Fulfillment DateCampaign IDReferral CodeActivation User NameCard TypeUser Defined Field 1User Defined Field 2User Defined Field 3User Defined Field 4User Defined Field 5User Defined Field 6User Defined Field 7User Defined Field 8User Defined Field 9User Defined Field 10User Defined Field 11User Defined Field 12User Defined Field 13User Defined Field 14User Defined Field 15Authorized UserLabel on cardLabel on next cardLast Activity TypeLast Activity StateLast Activity SuccessAll ActivitiesCardholder BankCardholder Account NumberCardholder Account NameCardholder Bank RoutingInternational Address Line 1International Address Line 2International CityInternational State/RegionInternational CountryInternational ZipInternational Document IDInternational Document TypeUse International AddressLanguageMiddle NameSurnameAdditional ID ExpirationProvider Name 1Provider ID 1Provider Creation Date 1Provider Update Date 1Provider Info 1Provider Name 2Provider ID 2Provider Creation Date 2Provider Update Date 2Provider Info 2Provider Name 3Provider ID 3Provider Creation Date 3Provider Update Date 3Provider Info 3Provider Name 4Provider ID 4Provider Creation Date 4Provider Update Date 4Provider Info 4Provider Name 5Provider ID 5Provider Creation Date 5Provider Update Date 5Provider Info 5actions1111Jhon Doe123654789NAPrintedCardSPNDUnactivated Replacement CardV-PNS5765004-08-2026 00:18:08babyshow69JhonDoe3589 umbrella AveNew YorkOH11201client@juicefin.com12345678951234567895Y04-18-2001 00:00:00issue_Company_17144Juice5_Bulk EMV (P)First Century Bank NC12341234567895SSNVerifiedSSNVerifiedSSN123456789512-30-2024 14:49:0504-14-2026 14:05:1604-30-2029 00:00:0012-30-2024 14:49:0404-14-2026 14:05:16N1234567895Cards_for_Fulfillment_2026-04-14_1902.xml04-14-2026 19:04:17issue_Company_17144GPRjuice_1.eps0 (PrintedCard)juicefin.com/juice5https://juicefin.com/mobileSAY GOODBYE TO EVERYTHING ELSE IN YOUR WALLETjuicefin.com/cardholders(321) 111-2222juicefin.com/juice5INITIATEPTJuice5_Bulk EMV:TOPTJuice5_Bulk EMV:CHA01:FORM00NA
]]>
1
```
# repFullRawData
### 📘 Transaction Report API (`repFullRawData`)
This API retrieves card transaction report data based on a specified date range and optional filter criteria.
This API retrieves card transaction report data based on a specified date range and optional filter criteria.
***
#### 🔹 Overview
* Generates a detailed transaction report
* Supports multiple filter parameters to refine results
* Returns data in IXML format
* Each response includes transaction-level records
***
#### 🔑 Required Parameters
| Parameter | Description |
| ---------- | -------------------------------------------------------- |
| `fromDate` | Start date for transaction search (format: `YYYY-MM-DD`) |
| `toDate` | End date for transaction search (format: `YYYY-MM-DD`) |
⚠️ These fields are mandatory. The API will not return data without a valid date range.
***
#### ⚙️ Optional Filter Parameters
All other `` fields are optional and can be used to refine the results.
**🧑 Card / User Filters**
* `keyType`, `keyValue` (e.g., filter by RPID, card number)
* `firstName`, `lastName`
* `account_id`, `primaryRpid`, `secondaryRpid`
**💳 Transaction Filters**
* `activity` (transaction type/code)
* `dateType`, `trxTimeLine`
* `orderByName`
**📊 Card / Account Status**
* `cardStatus`, `chState`
* `replacementStatus`, `reasonCodeGroup`
* `verificationStatus`
**🏢 Product / Organization**
* `productType`, `bankOrgName`
* `onlineOrgName`, `repInternalUserOrgId`
**🔎 Additional Filters**
* `sourceIP`, `issuerUser`, `portalUserName`
* `address`, `PhoneNumber`
* `SubscriptionType`, `feeLess`
💡 If no optional filters are provided, the API returns all transactions within the given date range.
***
#### 📤 Response
* Format: IXML
* Includes:
* Report headers (field definitions)
* Transaction entries (rows)
* Each row represents a single transaction
***
#### 🧾 Key Features
* Flexible filtering using multiple parameters
* Supports sorting via `OrderByName`
* Pagination support:
* `FromPos`
* `RowsPerPage`
* Consistent schema (empty fields are still returned)
***
#### ✅ Summary
| Type | Fields |
| -------- | -------------------------------- |
| Required | `fromDate`, `toDate` |
| Optional | All other parameters (filters) |
| Output | Transaction report in XML format |
## XML Samples
### Input XML
```json
destServer=debitAppServer2&data=
test_pmtest_pm@816Report945f58fe-83df-658c-494f-c2bc6630b461app.juice.trxreportrepFullRawDataDefaultDayActivityDefaultLOG_DATETIME descIXMLStandard1
```
### Output XML
```json
Report002026-04-15T13:50:45f8da9e45-4ef7-473e-b578-f3ec3d0198bef8da9e45-4ef7-473e-b578-f3ec3d0198beACTBusiness - Card to Card Transfer - Out0.0426I2600000000013452541502-06-2026 05:31:191111123456545XP0BDSBusiness - Card to Card Transfer - OutPraxell IntACT0.04010.66Juice virtual FBO11110001111111Business - Card to Card Transfer - OutCSRTestNew YorkNYUSJuice AAFirst Century Bank NCCardToCardTransfer026f5787-ac28-49ac-872d-04faf164827c1770373877791-p2ewwit0.0.0.0118617707072026-02-06 05:31:19.0
]]>
1
```
# Transactions
# Card to Card Transfer
## Card to Card Transfer
The Card to Card Transfer API allows a cardholder to transfer currency from one card to another.
## Input Parameters:
| Name | Required | Definition | Comments |
| -------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Amount | Y |
Format: Numeric, 1-9 Description: The amount is in cents.
| amount>0 |
| CardNumber | C | Format: Numeric, 16 | Mutually exclusive with From\To ID. Deprecated (use ID/ID Type). Should be paired only with TransferToCardNumber (and both will be discontinued in the future). |
| CurrencyCode | Y |
Format: Alphanumeric, 3 Description: Closed list of values.
| "USD" |
| DateOfBirth | N |
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
| |
| Description | N | Format: Alphanumeric, 1-25 | |
| TransferToCardNumber | C | Format: Numeric, 16 | Mutually exclusive with From\To ID. Deprecated (use ID/ID Type). Should be paired only with CardNumber (and both will be discontinued in the future) |
| FromID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| Mutually exclusive with CardNumber. Required if FromIDType is provided. Also supports a DDA as an ID |
| FromIDType | C |
Format options: CardNumber RPID SavingAccount
| relevant only for FromID parameter. Also supports "DDA" as ID Type |
| ToID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| Mutually exclusive with TransferToCardNumber. Required if ToIDType is provided. Also supports a DDA as an ID |
| ToIDType | C |
Format options: CardNumber RPID SavingAccount
| relevant only for ToID parameter. Also supports "DDA" as ID Type |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| -------------------- | ----------------------- | ------------ | ------------ | ---------------------------------------------------------------------------------------- |
| AmountTransfered | Format: Numeric, 11 | Not returned | Returned | |
| CardAvailableBalance | Format: Numeric, 11 | Not returned | Returned | Balance of the card which has transferred the money (to another card) after the transfer |
| TransferBaseCurrency | Format: Alphanumeric, 3 | Not returned | Returned | |
| TransferFee | Format: Numeric, 11 | Not returned | Returned | |
| TransferToCardNumber | Format: Numeric, 16 | Not returned | Returned | |
## XML Samples
### Input XML
```json
15645600407181054321;
2135550CardToCardTransferExtAPI100USD1234567890123456CardNumber
```
```json
CardToCardTransfer379956062008140410StatusOKNA2008-04-29 06:14:1137995606200814041100USD99999999999980531999
```
```json
CardToCardTransfer0707161220073710545006From Card Status Change FailureFrom Card Status Change Failure2021-10-01 12:37:5007071612200737105
```
# Charge Fee
## Charge Fee
The Charge Fee API allows charging fee from a specific card.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| CardNumber | C | Format: Numeric, 16 | Deprecated. Will be removed in the future |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| Currency | Y | Format: Alphanumeric, 3 | |
| Description | N | Format: Alphanumeric, 1-30 | |
| FeeAmount | Y | Format: Numeric, 10 | |
| Type | N |
Format: RPID CARD Description: Type of transaction for charge fee
| |
## Output Parameters:
## XML Samples
### Input XML
```json
fmwcc_fb_QA1q2w3e4r;
3899670ChargeFeeExtAPI300USDDE1234567890AP31DS
```
```json
ChargeFee298329082008050340StatusOKNA2008-03-11 08:05:4529832908200805034
```
```json
ChargeFee0707161220073710545004Error processing request messageError processing request message2021-10-01 12:37:5007071612200737105
```
# Load Network Reload Card
## Load Network Reload Card
The Load Network Reload Card API loads currency onto a card. Make sure all load limits are set in order to load a card.
## Input Parameters:
| Name | Required | Definition | Comments |
| -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| Amount | Y |
Format: Numeric, 1-9 Description: The amount is in cents.
| |
| CardNumber | C | Format: Numeric, 16 | "C" - based on CardParameterType |
| CardParameterType | N |
Format options: CardNumber , RPID, DDA Description: If RPID, RPID is required If DDA, DDA is required If CardNumber, CardNumber is required If empty, CardNumber is required
| default='CardNumber' |
| DDA | C | Format: Numeric, 3-16 | Support FBEDDA as well "C" - based on CardParameterType |
| Description | N | Format: Alphanumeric, 1-25 | |
| EffectiveDate | N | Format: YYYY-MM-DD | |
| GetCardholderDetails | N |
Format: N (default) Y
| |
| LoadNetwork | Y |
Format options: ACH (Automated Clearing House) IAT (International ACH Transaction) GD (Green Dot) PRX (Praxell) WU (Western Union)
| |
| OriginAccount | C | Format: Alphanumeric, 50 | required when Load Network is GD (Green Dot) in Pull Mode |
| RPID | C | Format: Numeric, 1-19 | "C" - based on CardParameterType |
| VerifyCardRequestID | N | Format: Alphanumeric, 30 | |
| GetLastTransactions | N | | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------------------- | ---------------------------------------------- |
| ActivationDate | Format: YYYY-MM-DD | Not returned | Required to be returned | |
| ActualExpirationDate |
Format: Alphanumeric, 12, Month YYYY Description: example, April 2013
| Not returned | Required to be returned | |
| ActiveHoldsTotalAmount |
Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder
| Not returned | Required to be returned | |
| ApprovalCode | Format:Alphanumeric, 50 | Not returned | Required to be returned | Returned when reload is done through Green Dot |
| AddressLine1 | Format:Alphanumeric, 30 | Not returned | Required to be returned | |
| AddressLine2 | Format:Alphanumeric, 30 | Not returned | Required to be returned | |
| CardAvailableBalance | Format: Numeric, 11 | Not returned | Required to be returned | |
| CHState |
Format options: NRNV RNV V-PNS V
| Not returned | Required to be returned | |
| City | Format: Alphanumeric, 20 | Not returned | Required to be returned | |
| DDA | Format: Numeric, 3-16 | Not returned | Required to be returned | |
| ExpirationDate | Format: MMYY | Not returned | Required to be returned | |
| FirstName | Format: Alphanumeric, 10 | Not returned | Required to be returned | |
| LastName | Format: Alphanumeric, 15 | Not returned | Required to be returned | |
| MiddleInitial |
Format: Alpha,1 Description: Middle name char of the cardholder.
| Not returned | Returned | |
| OriginAccountBalance | Format: Alphanumeric, 50 | Not returned | Required to be returned | returned when reload is done through Green Dot |
| 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 | |
| PostedBalance | Format: Numeric, 11 (balance after transaction was done, before fees were taken) | Not returned | Returned | |
| PTExpirationDate | Format: MMYY | Not returned | Required to be returned | |
| ReplacementMessageType |
Format options: ToBeReplacedInAnotherBankForVerifiedCH ToBeReplacedInAnotherBankForRNVCH PTExpirationDate CardExpirationDate ReplacementCardOrderedFromAnotherBank ReplacementCardOrderedFromSameBank ReplacedAnotherCardInAnotherBank
| Not returned | Required to be returned | |
| ReplacementStatus |
| Not returned | Required to be returned | |
| RPID | Format: Numeric, 1-19 | Not returned | Required to be returned | |
| State | Format: Alphanumeric, 2 | Not returned | Required to be returned | |
| Zip | Format: Numeric, 5 | Not returned | Required to be returned | |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | |
| IVRPhoneNumber | Format: Numeric, 6-15 | Not returned | Returned | |
| ProgramURL | Format: Alphanumeric, 1000 (including ? : . ) | Not returned | Returned | |
| FeeAmount | Format: Numeric, 10 | Not returned | Returned | Fees.Fee tag |
| ContextTransactionDescription | Format: Alphanumeric, 80 | Not returned | Returned | Fees.Fee tag |
| ContextTransactionType | Format: List of values: Credit, Debit | Not returned | Returned | Fees.Fee tag |
| FeeAmount | Format: Numeric, 10 | Not returned | Returned | Fees.Fee tag |
| FailedFee | Format: Y/N. Provide yes if there are some fees which are not taken for any reason | Not returned | Returned | Fee tag |
| OriginalAvailableCardBalance | Format: Numeric, 11 | Not returned | Returned | |
| TransactionPraxellDescription | Format: Alphanumeric, 100 | Not returned | Returned | LastTransactions.Transaction tag |
| TransactionPraxellDate | Format: YYYY-MM-DD | Not returned | Returned | LastTransactions.Transaction tag |
| ContextTransactionType | Format: List of values: Credit, Debit | Not returned | Returned | LastTransactions.Transaction tag |
| TransactionAmount | Format: Numeric, 11 | Not returned | Returned | LastTransactions.Transaction tag |
## XML Samples
### Input XML
```json
;
LoadNetworkReloadCard
```
```json
LoadNetworkReloadCardNA /LastName>
```
```json
LoadNetworkReloadCard0707161220073710540000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Load Network Unload Card
## Load Network Unload Card
The Load Network Unload Card API allows card holders to unload cash from their debit card.
## Input Parameters:
| Name | Required | Definition | Comments |
| -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| Amount | Y |
Format: Numeric, 1-9 Description: The amount is in cents.
| |
| CardNumber | C | Format: Numeric, 16 | |
| CardParameterType | N |
Format options: CardNumber , RPID, DDA Description: If RPID, RPID is required If DDA, DDA is required If CardNumber, CardNumber is required If empty, CardNumber is required
| default='CardNumber' |
| DDA | C | Format: Numeric, 3-16 | |
| Description | N | Format: Alphanumeric, 1-30 | |
| GetCardholderDetails | N |
Format: N (default) Y
| |
| LoadNetwork | Y |
Format options: ACH (Automated Clearing House) IAT (International ACH Transaction) GD (Green Dot) PRX (Praxell) WU (Western Union)
| |
| Password | N | Format: Alphanumeric, 6 -10 (including char: ‘\_’) | |
| RPID | C | Format: Numeric, 1-19 | |
| GetLastTransactions | N | | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------------------- | -------------------------------- |
| ActivationDate | Format: YYYY-MM-DD | Not returned | Required to be returned | |
| ActualExpirationDate |
Format: Alphanumeric, 12, Month YYYY Description: example, April 2013
| Not returned | Required to be returned | |
| ActiveHoldsTotalAmount |
Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder
| Not returned | Required to be returned | |
| AddressLine1 | Format: Alphanumeric, 30 | Not returned | Required to be returned | |
| AddressLine2 | Format: Alphanumeric, 30 | Not returned | Required to be returned | |
| CardAvailableBalance | Format: Numeric, 11 | Not returned | Required to be returned | |
| CHState |
Format options: NRNV RNV V-PNS V
| Not returned | Required to be returned | |
| City | Format: Alphanumeric, 20 | Not returned | Required to be returned | |
| DDA | Format: Numeric, 3-16 | Not returned | Required to be returned | |
| ExpirationDate | Format: MMYY | Not returned | Required to be returned | |
| FirstName | Format: Alphanumeric, 10 | Not returned | Required to be returned | |
| LastName | Format: Alphanumeric, 15 | Not returned | Required to be returned | |
| MiddleInitial |
Format: Alpha,1 Description: Middle name char of the cardholder.
| Not returned | Returned | |
| 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 | |
| PostedBalance | Format: Numeric, 11 (balance after transaction was done, before fees were taken) | Not returned | Returned | |
| PTExpirationDate | Format: MMYY | Not returned | Required to be returned | |
| ReplacementMessageType |
Format options: ToBeReplacedInAnotherBankForVerifiedCH ToBeReplacedInAnotherBankForRNVCH PTExpirationDate CardExpirationDate ReplacementCardOrderedFromAnotherBank ReplacementCardOrderedFromSameBank ReplacedAnotherCardInAnotherBank
| Not returned | Required to be returned | |
| ReplacementStatus |
| Not returned | Required to be returned | |
| State | Format: Alphanumeric, 2 | Not returned | Required to be returned | |
| Zip | Format: Numeric, 5 | Not returned | Required to be returned | |
| RPID | Format: Numeric, 1-19 | Not returned | Required to be returned | |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | |
| IVRPhoneNumber | Format: Numeric, 6-15 | Not returned | Returned | |
| ProgramURL | Format: Alphanumeric, 1000 (including ? : . ) | Not returned | Returned | |
| FeeAmount | Format: Numeric, 10 | Not returned | Returned | Fees.Fee tag |
| ContextTransactionDescription | Format: Alphanumeric, 80 | Not returned | Returned | Fees.Fee tag |
| ContextTransactionType | Format: List of values: Credit, Debit | Not returned | Returned | Fees.Fee tag |
| FeeAmount | Format: Numeric, 10 | Not returned | Returned | Fees.Fee tag |
| FailedFee | Format: Y/N. Provide yes if there are some fees which are not taken for any reason | Not returned | Returned | Fee tag |
| OriginalAvailableCardBalance | Format: Numeric, 11 | Not returned | Returned | |
| TransactionPraxellDescription | Format: Alphanumeric, 100 | Not returned | Returned | LastTransactions.Transaction tag |
| TransactionPraxellDate | Format: YYYY-MM-DD | Not returned | Returned | LastTransactions.Transaction tag |
| ContextTransactionType | Format: List of values: Credit, Debit | Not returned | Returned | LastTransactions.Transaction tag |
| TransactionAmount | Format: Numeric, 11 | Not returned | Returned | LastTransactions.Transaction tag |
## XML Samples
### Input XML
```json
fmwcc_fb_QA1q2w3e4r;
LoadNetworkUnloadCard5435345345345ExtAPIPRXCardNumber500Y
```
```json
LoadNetworkUnloadCard397602052009030810StatusOKNA2009-08-20 05:03:153976020520090308149500120865
```
```json
LoadNetworkUnloadCard0707161220073710540000Processor errorProcessor error2021-10-01 12:37:5007071612200737105
```
# Load Network Verify Card
## Load Network Verify Card
The Load Network Verify Card API verifies card status and cardholder state, and returns information on card and cardholder.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| Amount | Y |
Format: Numeric, 1-9 Description: The amount is in cents.
| |
| AmountVerificationMode | N | Options: VerifyAmountParameter, ReturnedAllowedAmount (default) | |
| CardNumber | Y | Format: Numeric, 16 | |
| LoadNetwork | Y |
Format options: ACH (Automated Clearing House) IAT (International ACH Transaction) GD (Green Dot) PRX (Praxell) WU (Western Union)
| |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------- |
| Address | Format: Alphanumeric, 30 | Not returned | Returned | |
| CardNumber |
| Not returned | Returned | |
| City | Format: Alphanumeric, 20 | Not returned | Returned | |
| Country |
Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list.
| Not returned | Returned | |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | |
| MaxCurrentLoadingAmount |
Format: Numeric, 1-20 Description: Maximum amount currently allowed to be loaded on card (based on balance and on maximum loading definitions).
| Not returned | Returned | |
| Phone |
Format: Numeric, 6-15 Description: Phone number
| Not returned | Returned | |
| RPID | Format: Numeric, 1-19 | Not returned | Returned | |
| State | Format: Alphanumeric, 2 | Not returned | Returned | |
| Zip | Format: Numeric, 5 | Not returned | Returned | |
## XML Samples
### Input XML
```json
;
LoadNetworkVerifyCard1212121212121213ExtAPIWU
```
```json
LoadNetworkVerifyCard384997062009560740StatusOKNA2009-07-13 06:56:4238499706200956074jgffhfgfhgf
gdxfxvx vcxvcx
vxvcxCO353544534235432543253US8001
```
```json
LoadNetworkVerifyCard0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Load Network Void Card
## Load Network Void Card
The Load Network Void Card API void the reload/verify/unload(future) done just before the void/
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| Amount | Y |
Format: Numeric, 1-9 Description: The amount is in cents.
| |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | Y |
Format options: CardNumber RPID SavingAccount
| default=CardNumber |
| LoadNetwork | Y |
Format options: ACH (Automated Clearing House) IAT (International ACH Transaction) GD (Green Dot) PRX (Praxell) WU (Western Union)
| |
| OriginalUniqueRequestID | Y | Format: Alphanumeric, 30 | |
## Output Parameters:
## XML Samples
### Input XML
```json
;
LoadNetworkVoidCard1212121212121213ExtAPIWU
```
```json
LoadNetworkVoidCard384997062009560740StatusOKNA2009-07-13 06:56:4238499706200956074
```
```json
LoadNetworkVoidCard0707161220073710540014Invalid Transaction TypeInvalid Transaction Type2021-10-01 12:37:5007071612200737105
```
# Pay CH Bill
## Pay CH Bill
The Pay CH Bill allows a cardholder to pay a bill.
## Input Parameters:
| Name | Required | Definition | Comments |
| ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| Amount | Y |
Format: Numeric, 1-9 Description: The amount is in cents.
| |
| BillNickname | N |
Format: Alphanumeric, 100 Description: The name of the bill as defined by the cardholder Can contains as well all special characters (but cannot contain only blank)
| |
| BPPTransactionSessionID | N | Alphanumeric, 1-20 | |
| ID | Y |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
| |
| IDType | Y | CardNumber (Default), RPID, ANY (add ANY only to ALL APIs - allow to send RPID/DDA number and the application identify it and change it to card number) | |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ------------------ |
| ApprovalCode | Format:Alphanumeric, 8 | Not returned | Returned | |
| BillerAccount | Format: Alphanumeric, 100 | Not returned | Returned | Billers/Biller tag |
| BillNickname |
Format: Alphanumeric, 100 Description: The name of the bill as defined by the cardholder Can contains as well all special characters (but cannot contain only blank)
| Not returned | Returned | Billers/Biller tag |
| BPPBillerCutoffTime | Format: Alphanumeric, 12 | Not returned | Returned | Billers/Biller tag |
| BPPBillerDescription |
Format: Alphanumeric, 100 Description: The name of the biller to show to the end user
| Not returned | Returned | Billers/Biller tag |
| BPPBillerID |
Format: Alphanumeric, 100 Description: Value got from Get Billers List API
| Not returned | Returned | Billers/Biller tag |
| BPPBillerPhone | Format: Numeric, 14 | Not returned | Returned | Billers/Biller tag |
| BPPBillerWebsite | Format: Alphanumeric, 40 (including all web address strings as : / .) | Not returned | Returned | Billers/Biller tag |
| BPPCancelWarnFlag | Format: Y/N | Not returned | Returned | Billers/Biller tag |
| BPPExpectedPostingTimeFrame | Format: Alphanumeric, 100 | Not returned | Returned | Billers/Biller tag |
| BPPFeeAmount | Format: Numeric, 1-14 | Not returned | Returned | |
| BPPRefundWarnFlag | Format: Y/N | Not returned | Returned | Billers/Biller tag |
| BPPServiceOfferingID | Format: Alphanumeric, 21 | Not returned | Returned | Billers/Biller tag |
| FeeAmount | Format: Numeric, 10 | Not returned | Returned | |
| BPPCustomerTips | Format: Alphanumeric, 1-120 | Not returned | Returned | Tips/tip tag |
| BPPTollFreePhoneNumber | Format: Alphanumeric, 1-120 | Not returned | Returned | |
| 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 | |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | |
| OriginalAvailableCardBalance | Format: Numeric, 11 | Not returned | Returned | |
| AvailableCardBalance | Format: Numeric, 11 | Not returned | Returned | |
## XML Samples
### Input XML
```json
abuali_QA1q2w3e4r;
1212121212121252PayCHBillExtAPI130005212345612345my billPRX_Biller1MobilePhoneAndZip1897890060769839CardNumber
```
```json
PayChBill184957172011301100StatusOKNA2011-11-21 17:30:0918495717201130110
```
```json
PayCHBill0707161220073710570029Data not found (cardholder not found)Data not found (cardholder not found)2021-10-01 12:37:5007071612200737105
```
# Reverse Fee
## Reverse Fee
The Reverse Fee API allows to rebate fee for a specific card.
## Input Parameters:
| Name | Required | Definition | Comments |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| Amount | Y |
Format: Numeric, 1-9 Description: The amount is in cents.
| relevant only if Reason Category is Good Will / User Error /System Error/ Other |
| BulkFee | N | Options: Y/N(default) | relevant if ReferenceIDType= CardSessionID or not provided |
| CardNumber | C | Format: Numeric, 16 | Deprecated. Will be removed in the future |
| ID | C |
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber