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}}

Request

{
    "UserId": "8ebd932b-...b92633e14297",
    "CardProgramId": "Customer_Card_Program"
}

Response

{
    "statusCode": 200,
    "message": "PATCH Request successful.",
    "isError": false,
    "result": {
        "ResponseDesc": "Operation is successful.",
        "ZumEvent": "ZumCardSuccess"
    }
}

Input Parameters

Parameter	Type	Mandatory	Description
UserId	Guid	Yes	User Id
CardProgramId	String	Yes	Card Program Id (Case Sensitive)

Response

Parameter	Type	Description
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

Request

{
    "UserId": "8ebd932b-...b92633e14297",
    "NewProgramId": "Customer_Card_Program"
}

Response

{
    "statusCode": 200,
    "message": "POST Request successful.",
    "isError": false,
    "result": {
        "CardReferenceId": "110195650197284",
        "NewProgramId": "Zumrail_test_prog",
        "ZumEvent": "ZumCardSuccess",
        "ResponseDesc": "Operation is successful."
    }
}

Input Parameters

Parameter	Type	Mandatory	Description
UserId	Guid	Yes	User Id
NewProgramId	String	Yes	New Card Program Id (Case Sensitive)

Response

Parameter	Type	Description
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

{
    "statusCode": 200,
    "message": "GET Request successful.",
    "isError": false,
    "result": {
        "ResponseDesc": "Operation is successful.",
        "AvailableBalance": 100,
        "LedgerBalance": 0,
        "ZumEvent": "ZumCardSuccess"
    }
}

Response

Parameter	Type	Description
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}}

Response

{
    "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

Parameter	Type	Mandatory	Description
UserId	Guid	Yes	User Id

Response

Parameter	Type	Description
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}}

Response

{
    "statusCode": 200,
    "message": "GET Request successful.",
    "isError": false,
    "result": {
        "CardStatus": "IssuedInactive",
        "ZumEvent": "ZumCardSuccess",
        "ResponseDesc": "Operation is successful."
    }
}

Input Parameters

Parameter	Type	Mandatory	Description
UserId	guid	Yes	User Id

Response

Parameter	Type	Description
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

{
    "UserId": "8ebd932b-...b92633e14297",
    "CardStatus": "FraudBlock"
}

Response

{
    "statusCode": 200,
    "message": "POST Request successful.",
    "isError": false,
    "result": {
        "CardStatus": "FraudBlock",
        "ZumEvent": "ZumCardSuccess",
        "ResponseDesc": "Operation is successful."
    }
}

Request Parameters

Parameter	Type	Required	Description
UserId	Guid	Yes	User Id
CardStatus	String	Yes	New Card Status

Response

Parameter	Type	Description
CardStatus	String	Card Status
ZumEvent	String	Zum event
ResponseDesc	String	Response description

Card Status

These are the available card status updates.

Status	Description
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.