To implement the automatic standard top-up feature:
1. In the Pricing Center, set a credit floor and credit threshold for any plan that contains deals whose service balances you want your customers to top up. For example, to trigger an automatic standard top-up when an account balance falls below $30, set the credit floor to -100 and the threshold to 70%.
For more information, see "About Credit Thresholds and Credit Floors" in BRM Setting Up Pricing and Rating.
2. Configure your custom client application to accept the following top-up information:
■ Payment method
To specify the payment method for automatic standard top-ups, set the appropriate value in the PIN_FLD_PAYINFO field in the PIN_FLD_TOPUP_ INFO array of the called opcode’s input flist (see step 3 for opcode names). See "Standard Top-Up Payment Methods".
■ Automatic top-up amount
To specify the payment amount of each automatic standard top-up, set the appropriate value in the PIN_FLD_TOPUP_AMT field in the PIN_FLD_ TOPUP_INFO array of the called opcode’s input flist.
■ Automatic top-up cap
Note: To apply the voucher top up to a service-level balance group, you must pass the /service object POID in the PIN_FLD_SERVICE_OBJ field of the PIN_FLD_VOUCHERS_INFO array.
Implementing Top-Ups in Custom Client Applications
To specify the aggregate amount of automatic standard top-ups that the account can receive during an accounting cycle, set the appropriate value in the PIN_FLD_TOPUP_CAP field in the PIN_FLD_TOPUP_INFO array of the called opcode’s input flist.
■ Bill unit to top up
To specify the bill unit (/billinfo object) that contains the balance to top up, set the appropriate value in the PIN_FLD_BILLINFO field in the PIN_FLD_ TOPUP_INFO array of the called opcode’s input flist.
3. Pass the information to one of these opcodes:
■ PCM_OP_CUST_COMMIT_CUSTOMER when creating accounts
■ PCM_OP_CUST_UPDATE_CUSTOMER when modifying accounts
For more information, see "How BRM Sets Up Top-Up Information for an Account".
Implementing Manual Sponsored Top-Ups
To implement the manual sponsored top-up feature:
1. Configure your custom client application to accept the following top-up information:
■ The POID of the account that initiates the creation or modification of the
top-up configuration. Set this value in the level-one PIN_FLD_POID field of the called opcode’s input flist (see step 2 for opcode names).
■ The POID of the account that will receive the top-ups (the member account).
Set this value in the PIN_FLD_ACCOUNT_OBJ field in the PIN_FLD_ TOPUP_INFO array of the called opcode’s input flist.
■ The POID of the /topup object associated with the account that will receive the
top-ups. If the account does not have a /topup object, specify the POID type. Set this value in the PIN_FLD_POID field in the PIN_FLD_TOPUP_INFO array of the called opcode’s input flist.
■ Group to add member to
To specify the sponsored top-up group to add the member account to, set the POID of the appropriate /group/topup object in the PIN_FLD_POID field in the PIN_FLD_GROUP_TOPUP_INFO array of the called opcode’s input flist. If the object does not exist, pass the POID type.
For information about how BRM searches for existing groups if the POID is not specified, see "Finding Sponsored Top-Up Groups".
■ Group name
To specify the name of the sponsored top-up group, set the appropriate value in the PIN_FLD_NAME field in the PIN_FLD_GROUP_TOPUP_INFO array of the called opcode’s input flist.
If you do not specify a group name, the group will be named default. See
"Finding Sponsored Top-Up Groups".
Note: Both of these opcodes call PCM_OP_CUST_SET_TOPUP, which is a wrapper opcode that calls other standard opcodes to set up or modify top-up information.
Implementing Top-Ups in Custom Client Applications
■ Group owner
To specify the sponsored top-up group owner account, set the POID of the owner account in the PIN_FLD_PARENT field in the PIN_FLD_GROUP_ TOPUP_INFO array of the called opcode’s input flist.
■ Paying balance group
To specify the owner account’s balance group to transfer top-up resources from, set the POID of the balance group in the PIN_FLD_BAL_GRP_OBJ field in the PIN_FLD_GROUP_TOPUP_INFO array of the called opcode’s input flist.
■ Resources to top up
To specify the resources to be topped up in the member account, set the IDs of the appropriate currency and non-currency resources in the PIN_FLD_
RESOURCE_ID fields in the PIN_FLD_GROUP_TOPUP_LIMITS array of the called opcode’s input flist.
■ Resource top-up cap
To specify the maximum amount of a resource that the owner can transfer to its members during the owner’s accounting cycle, set the appropriate value in the resource’s PIN_FLD_TOPUP_CAP field in the PIN_FLD_GROUP_
TOPUP_LIMITS array.
■ Receiving balance group
To specify the member account’s balance group to transfer sponsored top-ups to, set the POID of the balance group in the member’s PIN_FLD_BAL_GRP_ OBJ field in the PIN_FLD_GROUP_TOPUP_MEMBERS array of the called opcode’s input flist.
■ Top-up PIN
To specify the member’s sponsored top-up PIN, set the appropriate value in the PIN_FLD_PIN field in the PIN_FLD_GROUP_TOPUP_MEMBERS array of the called opcode’s input flist. See "About member top-up PINs".
■ Top-up status
To specify the member’s sponsored top-up status, set the appropriate value in the PIN_FLD_STATUS field in the PIN_FLD_GROUP_TOPUP_MEMBERS array of the called opcode’s input flist. See "About Member Status".
2. Pass the information to one of these opcodes:
■ PCM_OP_CUST_COMMIT_CUSTOMER when creating accounts
■ PCM_OP_CUST_UPDATE_CUSTOMER when modifying accounts
Important: This cap applies to the sum of all top-ups in the group, not to an individual member’s top-ups. The cap should not exceed the credit limit of the paying balance group. See "About Sponsored Top-Up Credit Limits".
Note: Both of these opcodes call PCM_OP_CUST_SET_TOPUP, which is a wrapper opcode that calls other standard opcodes to set up or modify top-up information.