Copyright © 2024, Oracle and/or its affiliates.
Field Index SQL Mapping

Class /topup

Object to hold the topup rules.When an event reduces the balances to go below a threshold, the TOPUP is invoked. The /topup object contains information as to when the last topup happened, how much has been topped up in this cycle, the topup cap and auto topup amounts.

Notes

  • This object can be read by the owner or any billing group leader within the brand who is an ancestor of the owner.
  • This object can be modified by the owner or any billing group leader within the brand who is an ancestor of the owner.
  • This object can be created by anyone.

Links



Field Index

Type Field Name
poid PIN_FLD_POID
timestamp PIN_FLD_CREATED_T
timestamp PIN_FLD_MOD_T
string PIN_FLD_READ_ACCESS
string PIN_FLD_WRITE_ACCESS
string PIN_FLD_CREATE_ACCESS
poid PIN_FLD_ACCOUNT_OBJ
decimal PIN_FLD_CYCLE_TOPPED_AMT
timestamp PIN_FLD_LAST_TOPUP_T
poid PIN_FLD_PAYINFO_OBJ
decimal PIN_FLD_TOPUP_AMT
decimal PIN_FLD_TOPUP_CAP
poid PIN_FLD_GROUP_OBJ
poid PIN_FLD_BILLINFO_OBJ
int PIN_FLD_GROUP_INDEX
int PIN_FLD_RESOURCE_ID
int PIN_FLD_TOPUP_INTERVAL
timestamp PIN_FLD_NEXT_TOPUP_T
int PIN_FLD_NUM_TOPUPS
int PIN_FLD_NUM_TOPUPS_DONE
enum PIN_FLD_STATUS
poid PIN_FLD_BAL_GRP_OBJ
enum PIN_FLD_TYPE


Field Details

poid PIN_FLD_POID

Object Identifier for an instance of this class. Portal object ids have four pieces of information: database number, class type, sequence id, revision.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

timestamp PIN_FLD_CREATED_T

Time the object was created.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

timestamp PIN_FLD_MOD_T

Time the object was last modified.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

string PIN_FLD_READ_ACCESS

Read Access level for object. Valid values are S(Self), G(Global), L(BrandLineage), B(BrandGroup), A(Ancestral).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

string PIN_FLD_WRITE_ACCESS

Write Access level for object. Valid values are S(Self), G(Global), L(BrandLineage), B(BrandGroup), A(Ancestral).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

string PIN_FLD_CREATE_ACCESS

Create Access level for object. Valid values are O(BrandOwner), R(Root), N(Any).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

poid PIN_FLD_ACCOUNT_OBJ

Account poid to which the /topup belongs.

Notes

  • Required on object creation
  • Can be modified

Links

decimal PIN_FLD_CYCLE_TOPPED_AMT

Sum of all topups during the current cycle. This will be populated only when topup cap is set.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_LAST_TOPUP_T

Time when the last topup happened. This will be populated only when topup cap is set.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_PAYINFO_OBJ

Payment method that needs to be used for topup.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_TOPUP_AMT

Amount to topup with incase of automatic (or threshold) topups.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_TOPUP_CAP

Total topup amount per cycle. If 0 then it is assumed that the cap is not specified.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_GROUP_OBJ

The group POID refers to the /group/topup to which this topup object belongs.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_BILLINFO_OBJ

Billinfo poid of the account to which the rule belongs.

Notes

  • Required on object creation
  • Can be modified

Links

int PIN_FLD_GROUP_INDEX

Optimization for the /gropup/topup to know where in the group array it falls.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_RESOURCE_ID

Resource which will be topped up for this topup object during recurring topups

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_TOPUP_INTERVAL

Interval that is scheduled between recurring topups

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_NEXT_TOPUP_T

Date on which next topup is due

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_NUM_TOPUPS

Maximum number of topups that can be done for this topup in recurring topupsIf this is 0 zero topup should be run forever.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_NUM_TOPUPS_DONE

Number of recurring topups done. When this reaches PIN_FLD_NUM_TOPUPS recurring topup will be stopped

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_STATUS

Status of the object can be PIN_STATUS_ACTIVE or PIN_STATUS_CLOSED.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_BAL_GRP_OBJ

Balance group in which sub-balances needs to be topped up.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_TYPE

Type of the topup, 0 - Auto, 1 - One-time, 2 - Recurring

Notes

  • Can be specified on object creation
  • Can be modified

Links



SQL Mapping


Type Field Name Table Column Name
base-class /topup topup_t
poid PIN_FLD_POID poid*
timestamp PIN_FLD_CREATED_T created_t
timestamp PIN_FLD_MOD_T mod_t
string PIN_FLD_READ_ACCESS read_access
string PIN_FLD_WRITE_ACCESS wrtie_access
string PIN_FLD_CREATE_ACCESS create_access
poid PIN_FLD_ACCOUNT_OBJ account_obj*
decimal PIN_FLD_CYCLE_TOPPED_AMT cycle_topped_amt
timestamp PIN_FLD_LAST_TOPUP_T last_topup_t
poid PIN_FLD_PAYINFO_OBJ payinfo_obj*
decimal PIN_FLD_TOPUP_AMT topup_amt
decimal PIN_FLD_TOPUP_CAP topup_cap
poid PIN_FLD_GROUP_OBJ group_obj*
poid PIN_FLD_BILLINFO_OBJ billinfo_obj*
int PIN_FLD_GROUP_INDEX group_index
int PIN_FLD_RESOURCE_ID resource_id
int PIN_FLD_TOPUP_INTERVAL topup_interval
timestamp PIN_FLD_NEXT_TOPUP_T next_topup_t
int PIN_FLD_NUM_TOPUPS num_topups
int PIN_FLD_NUM_TOPUPS_DONE topups_done
enum PIN_FLD_STATUS status
poid PIN_FLD_BAL_GRP_OBJ bal_grp_obj*
enum PIN_FLD_TYPE topup_type
Column names marked with * are actually column prefixes. For poid type fields, the column prefix is used to create the columns poid_id0, poid_db and poid_type if the prefix is "poid". For PIN_FLD_POID in the base table, an additional column named poid_rev is created to hold the poid revision. For buffer fields, two columns are created - one in the containing table and one in the buffer table. For example if the prefix is "buf", then the column name in the buffer table is buffer_buf and the column name in the containing table is buffer_size.

Field Index This Class