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}}
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
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}}
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}}
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}}
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
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.
Last updated
Was this helpful?