Get Limits for an Account or Balance Group
get
/bcws/webresources/v1.0/accounts/{id}/limits
Get limits for an account or balance group
Request
Path Parameters
-
id(required): string
The id of account.
Query Parameters
-
balanceGroupId(required): string
The balance group id to retrieve the associated limits, this is an optional field
-
endDate(required): string
The valid to date, this is an optional field
-
resourceId(required): string
The resource id, this is an optional field
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The balance group information was returned successfully.
Root Schema : BalanceGroup
Type:
Show Source
object
-
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
Nested Schema : balances
Type:
array
The list of balances associated with the balance group.
Show Source
-
Array of:
object Balances
The list of balances associated with the balance group.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Balances
Type:
object
The list of balances associated with the balance group.
Show Source
-
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
Nested Schema : SubBalances
Type:
Show Source
object
-
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.
-
rolloverData: integer
(int32)
Details about a rollover subbalance.
-
validFrom: string
(date-time)
The date and time the validity period starts.
-
validTo: string
(date-time)
The date and time the validity period ends.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : TempCreditLimit
Type:
Show Source
object
-
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.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ServiceType
Type:
Show Source
object
-
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.
-
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
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : aliasList
Type:
array
The list of aliases associated with the service.
Show Source
-
Array of:
object AliasList
The list of aliases associated with the service.
Nested Schema : extension
Type:
object
The extended attributes.
500 Response
An internal server error occurred.