5 Voucher Recharges

Overview

Introduction

This chapter defines the CCS EDRs for voucher recharges.

Voucher Recharge Succeeds using Screens (EDR 4,15)

Introduction

Two or three EDRs are created for this event:

  • A type 4
  • A type 15
  • A type 16 when the Rewards plug-in is being used. See Rewards chapter for the EDR definition.

Mandatory EDR 4 fields

This list identifies the mandatory EDR record fields for voucher recharge succeeds using screens (EDR type 4):

  • ACCOUNT_TYPE (Product Type ID)
  • ACS_CUST_ID (ACS Customer ID)
  • BALANCE_TYPES (existing account)
  • BALANCES (pre-transaction account balances)
  • BATCH_DESCRIPTION (for voucher batch)
  • COSTS (rated calls)
  • CS (call status, S or D) (call status, S or D)
  • NEW_ACCT_EXPIRY (date after update)
  • NEW_BALANCE_EXPIRIES (dates after voucher recharge)
  • OLD_ACCT_EXPIRY (dates before update)
  • OLD_BALANCE_EXPIRIES (dates before voucher recharge)
  • TERMINAL (Network ID)
  • TYPE_DESCRIPTION (voucher type)
  • USER (operator logon name)

Optional EDR 4 fields

If they are not present, the ccsCDRLoader voucher plug-in does not process the EDR. For more information about ccsCDRLoader, see Process descriptions.

This list identifies the optional EDR record fields for voucher recharge succeeds using screens (EDR type 4):

  • REFERENCE (voucher freeform)
  • VOUCHER - one of:
    • VOUCHER (ID of redeemed voucher)
    • VOUCHER (serial number of redeemed voucher - 3.1.5)

Mandatory EDR 15 fields

This list identifies the mandatory EDR record fields for voucher recharge succeeds using screens (EDR type 15):

  • ACCOUNT_TYPE (Product Type ID)
  • ACS_CUST_ID (ACS Customer ID)
  • BALANCE_EXPIRIES (period hours)
  • BALANCE_TYPES (existing account)
  • COSTS (rated calls)
  • REDEEMING_ACCT_REF (ID of account)
  • RESULT (voucher redemption, always Success)
  • VOUCHER - one of:
    • VOUCHER (ID of redeemed voucher)
    • VOUCHER (serial number of redeemed voucher - 3.1.5)

Optional EDR 15 fields

This list identifies the optional EDR record fields for voucher recharge succeeds using screens (EDR type 15):

  • BATCH_DESCRIPTION (for voucher batch)
  • NEW_ACCOUNT (ID of account type)
  • OLD_ACCOUNT (ID of account type)
  • REDEEMING_ACCT_TYPE (name of account type)
  • SCENARIO (voucher scenario number)
  • TYPE_DESCRIPTION (voucher type)
  • REDEEMING_SUBSCRIBER_ID (subscriber ID)

Account Activated additional fields

If the account is activated, the following fields are generated:

  • NEW_ACCT_STATE (always active - A)
  • OLD_ACCT_STATE (P or D before update)

Reload Bonus additional fields

If the account has a promotional reload bonus configured, the following fields are generated (EDR types 4, 15 and 16):

  • RELOAD_BONUS (promotion name)
  • RELOAD_BONUS_AMOUNT (amount applied)
  • RELOAD_BONUS_EXPIRY (date remaining bonus expires)
  • RELOAD_BONUS_LEFT (bonus amount remaining)

MSISDN additional fields

If the MSISDN ccsCDRLoader plug-in is installed on the SMS, the following field will be present:

  • MSISDN (account calling number)

Example EDR 4

BILLING_ENGINE_ID=21|SCP_ID=110537566|SEQUENCE_NUMBER=139450184|CDR_TYPE=4|
RECORD_DATE=20040803152956|ACCT_ID=61|ACCT_REF_ID=61|ACS_CUST_ID=1|
VOUCHER=7609766|VOUCHER_NUMBER=0000000067|CS=S|USER=SU| ACCOUNT_TYPE=1|
BALANCE_TYPES=1|BALANCES=1001800|COSTS=-1000|NEW_BALANCE_EXPIRIES=|
OLD_BALANCE_EXPIRIES=0

Example EDR 15

BILLING_ENGINE_ID=21|SCP_ID=110537566|SEQUENCE_NUMBER=139450184|CDR_TYPE=15|
RECORD_DATE=20070719111321|ACCT_ID=61|ACCT_REF_ID=61|ACS_CUST_ID=1|REDEEMING_ACCT_REF=61|VOUCHER=7608766|VOUCHER_NUMBER=0000000067|RESULT=Success|BALANCE_TYPES=1|COSTS=-1000|BALANCE_EXPIRIES=|ACCOUNT_TYPE=24

If the useVoucherRedeemCDR parameter in the ccsCDRLoader section of eserv.config in SMS is set as true, then additional voucher related fields are also returned as shown in the below example: 

BILLING_ENGINE_ID=42|SCP_ID=55771394|SEQUENCE_NUMBER=0|CDR_TYPE=15|RECORD_DATE=20180328121357|ACCT_ID=3|ACCT_REF_ID=4|ACS_CUST_ID=21|REDEEMING_ACCT_REF=4|REDEEMING_ACCT_TYPE=21|RESULT=Success|VOUCHER=184|VOUCHER_NUMBER=60045|BALANCE_TYPES=78|COSTS=-10|BALANCE_EXPIRIES=|USER=SU|TERMINAL=10.191.235.82|WALLET_TYPE=5|BARCODE=12|TEXT=adding|CARD_DESIGN=90|DISTRIBUTOR_CHANNEL=fields|RETAIL_CHANNEL=for a|FREE_TEXT_FIELD_1=CDR|FREE_TEXT_FIELD_2=test|FREE_TEXT_FIELD_3=case|PROVISIONING_DATE=20180313091814

Note

The sequence of all fields output in an EDR is not guaranteed.

Voucher Recharge Succeeds using IVR (EDR 4,15)

Introduction

Two or three EDRs are created for this event:

  • A type 4
  • A type 15
  • A type 16 when the Rewards plug-in is being used. See Rewards chapter for the EDR definition.

Mandatory EDR 4 fields

This list identifies the mandatory EDR record fields for voucher recharge succeeds using IVR (EDR type 4):

  • ACCOUNT_TYPE (Product Type ID)
  • ACS_CUST_ID (ACS Customer ID)
  • BALANCE_TYPES (existing account)
  • BALANCES (pre-transaction account balances)
  • BATCH_DESCRIPTION (for voucher batch)
  • COSTS (rated calls)
  • CS (call status, S or D) (call status, S or D)
  • NEW_BALANCE_EXPIRIES (dates after voucher recharge)
  • OLD_BALANCE_EXPIRIES (dates before voucher recharge)
  • TYPE_DESCRIPTION (voucher type)
  • WALLET_TYPE (ID of wallet changed)

Optional EDR 4 fields

If they are not present, the ccsCDRLoader voucher plug-in does not process the EDR. For more information about ccsCDRLoader, see Process descriptions.

This list identifies the optional EDR record fields for voucher recharge succeeds using IVR (EDR type 4):

  • REFERENCE (voucher freeform)
  • VOUCHER - one of:
    • VOUCHER (ID of redeemed voucher)
    • VOUCHER (serial number of redeemed voucher - 3.1.5)

Mandatory EDR 15 fields

This list identifies the mandatory EDR record fields for voucher recharge succeeds using IVR (EDR type 15):

  • ACS_CUST_ID (ACS Customer ID)
  • BALANCE_EXPIRIES (period hours)
  • BALANCE_TYPES (existing account)
  • COSTS (rated calls)
  • REDEEMING_ACCT_REF (ID of account)
  • RESULT (voucher redemption, always Success)
  • VOUCHER - one of:
  • VOUCHER (ID of redeemed voucher)
  • VOUCHER (serial number of redeemed voucher - 3.1.5)

Optional EDR 15 fields

This list identifies the optional EDR record fields for voucher recharge succeeds using IVR (EDR type 15):

  • BATCH_DESCRIPTION (for voucher batch)
  • NEW_ACCOUNT (ID of account type)
  • OLD_ACCOUNT (ID of account type)
  • REDEEMING_ACCT_TYPE (name of account type)
  • SCENARIO (voucher scenario number)
  • TYPE_DESCRIPTION (voucher type)
  • REDEEMING_SUBSCRIBER_ID (subscriber ID)

Account Activated additional fields

If the account is activated, the following fields are generated:

  • NEW_ACCT_STATE (always active - A)
  • OLD_ACCT_STATE (P or D before update)

Reload Bonus additional fields

If the account has a promotional reload bonus configured, the following fields are generated (EDR types 4, 15 and 16):

  • RELOAD_BONUS (promotion name)
  • RELOAD_BONUS_AMOUNT (amount applied)
  • RELOAD_BONUS_EXPIRY (date remaining bonus expires)
  • RELOAD_BONUS_LEFT (bonus amount remaining)

MSISDN additional fields

If the MSISDN ccsCDRLoader plug-in is installed on the SMS, the following field will be present:

  • MSISDN (account calling number)

Example EDR 4

BILLING_ENGINE_ID=21|SCP_ID=366273322|SEQUENCE_NUMBER=488297|
CDR_TYPE=4|RECORD_DATE=20040804103532|ACCT_ID=61|ACCT_REF_ID=61|
ACS_CUST_ID=1|VOUCHER=7609766|VOUCHER_NUMBER=0000000081|CS=S|
 WALLET_TYPE=1|ACCOUNT_TYPE=1|BALANCE_TYPES=1|BALANCES=1005800| 
COSTS=-1000|NEW_BALANCE_EXPIRIES=|OLD_BALANCE_EXPIRIES=0

Example EDR 15

BILLING_ENGINE_ID=21|SCP_ID=366273322|SEQUENCE_NUMBER=488297|
CDR_TYPE=15|RECORD_DATE=20040803152952|ACCT_ID=61|ACCT_REF_ID=61|
ACS_CUST_ID=1|REDEEMING_ACCT_REF=61|VOUCHER=7609766|VOUCHER_NUMBER=0000000081| RESULT=Success

Note

The sequence of all fields output in an EDR is not guaranteed.

Voucher Recharge Succeeds using PI (EDR 4,15)

Introduction

Two or three EDRs are created for this event:

  • A type 4
  • A type 15
  • A type 16 when the Rewards plug-in is being used.. See Rewards chapter for the EDR definition.

Mandatory EDR 4 fields

This list identifies the mandatory EDR record fields for voucher recharge succeeds using PI (EDR type 4):

  • ACCOUNT_TYPE (Product Type ID)
  • ACS_CUST_ID (ACS Customer ID)
  • BALANCE_TYPES (existing account)
  • BALANCES (pre-transaction account balances)
  • COSTS (rated calls)
  • CS (call status, S or D) (call status, S or D)
  • NEW_BALANCE_EXPIRIES (dates after voucher recharge)
  • OLD_BALANCE_EXPIRIES (dates before voucher recharge)
  • PI (logon name and IP address)
  • TYPE_DESCRIPTION (voucher type)
  • WALLET_TYPE (ID of wallet changed)

Optional EDR 4 fields

If they are not present, the ccsCDRLoader voucher plug-in does not process the EDR. For more information about ccsCDRLoader, see Process descriptions.

This list identifies the optional EDR record fields for voucher recharge succeeds using PI (EDR type 4):

  • REFERENCE (voucher freeform)
  • VOUCHER - one of:
    • VOUCHER (ID of redeemed voucher)
    • VOUCHER (serial number of redeemed voucher - 3.1.5)

Mandatory EDR 15 fields

This list identifies the mandatory EDR record fields for voucher recharge succeeds using PI (EDR type 15):

  • ACS_CUST_ID (ACS Customer ID)
  • BALANCE_EXPIRIES (period hours)
  • BALANCE_TYPES (existing account)
  • COSTS (rated calls)
  • REDEEMING_ACCT_REF (ID of account)
  • RESULT (voucher redemption, always Success)
  • VOUCHER - one of:
    • VOUCHER (ID of redeemed voucher)
    • VOUCHER (serial number of redeemed voucher - 3.1.5)

Optional EDR 15 fields

This list identifies the optional EDR record fields for voucher recharge succeeds using PI (EDR type 15):

  • BATCH_DESCRIPTION (for voucher batch)
  • NEW_ACCOUNT (ID of account type)
  • OLD_ACCOUNT (ID of account type)
  • REDEEMING_ACCT_TYPE (name of account type)
  • SCENARIO (voucher scenario number)
  • TYPE_DESCRIPTION (voucher type)
  • REDEEMING_SUBSCRIBER_ID (subscriber ID)

Account Activated additional fields

If the account is activated, the following fields are generated:

  • NEW_ACCT_STATE (always active - A)
  • OLD_ACCT_STATE (P or D before update)

Reload Bonus additional fields

If the account has a promotional reload bonus configured, the following fields are generated (EDR types 4, 15 and 16):

  • RELOAD_BONUS (promotion name)
  • RELOAD_BONUS_AMOUNT (amount applied)
  • RELOAD_BONUS_EXPIRY (date remaining bonus expires)
  • RELOAD_BONUS_LEFT (bonus amount remaining)

MSISDN additional fields

If the MSISDN ccsCDRLoader plug-in is installed on the SMS, the following field will be present:

  • MSISDN (account calling number)

Example EDR 4

BILLING_ENGINE_ID=21|SCP_ID=161986004|SEQUENCE_NUMBER=2|CDR_TYPE=4|
RECORD_DATE=20040804111124|ACCT_ID=61|ACCT_REF_ID=61|ACS_CUST_ID=1|
VOUCHER=7609766|VOUCHER_NUMBER=0000000086|CS=S|PI=adminAT192.168.25.106|
 WALLET_TYPE=1|ACCOUNT_TYPE=1|BALANCE_TYPES=1|BALANCES=1006800|
COSTS=-1000|NEW_BALANCE_EXPIRIES=|OLD_BALANCE_EXPIRIES=0

Example EDR 15

BILLING_ENGINE_ID=21|SCP_ID=161986004|SEQUENCE_NUMBER=2|
CDR_TYPE=15|RECORD_DATE=20040803152952|ACCT_ID=61|ACCT_REF_ID=61|
ACS_CUST_ID=1|REDEEMING_ACCT_REF=61|VOUCHER=7609766|VOUCHER_NUMBER=0000000086|RESULT=Success

Note

The sequence of all fields output in an EDR is not guaranteed.

Voucher Recharge Succeeds using USSD (EDR 4,15)

Introduction

Two or three EDRs are created for this event:

  • A type 4
  • A type 15
  • A type 16 when the Rewards plug-in is being used. See the Rewards chapter for the EDR definition.

Mandatory EDR 4 fields

This list identifies the mandatory EDR record fields for voucher recharge succeeds using USSD (EDR type 4):

  • ACCOUNT_TYPE (Product Type ID)
  • ACS_CUST_ID (ACS Customer ID)
  • BALANCE_TYPES (existing account)
  • BALANCES (pre-transaction account balances)
  • COSTS (rated calls)
  • CS (call status, S or D) (call status, S or D)
  • NEW_BALANCE_EXPIRIES (dates after voucher recharge)
  • OLD_BALANCE_EXPIRIES (dates before voucher recharge)
  • TYPE_DESCRIPTION (voucher type)
  • WALLET_TYPE (ID of wallet changed)

Optional EDR 4 fields

If they are not present, the ccsCDRLoader voucher plug-in does not process the EDR. For more information about ccsCDRLoader, see Process descriptions.

This list identifies the optional EDR record fields for voucher recharge succeeds using USSD (EDR type 4):

  • REFERENCE (voucher freeform)
  • VOUCHER - one of:
    • VOUCHER (ID of redeemed voucher)
    • VOUCHER (serial number of redeemed voucher - 3.1.5)

Mandatory EDR 15 fields

This list identifies the mandatory EDR record fields for voucher recharge succeeds using USSD (EDR type 15):

  • ACS_CUST_ID (ACS Customer ID)
  • BALANCE_EXPIRIES (period hours)
  • BALANCE_TYPES (existing account)
  • COSTS (rated calls)
  • REDEEMING_ACCT_REF (ID of account)
  • RESULT (voucher redemption, always Success)
  • VOUCHER - one of:
    • VOUCHER (ID of redeemed voucher)
    • VOUCHER (serial number of redeemed voucher - 3.1.5)

Optional EDR 15 fields

This list identifies the optional EDR record fields for voucher recharge succeeds using USSD (EDR type 15):

  • BATCH_DESCRIPTION (for voucher batch)
  • NEW_ACCOUNT (ID of account type)
  • OLD_ACCOUNT (ID of account type)
  • REDEEMING_ACCT_TYPE (name of account type)
  • SCENARIO (voucher scenario number)
  • TYPE_DESCRIPTION (voucher type)
  • REDEEMING_SUBSCRIBER_ID (subscriber ID)

Account Activated additional fields

If the account is activated, the following fields are generated:

  • NEW_ACCT_STATE (always active - A)
  • OLD_ACCT_STATE (P or D before update)

Reload Bonus additional fields

If the account has a promotional reload bonus configured, the following fields are generated (EDR types 4, 15 and 16):

  • RELOAD_BONUS (promotion name)
  • RELOAD_BONUS_AMOUNT (amount applied)
  • RELOAD_BONUS_EXPIRY (date remaining bonus expires)
  • RELOAD_BONUS_LEFT (bonus amount remaining)

MSISDN additional fields

If the MSISDN ccsCDRLoader plug-in is installed on the SMS, the following field will be present:

  • MSISDN (account calling number)

Example EDR 4

BILLING_ENGINE_ID=1|SCP_ID=114207220|SEQUENCE_NUMBER=139450184|CDR_TYPE=4|
RECORD_DATE=20041216162449|ACCT_ID=46|ACCT_REF_ID=46|ACS_CUST_ID=1|
VOUCHER=7609766|VOUCHER_NUMBER=23439221779469|CS=S|
USSD=VOUCHER_REDEEMED|ACCOUNT_TYPE=23|BALANCE_TYPES=1|
BALANCES=113495,113495|COSTS=1,-20500|NEW_BALANCE_EXPIRIES=,|
OLD_BALANCE_EXPIRIES=0,0|RELOAD_BONUS_AMOUNT=500|
RELOAD_BONUS_LEFT=113494

Example EDR 15

BILLING_ENGINE_ID=21|SCP_ID=161986004|SEQUENCE_NUMBER=2|
CDR_TYPE=15|RECORD_DATE=20040803152952|ACCT_ID=61|
ACCT_REF_ID=61| ACS_CUST_ID=1| REDEEMING_ACCT_REF=61|
VOUCHER=7609766|VOUCHER_NUMBER=0000000086| RESULT=Success

Note

The sequence of all fields output in an EDR is not guaranteed.

Voucher Recharge Fails using Screens or IVR (EDR 4)

Introduction

In this scenario, recharge fails because the account is in either a frozen or suspended state.

A type 4 EDR is created for this event.

Mandatory EDR 4 fields

This list identifies the mandatory EDR record fields for voucher recharge failures using screens or IVR (EDR type 4):

  • ACCOUNT_TYPE (Product Type ID)
  • ACS_CUST_ID (ACS Customer ID)
  • BATCH_DESCRIPTION (for voucher batch)
  • CS (call status, always D)
  • NACK (long list of codes)
  • RESULT (frozen or suspended)
  • TERMINAL (Network ID)
  • TYPE_DESCRIPTION (voucher type)
  • USER (operator logon name)

Optional EDR 4 fields

If they are not present, the ccsCDRLoader voucher plug-in does not process the EDR. For more information about ccsCDRLoader, see Process descriptions.

This list identifies the optional EDR record fields for voucher recharge failures using screens or IVR (EDR type 4):

  • REFERENCE (voucher freeform)
  • SCENARIO (voucher scenario number)
  • VOUCHER - one of:
    • VOUCHER (ID of redeemed voucher)
    • VOUCHER (serial number of redeemed voucher - 3.1.5)

MSISDN additional fields

If the MSISDN ccsCDRLoader plug-in is installed on the SMS, the following field will be present:

  • MSISDN (account calling number)

Example EDR 4

BILLING_ENGINE_ID=21|SCP_ID=110537566|SEQUENCE_NUMBER=139450184|CDR_TYPE=4|
RECORD_DATE=20040804105430|ACCT_ID=61|ACCT_REF_ID=61|ACS_CUST_ID=1|
VOUCHER=7609766|VOUCHER_NUMBER=0000000085|CS=D|RESULT=Frozen Wallet

Note

The sequence of all fields output in an EDR is not guaranteed.

Voucher Recharge Fails using Screens or IVR (EDR 15,33)

Introduction

The recharge fails because the voucher details entered are invalid or the voucher is in an invalid state. There are two EDR records created for this event:

  • A EDR of type 15
  • A EDR of type 33

Mandatory EDR 15 fields

This list identifies the mandatory EDR record fields for voucher recharge failure using screens or IVR (EDR type 15):

  • ACCOUNT_TYPE (Product Type ID)
  • ACS_CUST_ID (ACS Customer ID)
  • REDEEMING_ACCT_REF (ID of account)
  • RESULT (general cause)
  • VOUCHER - one of:
    • VOUCHER (ID of redeemed voucher)
    • VOUCHER (serial number of redeemed voucher - 3.1.5)
    • VOUCHER_NUMBER (redeemed voucher)

Optional EDR 15 fields

This list identifies the optional EDR record fields for voucher recharge failures using screens or IVR (EDR type 15):

  • BATCH_DESCRIPTION (for voucher batch)
  • TERMINAL (Network ID)
  • TYPE_DESCRIPTION (voucher type)
  • USER (operator logon name)
  • REDEEMING_SUBSCRIBER_ID (subscriber ID)

Mandatory EDR 33 fields

This list identifies the mandatory EDR record fields for voucher recharge failure using screens or IVR (EDR type 33):

  • ACS_CUST_ID
  • BAD_PINS
  • TERMINAL
  • USER

Optional EDR 33 fields

This list identifies the optional EDR record fields for voucher recharge failures using screens or IVR, when the account is frozen due to the maximum number of bad pins being exceeded (EDR type 33):

  • NEW_ACCT_STATE (frozen)
  • OLD_ACCT_STATE (active)

MSISDN additional fields

If the MSISDN ccsCDRLoader plug-in is installed on the SMS, the following field will be present:

  • MSISDN (account calling number)

Example

BILLING_ENGINE_ID=21|SCP_ID=366273322|SEQUENCE_NUMBER=488298|CDR_TYPE=15|RECORD_DATE=20070719113914|ACCT_ID=61|ACCT_REF_ID=61|ACS_CUST_ID=1|REDEEMING_ACCT_REF=61|VOUCHER=8709766|VOUCHER_NUMBER=0000000086|BATCH_DESCRIPTION=Test Batch|TYPE_DESCRIPTION=STANDARD|RESULT=Failed Auth|ACCOUNT_TYPE=24|USER=SU|TERMINAL=192.168.25.108

Example EDR 33

BILLING_ENGINE_ID=21|SCP_ID=366273322|SEQUENCE_NUMBER=488298|CDR_TYPE=33|RECORD_DATE=20070703145823|ACCT_ID=61|ACCT_REF_ID=61|BAD_PINS=1|ACS_CUST_ID=1|ACCOUNT_TYPE=24|USER=SU|TERMINAL=192.168.25.108

Note

The sequence of all fields output in an EDR is not guaranteed.

Voucher Type Recharge

Introduction

A type 47 EDR is created for this event.

Note: The type 47 EDR contains fields identical to a type 4. It is given its own EDR number because it is handled differently from a normal voucher recharge. A type 4 EDR generates a recharge notification from the EDR loader plug-in. In the case of the type 47, the notification is generated by the process calling it. This process can be a control plan, periodic charge or a credit transfer.

Mandatory EDR 47 fields

This list identifies the mandatory EDR record fields for voucher type recharge (EDR type 47):

  • ACCOUNT_TYPE (Product Type ID)
  • ACS_CUST_ID (ACS Customer ID)
  • BALANCE_TYPES (existing account)
  • BALANCES (pre-transaction account balances)
  • COSTS (rated calls)
  • CS (call status, S or D) (call status, S or D)
  • NEW_BALANCE_EXPIRIES (dates after voucher recharge)
  • OLD_BALANCE_EXPIRIES (dates before voucher recharge)
  • VOUCHER_TYPE (name)

Optional EDR 47 fields

This list identifies the optional EDR record fields for voucher type recharge (EDR type 47):

  • NEW_ACCT_TYPE (ID of account after recharge)
  • OLD_ACCT_TYPE (ID of account before recharge)