• balances: array balances
  The list of balances associated with the balance group.
• elem: integer (int32)
  The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
• extension: object extension
  The extended attributes.
• id(required): string
  The ID.
• monitorType: string
  The monitoring group type. Allowed Values:

  • H_CE (Hierarchy Credit Exposure)
  • PR_CE (Payment Responsible Credit Exposure)
  • SUB_CE (Subscription Credit Exposure)
  • PR_RTCE (Payment Responsible Real-Time Credit Enforcement)
• name: string
  The name of the balance group.
• services: array services

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The name of the balance group."
        },
        "services":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceType"
            }
        },
        "monitorType":{
            "type":"string",
            "description":"The monitoring group type. Allowed Values: <ul><li><b>H_CE</b> (Hierarchy Credit Exposure)</li><li><b>PR_CE</b> (Payment Responsible Credit Exposure)</li><li><b>SUB_CE</b> (Subscription Credit Exposure)</li><li><b>PR_RTCE</b> (Payment Responsible Real-Time Credit Enforcement)</li></ul>"
        },
        "balances":{
            "type":"array",
            "description":"The list of balances associated with the balance group.",
            "items":{
                "$ref":"#/components/schemas/Balances"
            }
        },
        "elem":{
            "type":"integer",
            "description":"The position of the entry in the array. For example, the first item in a list would have an <b>elem</b> value of <b>1</b>.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    }
}

• Array of: object Balances
  The list of balances associated with the balance group.

{
    "type":"array",
    "description":"The list of balances associated with the balance group.",
    "items":{
        "$ref":"#/components/schemas/Balances"
    }
}

• Array of: object ServiceType

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceType"
    }
}

• creditFloor: number
  The credit floor associated with the balance.
• creditLimit: number
  The credit limit associated with the balance.
• creditThresholds: integer (int32)
  The credit thresholds associated with the balance.
• creditThresholdsFixed: string
  The value at which to send a notification, such as 30 US dollars or 30 minutes.
• currentBalance(required): number
  The current balance.
• dynamicCreditFloor: boolean
  Whether to use a dynamic credit floor (true) or not (false). The default is false.
• expiredBeforeUsing: number
  The number of days until the balance expires.
• formattedCreditThresholds: string
  The balance percentage usage at which to notify the customer.
• loanThresholds: integer (int32)
  The percent-based threshold for offering a loan. If the customer's balance falls below this percent, they are notified and offered a loan.
• loanThresholdsFixed: string
  The fixed amount threshold for offering a loan. If the customer's balance falls below this amount, they are notified and offered a loan.
• modifyLimit: boolean
  Whether a credit limit is being modified by the request (true) or not (false).
• outstandingAmount(required): number
  An amount that the customer still owes, for loans or when they exceed their credit limit.
• overrideCreditLimit: integer (int32)
  Whether to override the credit limit. Allowed Values: 0 (Enforce Credit Limit) or 1 (Override credit limit).
• resourceId: integer (int32)
  The resource ID associated with the balance.
• subBalances: array subBalances
• tempCreditLimit: array tempCreditLimit

{
    "required":[
        "currentBalance",
        "outstandingAmount"
    ],
    "type":"object",
    "properties":{
        "modifyLimit":{
            "type":"boolean",
            "description":"Whether a credit limit is being modified by the request (<b>true</b>) or not (<b>false</b>)."
        },
        "currentBalance":{
            "type":"number",
            "description":"The current balance."
        },
        "dynamicCreditFloor":{
            "type":"boolean",
            "description":"Whether to use a dynamic credit floor (<b>true</b>) or not (<b>false</b>). The default is <b>false</b>."
        },
        "creditFloor":{
            "type":"number",
            "description":"The credit floor associated with the balance."
        },
        "creditLimit":{
            "type":"number",
            "description":"The credit limit associated with the balance."
        },
        "overrideCreditLimit":{
            "type":"integer",
            "description":"Whether to override the credit limit. Allowed Values: <b>0</b> (Enforce Credit Limit) or <b>1</b> (Override credit limit).",
            "format":"int32"
        },
        "creditThresholds":{
            "type":"integer",
            "description":"The credit thresholds associated with the balance.",
            "format":"int32"
        },
        "formattedCreditThresholds":{
            "type":"string",
            "description":"The balance percentage usage at which to notify the customer."
        },
        "creditThresholdsFixed":{
            "type":"string",
            "description":"The value at which to send a notification, such as 30 US dollars or 30 minutes."
        },
        "expiredBeforeUsing":{
            "type":"number",
            "description":"The number of days until the balance expires."
        },
        "subBalances":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubBalances"
            }
        },
        "outstandingAmount":{
            "type":"number",
            "description":"An amount that the customer still owes, for loans or when they exceed their credit limit."
        },
        "loanThresholds":{
            "type":"integer",
            "description":"The percent-based threshold for offering a loan. If the customer's balance falls below this percent, they are notified and offered a loan.",
            "format":"int32"
        },
        "loanThresholdsFixed":{
            "type":"string",
            "description":"The fixed amount threshold for offering a loan. If the customer's balance falls below this amount, they are notified and offered a loan."
        },
        "tempCreditLimit":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TempCreditLimit"
            }
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID associated with the balance.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of balances associated with the balance group."
}

• Array of: object SubBalances

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubBalances"
    }
}

• Array of: object TempCreditLimit

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TempCreditLimit"
    }
}

• currentBalance: number
  The current amount of the sub-balance.
• elementId: integer (int32)
  The ID of the element.
• expiredBeforeUsing: number
  The number of days until the sub-balance expires.
• extension: object extension
  The extended attributes.
• originalBalance: number
  The original balance of the sub-balance.
• rolloverData: integer (int32)
  Indicates whether the leftover balance in this bucket will be rolled over, and if so, how.
• validFrom: string (date-time)
  The date and time the validity period starts.
• validTo: string (date-time)
  The date and time the validity period ends.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "currentBalance":{
            "type":"number",
            "description":"The current amount of the sub-balance."
        },
        "originalBalance":{
            "type":"number",
            "description":"The original balance of the sub-balance."
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time the validity period starts.",
            "format":"date-time"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time the validity period ends.",
            "format":"date-time"
        },
        "rolloverData":{
            "type":"integer",
            "description":"Indicates whether the leftover balance in this bucket will be rolled over, and if so, how.",
            "format":"int32"
        },
        "expiredBeforeUsing":{
            "type":"number",
            "description":"The number of days until the sub-balance expires."
        },
        "elementId":{
            "type":"integer",
            "description":"The ID of the element.",
            "format":"int32"
        }
    }
}

• extension: object extension
  The extended attributes.
• limit: number
  The temporary credit limit amount.
• resourceId: integer (int32)
  The resource ID associated with the temporary credit limit.
• validFrom(required): string (date-time)
  The date and time temporary credit limit's validity starts.
• validFromOffset: integer (int32)
  The offset for the temporary credit limit's validity period start.
• validFromUnit: integer (int32)
  The unit for the temporary credit limit's validity period start.
• validTo(required): string (date-time)
  The date and time temporary credit limit's validity ends.
• validToOffset: integer (int32)
  The offset for the temporary credit limit's validity period end.
• validToUnit: integer (int32)
  The unit for the temporary credit limit's validity period end.

{
    "required":[
        "validFrom",
        "validTo"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "limit":{
            "type":"number",
            "description":"The temporary credit limit amount."
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID associated with the temporary credit limit.",
            "format":"int32"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity ends.",
            "format":"date-time"
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity starts.",
            "format":"date-time"
        },
        "validToUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validToOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validFromUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period start.",
            "format":"int32"
        },
        "validFromOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period start.",
            "format":"int32"
        }
    }
}

• accountRef: object ResourceRef
• aliasList: array aliasList
  The list of aliases associated with the service.
• balanceGroupRef: object ResourceRef
• balGrpIndex: integer (int32)
  The balance group index.
• creationDate: string (date-time)
  The date and time the service type was created.
• effectiveDate: string (date-time)
• extension: object extension
  The extended attributes.
• id: object ResourceRef
• lastModified: string (date-time)
  The date and time the service was last modified.
• lastStatusChange: string (date-time)
  The date and time of the last status change.
• lastStatusComment: string
  The comment associated with the last status change.
• lifeCycleState: integer (int32)
  The current life cycle state.
• login(required): string
  The login associated with the service.
• name: string
  The name of the service.
• nameinfoObj: object ResourceRef
• password(required): string
  The password associated with the service.
• passwordExpiration: string (date-time)
  The date and time the password expires.
• passwordStatus: integer (int32)
  The current status of the password.
• pendingDeferredActionsCount: integer (int32)
  The number of deferred actions that are pending for the service.
• serviceAccessLevel: string
  The service access level.
• status: integer (int32)
  The status.
• statusFlags: integer (int32)
  The status flags.
• subscriptionServiceRef: object ResourceRef
• svcExpLastNotiOffset: string
  The notification offset.
• svcExpLastNotiT: string (date-time)
  The last notification time.

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    }
}

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

• Array of: object AliasList
  The list of aliases associated with the service.

{
    "type":"array",
    "description":"The list of aliases associated with the service.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

• elem: integer (int32)
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "elem":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of aliases associated with the service."
}