Cards
Activate Card
Use this endpoint to set the users current prepaid card status to Activated.
Method: PATCH
Endpoint: {{env}}/api/card/activate-card/{{userId}}
{
"UserId": "8ebd932b-...b92633e14297",
"CardProgramId": "Customer_Card_Program"
}Input Parameters
UserId
Guid
Yes
User Id
CardProgramId
String
Yes
Card Program Id (Case Sensitive)
Response
ResponseDesc
String
Description of the response
ZumEvent
String
Zum event
Change Card Program
Use this endpoint to change the card program of the current card attached to the user.
Method: PATCH
Endpoint: {{env}}/api/card/change-card-program
{
"UserId": "8ebd932b-...b92633e14297",
"NewProgramId": "Customer_Card_Program"
}Input Parameters
UserId
Guid
Yes
User Id
NewProgramId
String
Yes
New Card Program Id (Case Sensitive)
Response
CardReferenceId
String
Card Reference Id
NewProgramId
String
New Card Program Id
ResponseDesc
String
Response description
ZumEvent
String
Zum event
Get Balance Inquiry
Use this endpoint to get the balance on the current card attached to the user.
Method: GET
Endpoint: {{env}}/api/card/balance-inquiry/{{userId}}
{
"statusCode": 200,
"message": "GET Request successful.",
"isError": false,
"result": {
"ResponseDesc": "Operation is successful.",
"AvailableBalance": 100,
"LedgerBalance": 0,
"ZumEvent": "ZumCardSuccess"
}
}Response
ResponseDesc
String
Response description
AvailableBalance
Number
Current balance of the card
LedgerBalance
String
Ledger balance of the card
ZumEvent
String
Zum event
Get Card Accounts
Use this endpoint to gather all the cards attached to this user.
Method: GET
Endpoint: {{env}}/api/card/get-card-accounts/{{userId}}
{
"statusCode": 200,
"message": "GET Request successful.",
"isError": false,
"result": {
"ResponseDesc": "Operation is successful.",
"AvailableBalance": 0.0,
"LastDepositAmount": 0.0,
"LedgerBalance": 0.0,
"ZumEvent": "ZumCardSuccess",
"Cards": [
{
"CardNumber": "************2208",
"IsRegistered": "N",
"CardReferenceId": "110195650227752",
"CardProgramId": "Zumrail_test_prog",
"Status": "Activated",
"CustomerId": "110000001956502277"
}
]
}
}Input Parameters
UserId
Guid
Yes
User Id
Response
ResponseDesc
String
Response description
AvailableBalance
Number
Current balance of the card
LastDepositAmount
String
Amount of last deposit
LedgerBalance
String
Ledger balance of the card
ZumEvent
String
Zum event
Cards
CardNumber
String
Card number
IsRegistered
Char (Y/N)
Card Registration Status
CardReferenceId
String
Card Reference Id
CardProgramId
String
Card Program Id
Status
String
Card Status
CardNumber
String
Card number
Get Card Status
Use this endpoint to get the card status of the user's current card.
Method: GET
Endpoint: {{env}}/api/card/get-card-status/{{userId}}
{
"statusCode": 200,
"message": "GET Request successful.",
"isError": false,
"result": {
"CardStatus": "IssuedInactive",
"ZumEvent": "ZumCardSuccess",
"ResponseDesc": "Operation is successful."
}
}Input Parameters
UserId
guid
Yes
User Id
Response
CardStatus
String
Card Status
ZumEvent
String
Zum event
ResponseDesc
String
Response description
Set Card Status
Use this endpoint to set the card status of the user’s current card.
Method: POST
Endpoint: {{env}}/api/card/set-card-status
{
"UserId": "8ebd932b-...b92633e14297",
"CardStatus": "FraudBlock"
}Request Parameters
UserId
Guid
Yes
User Id
CardStatus
String
Yes
New Card Status
Response
CardStatus
String
Card Status
ZumEvent
String
Zum event
ResponseDesc
String
Response description
Card Status
These are the available card status updates.
Activated
Card is active and ready for use.
Closed
Card account is closed.
Inactive
Card is temporarily inactive.
FraudBlock
Card is blocked due to suspected fraud.
Reissue Card
Use this endpoint to reissue an existing non-closed card and close the existing card attached to the user.
Method: POST
Endpoint: {{env}}/api/card/reissue-card
{
"UserId": "8ebd932b-...b92633e14297",
"cardReferenceId": "110195650252149"
}Request Parameters
UserId
Guid
Yes
User Id
CardReferenceId
String
Yes
Card Reference Id
Response
NewCardReferenceId
String
New Card Reference Id
ZumEvent
String
Zum event
ResponseDesc
String
Response description
UserId
Guide
User Id of the prepaid card user
Last4Digits
Number
Last 4 digits of the prepaid card number
ExpireMonth
Number
Expiry month of the prepaid card number
ExpireYear
Number
Expiry year of the prepaid card number
Available balance
Number
Available balance of the prepaid card number
Ledger Balance
Number
Ledger balance of the prepaid card number
FirstName
String
First name of the prepaid card user
LastName
String
Last name of the prepaid card user
CardStatus
String
Card status of the reissued card
CardProgramId
String
Card program the reissued card is assigned under
String
Email address of the prepaid card user
Get Card Transactions
Use this endpoint for transaction history from a users prepaid card.
Method: POST
Endpoint: {{env}}/api/card/get-card-transactions
{
"UserId": "8ebd932b-...b92633e14297",
"CardReferenceId": "599000027458",
"CreatedAtOperator": "isInTheLast",
"CreatedAt": "2023-01-01 12:00:00.000",
"Pagination": {
"PageNumber": 1,
"ItemsPerPage": 10
}
}
Request Parameters
UserId
Guid
Yes
User Id
CardReferenceId
String
Yes
Card reference id
CardTransactionType
String
No
Card issuer transaction type
CardTransactionStatuses
String
No
Card transaction statuses
TransactionZumRailsType
String
No
Transaction zum rails type
CardTransactionId
String
No
Card issuer transaction id
GenericSearch
String
No
Filter the search with this text
AmountLowerLimit
Number
No
Lower limit transaction amount
AmountUpperLimit
Number
No
Upper limit transaction amount
CreatedAtOperator
String
No
Date filter type for query
CreatedAtFrom
Datetime
No
Start date for query
CreatedAtTo
Datetime
No
End date for query
CreatedAt
Datetime
No
Base date for query
Timezone
Windows or IANA
No
Timezone identifier
Pagination
-
Yes
PageNumber
Number
Yes
The respective page, starting at 1
ItemsPerPage
Number
Yes
The amount of items per page between 0 and 50
Response
CurrentPage
Number
Current page of transaction list
PageSize
Number
Number of items in page requested
TotalCount
Number
Number of total items queryable
Items
Id
Guid
Zum Rails Transaction Id
CreatedAt
Datetime
Created at date and time
SettlementDate
Date
Date funds settled
TransactionId
String
Card issuer transaction id
Description
String
Description of transaction
Status
String
Status of transaction
Debit
Number
Amount Debited
Credit
Number
Amount Credited
MerchantNameAndLocation
Number
Merchant name and location
CreatedAtOperator:
IsInTheLast
Between user creation date and now
ExactlyMatches
Exactly matches CreatedAt
IsBetween
Is between CreatedAtFrom and CreatedAtTo
IsAfter
Is after CreatedAt
IsOnOrAfter
Is on or after CreatedAt
IsBefore
Is before CreatedAt
IsBeforeOrOn
Is before or on CreatedAt
CardTransactionStatuses:
Posted
Posted transactions
Pending
Pre Auth Transactions
Declined
Declined Transcations
CardTransactionType:
POS
POS Purchase
ATM
Cash Withdrawal
Debit
Debit Transactions
Credit
Credit Transactions
Last updated
Was this helpful?