Create a Top-up Balance
/topupBalance
Request
There are no request parameters for this operation.
- application/json;charset=utf-8
object
Topup Balance Create
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
amount(required): object
object
Quantity
Title:
Quantity
The quantity of an object. -
bucket: object
object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
channel: object
object
ChannelRef
A reference to a channel.
-
confirmationDate: string
(date-time)
The date the top-up was confirmed.
-
description: string
Title:
Description
The top-up's description. -
impactedBucket: array
array
impactedBucket
A reference to buckets impacted by the request.
-
isAutoTopup: boolean
Title:
Is Auto Topup
Whether the top-up is automatic (true) or not (false). -
logicalResource: object
object
Logical Resource Ref
Title:
Logical Resource Ref
A reference to a logical resource. -
numberOfPeriods: integer
Title:
Number of Periods
The number of billing periods for which an automatic top-up occurs. If this property is not specified, then the top-up will continue automatically indefinitely. -
partyAccount: object
object
Party Account Ref
Title:
Party Account Ref
A reference to a party account. -
payment: object
object
PaymentRef
A payment received at order time.
-
paymentMethod: object
object
Payment Method Ref
Title:
Payment Method Ref
A reference to a payment method. -
product: object
object
Product Ref
Title:
Product Ref
A reference to a product. -
reason: string
Title:
Reason
The reason for the top-up. -
recurringPeriod: string
The type of recurring period for the top-up.
- relatedParty: array array relatedParty
- relatedTopupBalance: object object Related Topup Balance
-
requestedDate: string
(date-time)
The date the top-up request was made.
-
requestor: object
object
Related Party
Title:
Related Party
A party related to another object. -
status: string
The request's status.
-
usageType: string
The top-up's usage type.
-
voucher: string
Title:
Voucher
The voucher used for the top-up.
object
Quantity
-
amount: number
(float)
Title:
Amount
Default Value:1
A numeric value. -
units: string
Title:
Units
A unit. For example, MB or minutes.
object
Bucket Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
(uri)
The bucket's href.
-
id(required): string
Title:
Bucket ID
The bucket's ID. -
name: string
Title:
Bucket Name
The bucket's name. -
usageType: string
The bucket's usage type.
object
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Channel Href
The channel's href. -
id(required): string
Title:
Channel ID
The channel's ID. -
name: string
Title:
Channel Name
The channel's name.
array
-
Array of:
object ImpactedBucket
A bucket impacted by a balance top-up, adjustment, transfer, or reservation.
object
Logical Resource Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Href
The resource's href. -
id(required): string
Title:
ID
The resource's ID. -
name: string
Title:
Name
The resource's name. -
value: string
The resource's value.
object
Party Account Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
description: string
Title:
Description
The party account's description. -
href: string
Title:
Href
The party account's href. -
id(required): string
Title:
Account ID
The party account's ID. -
name: string
Title:
Name
The party account's name. -
status: string
Title:
Status
The overall status of the account. For example, due, paid, or in arrears.
object
-
@baseType: string
The object's superclass.
-
@referredType: string
The object's type in the target system, if baseType and type need further disambiguation.
-
@schemaLocation: string
(uri)
A URI to a JSON schema file that defines additional attributes and relationships.
-
@type: string
The object's subclass.
-
href: string
(uri)
The payment's href.
-
id(required): string
The payment's ID.
-
name: string
The payment's name.
object
Payment Method Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
The object's type in the target system, if baseType and type need further disambiguation.
-
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
(uri)
Title:
Href
The payment method's href. -
id(required): string
Title:
ID
The payment method's ID. -
name: string
Title:
Name
The payment method's name.
object
Product Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Product Href
The product's href. -
id(required): string
Title:
Product ID
The product's ID. -
name: string
Title:
Product Name
The product's name.
object
Related Topup Balance
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType(required): string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Href
The top-up balance's href. -
id(required): string
Title:
ID
The top-up balance's ID. -
name: string
Title:
Name
The top-up balance's name. -
role: string
Title:
Role
The top-up balance's role. For example, parent or child.
object
Related Party
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType(required): string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
(uri)
Title:
Href
The party's href. -
id(required): string
Title:
Party ID
The party's ID. -
name: string
Title:
Party Name
The party's name. -
role: string
Title:
Party Role
The party's role.
object
-
@baseType: string
The object's superclass.
-
@schemaLocation: string
(uri)
A URI to a JSON schema file that defines additional attributes and relationships.
-
@type: string
The object's subclass.
-
amountAfter: object
object
Quantity
Title:
Quantity
The quantity of an object. -
amountBefore: object
object
Quantity
Title:
Quantity
The quantity of an object. -
bucket: object
object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
confirmationDate: string
(date-time)
The date the impact was confirmed.
-
description: string
The impacted bucket's description.
-
item(required): array
array
item
Minimum Number of Items:
1
The impacted bucket items. -
name: string
The impacted bucket's name.
-
requestedDate: string
(date-time)
The date the request was received.
array
1
-
Array of:
object ImpactedBucketItem
An impact item that affects an ImpactedBucket object.
object
-
@baseType: string
The object's superclass.
-
@schemaLocation: string
(uri)
A URI to a JSON schema file that defines additional attributes and relationships.
-
@type: string
The object's subclass.
-
amount: object
object
Quantity
Title:
Quantity
The quantity of an object. -
description: string
The impact item's description.
-
itemType: string
The impact item's type, indicating if the bucket is incremented (credit) or decremented (debit).
-
name: string
The impact item's name, indicating the transaction activity. For example, top-up, bonus, additional bonus, tax, or fees.
-
reason: string
The reason for the impact item.
Response
- application/json;charset=utf-8
201 Response
object
Topup Balance
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
amount: object
object
Quantity
Title:
Quantity
The quantity of an object. -
bucket: object
object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
channel: object
object
ChannelRef
A reference to a channel.
-
confirmationDate: string
(date-time)
Title:
Confirmation Date
The date the top-up was confirmed. -
description: string
Title:
Description
The top-up's description. -
href: string
(uri)
Title:
Href
The top-up balance's href. -
id: string
Title:
ID
The top-up balance's ID. -
impactedBucket: array
array
impactedBucket
A reference to the bucket impacted by the request.
-
isAutoTopup: boolean
Title:
Is Auto Topup
Whether the top-up is automatic (true) or not (false). -
logicalResource: object
object
Logical Resource Ref
Title:
Logical Resource Ref
A reference to a logical resource. -
numberOfPeriods: integer
Title:
Number of Periods
The number of billing periods for which an automatic top-up occurs. If this property is not specified, then the top-up will continue automatically indefinitely. -
partyAccount: object
object
Party Account Ref
Title:
Party Account Ref
A reference to a party account. -
payment: object
object
PaymentRef
A payment received at order time.
-
paymentMethod: object
object
Payment Method Ref
Title:
Payment Method Ref
A reference to a payment method. -
product: object
object
Product Ref
Title:
Product Ref
A reference to a product. -
reason: string
Title:
Reason
The reason for the top-up. -
recurringPeriod: string
The type of recurring period for the top-up.
- relatedParty: array array relatedParty
- relatedTopupBalance: object object Related Topup Balance
-
requestedDate: string
(date-time)
Title:
Requested Date
The date that the top-up request was made. -
requestor: object
object
Related Party
Title:
Related Party
A party related to another object. -
status: string
The status of the request.
-
usageType: string
The top-up's usage type.
-
voucher: string
Title:
Voucher
The voucher used for the top-up.
object
Quantity
-
amount: number
(float)
Title:
Amount
Default Value:1
A numeric value. -
units: string
Title:
Units
A unit. For example, MB or minutes.
object
Bucket Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
(uri)
The bucket's href.
-
id(required): string
Title:
Bucket ID
The bucket's ID. -
name: string
Title:
Bucket Name
The bucket's name. -
usageType: string
The bucket's usage type.
object
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Channel Href
The channel's href. -
id(required): string
Title:
Channel ID
The channel's ID. -
name: string
Title:
Channel Name
The channel's name.
array
-
Array of:
object ImpactedBucket
A bucket impacted by a balance top-up, adjustment, transfer, or reservation.
object
Logical Resource Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Href
The resource's href. -
id(required): string
Title:
ID
The resource's ID. -
name: string
Title:
Name
The resource's name. -
value: string
The resource's value.
object
Party Account Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
description: string
Title:
Description
The party account's description. -
href: string
Title:
Href
The party account's href. -
id(required): string
Title:
Account ID
The party account's ID. -
name: string
Title:
Name
The party account's name. -
status: string
Title:
Status
The overall status of the account. For example, due, paid, or in arrears.
object
-
@baseType: string
The object's superclass.
-
@referredType: string
The object's type in the target system, if baseType and type need further disambiguation.
-
@schemaLocation: string
(uri)
A URI to a JSON schema file that defines additional attributes and relationships.
-
@type: string
The object's subclass.
-
href: string
(uri)
The payment's href.
-
id(required): string
The payment's ID.
-
name: string
The payment's name.
object
Payment Method Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
The object's type in the target system, if baseType and type need further disambiguation.
-
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
(uri)
Title:
Href
The payment method's href. -
id(required): string
Title:
ID
The payment method's ID. -
name: string
Title:
Name
The payment method's name.
object
Product Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Product Href
The product's href. -
id(required): string
Title:
Product ID
The product's ID. -
name: string
Title:
Product Name
The product's name.
object
Related Topup Balance
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType(required): string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Href
The top-up balance's href. -
id(required): string
Title:
ID
The top-up balance's ID. -
name: string
Title:
Name
The top-up balance's name. -
role: string
Title:
Role
The top-up balance's role. For example, parent or child.
object
Related Party
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType(required): string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
(uri)
Title:
Href
The party's href. -
id(required): string
Title:
Party ID
The party's ID. -
name: string
Title:
Party Name
The party's name. -
role: string
Title:
Party Role
The party's role.
object
-
@baseType: string
The object's superclass.
-
@schemaLocation: string
(uri)
A URI to a JSON schema file that defines additional attributes and relationships.
-
@type: string
The object's subclass.
-
amountAfter: object
object
Quantity
Title:
Quantity
The quantity of an object. -
amountBefore: object
object
Quantity
Title:
Quantity
The quantity of an object. -
bucket: object
object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
confirmationDate: string
(date-time)
The date the impact was confirmed.
-
description: string
The impacted bucket's description.
-
item(required): array
array
item
Minimum Number of Items:
1
The impacted bucket items. -
name: string
The impacted bucket's name.
-
requestedDate: string
(date-time)
The date the request was received.
array
1
-
Array of:
object ImpactedBucketItem
An impact item that affects an ImpactedBucket object.
object
-
@baseType: string
The object's superclass.
-
@schemaLocation: string
(uri)
A URI to a JSON schema file that defines additional attributes and relationships.
-
@type: string
The object's subclass.
-
amount: object
object
Quantity
Title:
Quantity
The quantity of an object. -
description: string
The impact item's description.
-
itemType: string
The impact item's type, indicating if the bucket is incremented (credit) or decremented (debit).
-
name: string
The impact item's name, indicating the transaction activity. For example, top-up, bonus, additional bonus, tax, or fees.
-
reason: string
The reason for the impact item.
400 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
401 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
403 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
405 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
409 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
500 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
Examples
The following examples shows how to create top-up balances by submitting POST requests on the REST resource using cURL. For more information about cURL, see Use cURL.
The -d option specifies the file to attach as the request body.
curl -X POST 'http://host:port/brm/prepayBalanceManagement/version/topupBalance' -d @topupBalanceCreate.json
Example of Request Body for a One-time Noncurrency Top Up Balance
The following is an example of the contents of the topupBalanceCreate.json file sent as the request body to create a one-time noncurrency top-up balance.
{ "amount":{ "amount":"2", "units":"USD" }, "bucket":{ "id" : "0.0.0.1+-balance_group+6336883+840+0" } }
Example of Response Body for a One-time Noncurrency Top Up Balance
The following is an example of the response body in JSON format.
{ "@baseType": "TopupBalance", "@schemaLocation": null, "@type": "TopupBalance", "amount": { "amount": 2.0, "units": "USD", "@baseType": null, "@schemaLocation": null, "@type": null }, "bucket": { "id": "0.0.0.1+-balance_group+6336883+840+0", "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+6336883+840+0", "name": null, "@baseType": "BucketRef", "@schemaLocation": null, "@type": "BucketRef", "@referredType": null }, "channel": null, "confirmationDate": "2021-09-30T02:45:11+05:30", "description": null, "href": "http://host:port/brm/prepayBalanceManagement/v4/topupBalance/0.0.0.1+-topup+6534850", "id": "0.0.0.1+-topup+6534850", "impactedBucket": [ { "@baseType": "ImpactedBucket", "@schemaLocation": null, "@type": "ImpactedBucket", "amountAfter": { "amount": -194.0, "units": "USD", "@baseType": null, "@schemaLocation": null, "@type": null }, "amountBefore": { "amount": -192.0, "units": "USD", "@baseType": null, "@schemaLocation": null, "@type": null }, "bucket": { "id": "0.0.0.1+-balance_group+6336883+840+0", "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+6336883+840+0", "name": null, "@baseType": "BucketRef", "@schemaLocation": null, "@type": "BucketRef", "@referredType": null }, "confirmationDate": null, "description": null, "item": [ { "@baseType": "ImpactedBucketItem", "@schemaLocation": null, "@type": "ImpactedBucketItem", "amount": { "amount": 2.0, "units": "USD", "@baseType": null, "@schemaLocation": null, "@type": null }, "description": null, "itemType": null, "name": null, "reason": null } ], "name": null, "requestedDate": null } ], "isAutoTopup": false, "logicalResource": { "@baseType": null, "@referredType": null, "@schemaLocation": null, "@type": null, "href": null, "id": null, "name": null, "value": "" }, "numberOfPeriods": null, "partyAccount": { "id": "0.0.0.1+-account+6340627", "href": null, "description": null, "name": "Alice Rose", "status": "active", "@baseType": null, "@schemaLocation": null, "@type": "PartyAccountRef", "@referredType": null }, "payment": { "id": "0.0.0.1+-item-payment+6536386", "href": "http://host:port/brm/payment/v4/payment/0.0.0.1+-item-payment+6536386", "name": "Billing Event Log", "amount": { "unit": "USD", "value": 2.0 }, "paymentDate": "2021-09-30T02:45:11+05:30", "@baseType": "Payment", "@schemaLocation": null, "@type": "Payment", "@referredType": null }, "paymentMethod": { "id": "0.0.0.1+-payinfo-cc+6337651", "href": "http://host:port/brm/paymentMethods/v1/paymentMethod/0.0.0.1+-payinfo-cc+6337651", "description": null, "isPreferred": true, "name": "PIN Payinfo Object", "status": null, "statusDate": null, "account": [ { "id": "0.0.0.1+-account+6340627", "href": null, "description": null, "name": "Alice Rose", "@baseType": null, "@schemaLocation": null, "@type": null, "@referredType": null } ], "relatedParty": null, "validFor": null, "@baseType": null, "@schemaLocation": null, "@type": "tokenizedCard", "@referredType": null }, "product": { "id": "0.0.0.1+-service-telco-gsm-sms+6337523", "href": null, "name": "ServiceTelcoGsmSms", "@baseType": null, "@schemaLocation": null, "@type": "ProductRef", "@referredType": null }, "reason": null, "recurringPeriod": null, "relatedParty": null, "relatedTopupBalance": null, "requestedDate": "2021-09-30T02:45:11+05:30", "requestor": null, "status": "CONFIRMED", "usageType": "monetary", "voucher": "" }
Example of Request Body for a Recurring Currency Top Up Balance
The following is an example of the contents of the topupBalanceCreate.json file sent as the request body to create a recurring currency top-up balance.
{ "amount":{ "amount":"2", "units":"USD" }, "recurringPeriod" : "daily", "isAutoTopup" : "true", "numberOfPeriods" : "2", "partyAccount":{ "id" : "0.0.0.1+-account+6340627" } }
Example of Response Body for a Recurring Currency Top Up Balance
The following is an example of the response body in JSON format.
{ "@baseType": "TopupBalance", "@schemaLocation": null, "@type": "TopupBalance", "amount": { "amount": 2.0, "units": "USD", "@baseType": null, "@schemaLocation": null, "@type": null }, "bucket": { "id": "0.0.0.1+-balance_group+6336883+840+0", "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+6336883+840+0", "name": null, "@baseType": "BucketRef", "@schemaLocation": null, "@type": "BucketRef", "@referredType": null }, "channel": null, "confirmationDate": "2021-09-30T03:06:42+05:30", "description": null, "href": "http://host:port/brm/prepayBalanceManagement/v4/topupBalance/0.0.0.1+-topup+6528179", "id": "0.0.0.1+-topup+6528179", "impactedBucket": [ { "@baseType": "ImpactedBucket", "@schemaLocation": null, "@type": "ImpactedBucket", "amountAfter": { "amount": 299.0, "units": "USD", "@baseType": null, "@schemaLocation": null, "@type": null }, "amountBefore": { "amount": 301.0, "units": "USD", "@baseType": null, "@schemaLocation": null, "@type": null }, "bucket": { "id": "0.0.0.1+-balance_group+6336883+840+0", "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+6336883+840+0", "name": null, "@baseType": "BucketRef", "@schemaLocation": null, "@type": "BucketRef", "@referredType": null }, "confirmationDate": null, "description": null, "item": [ { "@baseType": "ImpactedBucketItem", "@schemaLocation": null, "@type": "ImpactedBucketItem", "amount": { "amount": 2.0, "units": "USD", "@baseType": null, "@schemaLocation": null, "@type": null }, "description": null, "itemType": null, "name": null, "reason": null } ], "name": null, "requestedDate": null } ], "isAutoTopup": true, "logicalResource": { "@baseType": null, "@referredType": null, "@schemaLocation": null, "@type": null, "href": null, "id": null, "name": null, "value": "" }, "numberOfPeriods": 2, "partyAccount": { "id": "0.0.0.1+-account+6340627", "href": null, "description": null, "name": "Alice Rose", "status": "active", "@baseType": null, "@schemaLocation": null, "@type": "PartyAccountRef", "@referredType": null }, "payment": { "id": "0.0.0.1+-item-payment+6526899", "href": "http://host:port/brm/payment/v4/payment/0.0.0.1+-item-payment+6526899", "name": "Billing Event Log", "amount": { "unit": "USD", "value": 2.0 }, "paymentDate": "2021-09-30T03:06:43+05:30", "@baseType": "Payment", "@schemaLocation": null, "@type": "Payment", "@referredType": null }, "paymentMethod": { "id": "0.0.0.1+-payinfo-cc+6337651", "href": "http://host:port/brm/paymentMethods/v1/paymentMethod/0.0.0.1+-payinfo-cc+6337651", "description": null, "isPreferred": true, "name": "PIN Payinfo Object", "status": null, "statusDate": null, "account": [ { "id": "0.0.0.1+-account+6340627", "href": null, "description": null, "name": "Alice Rose", "@baseType": null, "@schemaLocation": null, "@type": null, "@referredType": null } ], "relatedParty": null, "validFor": null, "@baseType": null, "@schemaLocation": null, "@type": "tokenizedCard", "@referredType": null }, "product": { "id": "0.0.0.1+-service-telco-gsm-sms+6337523", "href": null, "name": "ServiceTelcoGsmSms", "@baseType": null, "@schemaLocation": null, "@type": "ProductRef", "@referredType": null }, "reason": null, "recurringPeriod": "1 Day", "relatedParty": null, "relatedTopupBalance": null, "requestedDate": "2021-09-30T03:06:42+05:30", "requestor": null, "status": "CONFIRMED", "usageType": "monetary", "voucher": "" }