Jump to

• Request
• Response
• Examples

Create a Top-up Balance

post

/topupBalance

Creates a top-up balance.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json;charset=utf-8

Request Body - application/json;charset=utf-8 ()

Root Schema : Topup Balance Create

Type: object

Title: Topup Balance Create

A top-up, used in TopupBalance create requests.

Show Source

• @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 Quantity
  Represents an amount in a specified unit.
• bucket: object Bucket Ref
  Title: Bucket Ref

  A reference to a bucket.
• channel: 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 impactedBucket
  A reference to buckets impacted by the request.
• isAutoTopup: boolean
  Title: Is Auto Topup

  The value indicates whether the top-up is automatic (true) or not (false).
• logicalResource: 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, the top-up will continue automatically indefinitely.
• partyAccount: object Party Account Ref
  Title: Party Account Ref

  A reference to a party account.
• payment: object PaymentRef
  A payment received at order time.
• paymentMethod: object PaymentMethodRef
  PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
• product: object ProductRef
  A product reference.
• reason: string
  Title: Reason

  The reason for the top-up.
• recurringPeriod: string
  The type of recurring period for the top-up.
• relatedParty: array relatedParty
  The parties are related to the top-up.
• relatedTopupBalance: object Related Topup Balance
  Title: Related Topup Balance

  A relationship between balance top-ups that defines whether a balance is the parent or child of another.
• requestedDate: string (date-time)
  The date the top-up request was made.
• requestor: 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.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "title":"Topup Balance Create",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "amount":{
            "description":"The amount to be topped up.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bucket":{
            "description":"The bucket tracking the top-up.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "channel":{
            "description":"The top-up channel.",
            "$ref":"#/components/schemas/ChannelRef"
        },
        "confirmationDate":{
            "type":"string",
            "description":"The date the top-up was confirmed.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The top-up's description."
        },
        "impactedBucket":{
            "type":"array",
            "description":"A reference to buckets impacted by the request.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucket"
            }
        },
        "isAutoTopup":{
            "type":"boolean",
            "title":"Is Auto Topup",
            "description":"The value indicates whether the top-up is automatic (<b>true</b>) or not (<b>false</b>)."
        },
        "logicalResource":{
            "description":"A logical resource associated with the top-up.",
            "$ref":"#/components/schemas/LogicalResourceRef"
        },
        "numberOfPeriods":{
            "type":"integer",
            "title":"Number of Periods",
            "description":"The number of billing periods for which an automatic top-up occurs. If this property is not specified, the top-up will continue automatically indefinitely."
        },
        "partyAccount":{
            "description":"A party account associated with the top-up.",
            "$ref":"#/components/schemas/PartyAccountRef"
        },
        "payment":{
            "description":"A payment associated with the top-up.",
            "$ref":"#/components/schemas/PaymentRef"
        },
        "paymentMethod":{
            "description":"The payment method for the top-up.",
            "$ref":"#/components/schemas/PaymentMethodRef"
        },
        "product":{
            "description":"A product associated with the top-up.",
            "$ref":"#/components/schemas/ProductRef"
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the top-up."
        },
        "recurringPeriod":{
            "type":"string",
            "description":"The type of recurring period for the top-up."
        },
        "relatedParty":{
            "type":"array",
            "description":"The parties are related to the top-up.",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "relatedTopupBalance":{
            "description":"A balance related to the top-up. (BRM does not use this property).",
            "$ref":"#/components/schemas/RelatedTopupBalance"
        },
        "requestedDate":{
            "type":"string",
            "description":"The date the top-up request was made.",
            "format":"date-time"
        },
        "requestor":{
            "description":"The party requesting the top-up.",
            "$ref":"#/components/schemas/RelatedParty"
        },
        "status":{
            "type":"string",
            "description":"The request's status."
        },
        "usageType":{
            "type":"string",
            "description":"The top-up's usage type."
        },
        "voucher":{
            "type":"string",
            "title":"Voucher",
            "description":"The voucher used for the top-up."
        }
    },
    "description":"A top-up, used in <b>TopupBalance</b> create requests."
}

Nested Schema : Quantity

Type: object

Represents an amount in a specified unit.

Show Source

• amount: number (double)
  Default Value: 1

  The numeric value in the specified unit.
• units: string
  The unit.

{
    "type":"object",
    "description":"Represents an amount in a specified unit.",
    "properties":{
        "amount":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "default":1,
            "description":"The numeric value in the specified unit."
        },
        "units":{
            "type":"string",
            "nullable":true,
            "description":"The unit."
        }
    }
}

Nested Schema : Bucket Ref

Type: object

Title: Bucket Ref

A reference to a bucket.

Show Source

• @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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Bucket Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "description":"The bucket's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Bucket ID",
            "description":"The bucket's ID."
        },
        "name":{
            "type":"string",
            "title":"Bucket Name",
            "description":"The bucket's name."
        },
        "usageType":{
            "type":"string",
            "description":"The bucket's usage type."
        }
    },
    "description":"A reference to a bucket."
}

Nested Schema : ChannelRef

Type: object

A reference to a channel.

Show Source

• @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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "title":"Channel ID",
            "description":"The channel's ID."
        },
        "href":{
            "type":"string",
            "title":"Channel Href",
            "description":"The channel's href."
        },
        "name":{
            "type":"string",
            "title":"Channel Name",
            "description":"The channel's name."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"A reference to a channel."
}

Nested Schema : impactedBucket

Type: array

A reference to buckets impacted by the request.

Show Source

• Array of: object ImpactedBucket
  A bucket impacted by a balance top-up, adjustment, transfer, or reservation.

{
    "type":"array",
    "description":"A reference to buckets impacted by the request.",
    "items":{
        "$ref":"#/components/schemas/ImpactedBucket"
    }
}

Nested Schema : Logical Resource Ref

Type: object

Title: Logical Resource Ref

A reference to a logical resource.

Show Source

• @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 device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN).

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Logical Resource Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The resource's href."
        },
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The resource's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The resource's name."
        },
        "value":{
            "type":"string",
            "description":"The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN)."
        }
    },
    "description":"A reference to a logical resource."
}

Nested Schema : Party Account Ref

Type: object

Title: Party Account Ref

A reference to a party account.

Show Source

• @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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Party Account Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The party account's description."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party account's href."
        },
        "id":{
            "type":"string",
            "title":"Account ID",
            "description":"The party account's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The party account's name."
        },
        "status":{
            "type":"string",
            "title":"Status",
            "description":"The overall status of the account. For example&colon; <b>due</b>, <b>paid</b>, or <b>in arrears</b>."
        }
    },
    "description":"A reference to a party account."
}

Nested Schema : PaymentRef

Type: object

A payment received at order time.

Show Source

• @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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "description":"The payment's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "description":"The payment's ID."
        },
        "name":{
            "type":"string",
            "description":"The payment's name."
        }
    },
    "description":"A payment received at order time."
}

Nested Schema : PaymentMethodRef

Type: object

PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).

Match All

PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).

Show Source

• allOf EntityRef

{
    "type":"object",
    "description":"PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : ProductRef

Type: object

A product reference.

Match All

A product reference.

A product reference.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• allOf EntityRef

{
    "type":"object",
    "description":"A product reference.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : relatedParty

Type: array

The parties are related to the top-up.

Show Source

• Array of: object Related Party
  Title: Related Party

  A party related to another object.

{
    "type":"array",
    "description":"The parties are related to the top-up.",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

Nested Schema : Related Topup Balance

Type: object

Title: Related Topup Balance

A relationship between balance top-ups that defines whether a balance is the parent or child of another.

Show Source

• @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.

{
    "required":[
        "@referredType",
        "id"
    ],
    "type":"object",
    "title":"Related Topup Balance",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The top-up balance's href."
        },
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The top-up  balance's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The top-up balance's name."
        },
        "role":{
            "type":"string",
            "title":"Role",
            "description":"The top-up balance's role. For example, parent or child."
        }
    },
    "description":"A relationship between balance top-ups that defines whether a balance is the parent or child of another."
}

Nested Schema : Related Party

Type: object

Title: Related Party

A party related to another object.

Show Source

• @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.

{
    "required":[
        "@referredType",
        "id"
    ],
    "type":"object",
    "title":"Related Party",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Party ID",
            "description":"The party's ID."
        },
        "name":{
            "type":"string",
            "title":"Party Name",
            "description":"The party's name."
        },
        "role":{
            "type":"string",
            "title":"Party Role",
            "description":"The party's role."
        }
    },
    "description":"A party related to another object."
}

Nested Schema : ImpactedBucket

Type: object

A bucket impacted by a balance top-up, adjustment, transfer, or reservation.

Show Source

• @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 Quantity
  Represents an amount in a specified unit.
• amountBefore: object Quantity
  Represents an amount in a specified unit.
• bucket: object Bucket Ref
  Title: Bucket Ref

  A reference to a bucket.
• confirmationDate: string (date-time)
  The date and time the impact was confirmed.
• description: string
  The impacted bucket's description.
• item(required): array item
  Minimum Number of Items: 1

  The impacted bucket items.
• name: string
  The impacted bucket's name.
• requestedDate: string (date-time)
  The date and time the request was received.

{
    "required":[
        "item"
    ],
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "amountAfter":{
            "description":"The amount in the bucket after the impact.",
            "$ref":"#/components/schemas/Quantity"
        },
        "amountBefore":{
            "description":"The amount in the bucket before the impact.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bucket":{
            "description":"A reference to the impacted bucket.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "confirmationDate":{
            "type":"string",
            "description":"The date and time the impact was confirmed.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"The impacted bucket's description."
        },
        "item":{
            "minItems":1,
            "type":"array",
            "description":"The impacted bucket items.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucketItem"
            }
        },
        "name":{
            "type":"string",
            "description":"The impacted bucket's name."
        },
        "requestedDate":{
            "type":"string",
            "description":"The date and time the request was received.",
            "format":"date-time"
        }
    },
    "description":"A bucket impacted by a balance top-up, adjustment, transfer, or reservation."
}

Nested Schema : item

Type: array

Minimum Number of Items: 1

The impacted bucket items.

Show Source

• Array of: object ImpactedBucketItem
  An impact item that affects an ImpactedBucket object.

{
    "minItems":1,
    "type":"array",
    "description":"The impacted bucket items.",
    "items":{
        "$ref":"#/components/schemas/ImpactedBucketItem"
    }
}

Nested Schema : ImpactedBucketItem

Type: object

An impact item that affects an ImpactedBucket object.

Show Source

• @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 Quantity
  Represents an amount in a specified unit.
• 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 indicates the transaction activity, such as a top-up or bonus. additional bonus, tax, or fees.
• reason: string
  The reason for the impact item.

{
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "amount":{
            "description":"The impact item's amount.",
            "$ref":"#/components/schemas/Quantity"
        },
        "description":{
            "type":"string",
            "description":"The impact item's description."
        },
        "itemType":{
            "type":"string",
            "description":"The impact item's type, indicating if the bucket is incremented (<b>credit</b>) or decremented (<b>debit</b>)."
        },
        "name":{
            "type":"string",
            "description":"The impact item's name indicates the transaction activity, such as a top-up or bonus. additional bonus, tax, or fees."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the impact item."
        }
    },
    "description":"An impact item that affects an ImpactedBucket object."
}

Nested Schema : EntityRef

Match All

Represents an entity reference schema for EntityRef classes.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Addressable
  Defines a base schema for addressable entities.
• object EntityRef-allOf[2]
  Represents an entity reference schema for EntityRef classes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"Represents an entity reference schema for EntityRef classes.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "nullable":true,
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "nullable":true,
                    "description":"The referred entity's name."
                },
                "@referredType":{
                    "type":"string",
                    "nullable":true,
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable

Type: object

Defines a base schema for addressable entities.

Show Source

• href: string
  The hyperlink reference.
• id: string
  The ID.

{
    "type":"object",
    "description":"Defines a base schema for addressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        }
    }
}

Nested Schema : EntityRef-allOf[2]

Type: object

Represents an entity reference schema for EntityRef classes.

Show Source

• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• href: string
  The URI of the referred entity.
• id(required): string
  The identifier of the referred entity.
• name: string
  The referred entity's name.

{
    "type":"object",
    "description":"Represents an entity reference schema for EntityRef classes.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "nullable":true,
            "description":"The referred entity's name."
        },
        "@referredType":{
            "type":"string",
            "nullable":true,
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

201 Response

The top-up balance was created successfully.

Body ()

Root Schema : Topup Balance

Type: object

Title: Topup Balance

A top-up.

Show Source

• @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 Quantity
  Represents an amount in a specified unit.
• bucket: object Bucket Ref
  Title: Bucket Ref

  A reference to a bucket.
• channel: 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 impactedBucket
  A reference to the bucket impacted by the request.
• isAutoTopup: boolean
  Title: Is Auto Topup

  The value indicates whether the top-up is automatic (true) or not (false).
• logicalResource: 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, the top-up will continue automatically indefinitely.
• partyAccount: object Party Account Ref
  Title: Party Account Ref

  A reference to a party account.
• payment: object PaymentRef
  A payment received at order time.
• paymentMethod: object PaymentMethodRef
  PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
• product: object ProductRef
  A product reference.
• reason: string
  Title: Reason

  The reason for the top-up.
• recurringPeriod: string
  The type of recurring period for the top-up.
• relatedParty: array relatedParty
  The parties are related to the top-up.
• relatedTopupBalance: object Related Topup Balance
  Title: Related Topup Balance

  A relationship between balance top-ups that defines whether a balance is the parent or child of another.
• requestedDate: string (date-time)
  Title: Requested Date

  The date and time that the top-up request was made.
• requestor: 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.

{
    "type":"object",
    "title":"Topup Balance",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "amount":{
            "description":"The amount to be topped up.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bucket":{
            "description":"The bucket tracking the top-up.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "channel":{
            "description":"The top-up channel.",
            "$ref":"#/components/schemas/ChannelRef"
        },
        "confirmationDate":{
            "type":"string",
            "title":"Confirmation Date",
            "description":"The date the top-up was confirmed.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The top-up's description."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The top-up balance's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The top-up balance's ID."
        },
        "impactedBucket":{
            "type":"array",
            "description":"A reference to the bucket impacted by the request.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucket"
            }
        },
        "isAutoTopup":{
            "type":"boolean",
            "title":"Is Auto Topup",
            "description":"The value indicates whether the top-up is automatic (<b>true</b>) or not (<b>false</b>)."
        },
        "logicalResource":{
            "description":"A logical resource associated with the top-up.",
            "$ref":"#/components/schemas/LogicalResourceRef"
        },
        "numberOfPeriods":{
            "type":"integer",
            "title":"Number of Periods",
            "description":"The number of billing periods for which an automatic top-up occurs. If this property is not specified, the top-up will continue automatically indefinitely."
        },
        "partyAccount":{
            "description":"A party account associated with the top-up.",
            "$ref":"#/components/schemas/PartyAccountRef"
        },
        "payment":{
            "description":"A payment associated with the top-up.",
            "$ref":"#/components/schemas/PaymentRef"
        },
        "paymentMethod":{
            "description":"The payment method for the top-up.",
            "$ref":"#/components/schemas/PaymentMethodRef"
        },
        "product":{
            "description":"A product associated with the top-up.",
            "$ref":"#/components/schemas/ProductRef"
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the top-up."
        },
        "recurringPeriod":{
            "type":"string",
            "description":"The type of recurring period for the top-up."
        },
        "relatedParty":{
            "type":"array",
            "description":"The parties are related to the top-up.",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "relatedTopupBalance":{
            "description":"A balance related to the top-up. (BRM does not use this property).",
            "$ref":"#/components/schemas/RelatedTopupBalance"
        },
        "requestedDate":{
            "type":"string",
            "title":"Requested Date",
            "description":"The date and time that the top-up request was made.",
            "format":"date-time"
        },
        "requestor":{
            "description":"The party requesting the top-up.",
            "$ref":"#/components/schemas/RelatedParty"
        },
        "status":{
            "type":"string",
            "description":"The status of the request."
        },
        "usageType":{
            "type":"string",
            "description":"The top-up's usage type."
        },
        "voucher":{
            "type":"string",
            "title":"Voucher",
            "description":"The voucher used for the top-up."
        }
    },
    "description":"A top-up."
}

Nested Schema : Quantity

Type: object

Represents an amount in a specified unit.

Show Source

• amount: number (double)
  Default Value: 1

  The numeric value in the specified unit.
• units: string
  The unit.

{
    "type":"object",
    "description":"Represents an amount in a specified unit.",
    "properties":{
        "amount":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "default":1,
            "description":"The numeric value in the specified unit."
        },
        "units":{
            "type":"string",
            "nullable":true,
            "description":"The unit."
        }
    }
}

Nested Schema : Bucket Ref

Type: object

Title: Bucket Ref

A reference to a bucket.

Show Source

• @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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Bucket Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "description":"The bucket's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Bucket ID",
            "description":"The bucket's ID."
        },
        "name":{
            "type":"string",
            "title":"Bucket Name",
            "description":"The bucket's name."
        },
        "usageType":{
            "type":"string",
            "description":"The bucket's usage type."
        }
    },
    "description":"A reference to a bucket."
}

Nested Schema : ChannelRef

Type: object

A reference to a channel.

Show Source

• @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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "title":"Channel ID",
            "description":"The channel's ID."
        },
        "href":{
            "type":"string",
            "title":"Channel Href",
            "description":"The channel's href."
        },
        "name":{
            "type":"string",
            "title":"Channel Name",
            "description":"The channel's name."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"A reference to a channel."
}

Nested Schema : impactedBucket

Type: array

A reference to the bucket impacted by the request.

Show Source

• Array of: object ImpactedBucket
  A bucket impacted by a balance top-up, adjustment, transfer, or reservation.

{
    "type":"array",
    "description":"A reference to the bucket impacted by the request.",
    "items":{
        "$ref":"#/components/schemas/ImpactedBucket"
    }
}

Nested Schema : Logical Resource Ref

Type: object

Title: Logical Resource Ref

A reference to a logical resource.

Show Source

• @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 device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN).

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Logical Resource Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The resource's href."
        },
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The resource's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The resource's name."
        },
        "value":{
            "type":"string",
            "description":"The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN)."
        }
    },
    "description":"A reference to a logical resource."
}

Nested Schema : Party Account Ref

Type: object

Title: Party Account Ref

A reference to a party account.

Show Source

• @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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Party Account Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The party account's description."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party account's href."
        },
        "id":{
            "type":"string",
            "title":"Account ID",
            "description":"The party account's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The party account's name."
        },
        "status":{
            "type":"string",
            "title":"Status",
            "description":"The overall status of the account. For example&colon; <b>due</b>, <b>paid</b>, or <b>in arrears</b>."
        }
    },
    "description":"A reference to a party account."
}

Nested Schema : PaymentRef

Type: object

A payment received at order time.

Show Source

• @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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "description":"The payment's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "description":"The payment's ID."
        },
        "name":{
            "type":"string",
            "description":"The payment's name."
        }
    },
    "description":"A payment received at order time."
}

Nested Schema : PaymentMethodRef

Type: object

PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).

Match All

PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).

Show Source

• allOf EntityRef

{
    "type":"object",
    "description":"PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : ProductRef

Type: object

A product reference.

Match All

A product reference.

A product reference.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• allOf EntityRef

{
    "type":"object",
    "description":"A product reference.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : relatedParty

Type: array

The parties are related to the top-up.

Show Source

• Array of: object Related Party
  Title: Related Party

  A party related to another object.

{
    "type":"array",
    "description":"The parties are related to the top-up.",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

Nested Schema : Related Topup Balance

Type: object

Title: Related Topup Balance

A relationship between balance top-ups that defines whether a balance is the parent or child of another.

Show Source

• @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.

{
    "required":[
        "@referredType",
        "id"
    ],
    "type":"object",
    "title":"Related Topup Balance",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The top-up balance's href."
        },
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The top-up  balance's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The top-up balance's name."
        },
        "role":{
            "type":"string",
            "title":"Role",
            "description":"The top-up balance's role. For example, parent or child."
        }
    },
    "description":"A relationship between balance top-ups that defines whether a balance is the parent or child of another."
}

Nested Schema : Related Party

Type: object

Title: Related Party

A party related to another object.

Show Source

• @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.

{
    "required":[
        "@referredType",
        "id"
    ],
    "type":"object",
    "title":"Related Party",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Party ID",
            "description":"The party's ID."
        },
        "name":{
            "type":"string",
            "title":"Party Name",
            "description":"The party's name."
        },
        "role":{
            "type":"string",
            "title":"Party Role",
            "description":"The party's role."
        }
    },
    "description":"A party related to another object."
}

Nested Schema : ImpactedBucket

Type: object

A bucket impacted by a balance top-up, adjustment, transfer, or reservation.

Show Source

• @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 Quantity
  Represents an amount in a specified unit.
• amountBefore: object Quantity
  Represents an amount in a specified unit.
• bucket: object Bucket Ref
  Title: Bucket Ref

  A reference to a bucket.
• confirmationDate: string (date-time)
  The date and time the impact was confirmed.
• description: string
  The impacted bucket's description.
• item(required): array item
  Minimum Number of Items: 1

  The impacted bucket items.
• name: string
  The impacted bucket's name.
• requestedDate: string (date-time)
  The date and time the request was received.

{
    "required":[
        "item"
    ],
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "amountAfter":{
            "description":"The amount in the bucket after the impact.",
            "$ref":"#/components/schemas/Quantity"
        },
        "amountBefore":{
            "description":"The amount in the bucket before the impact.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bucket":{
            "description":"A reference to the impacted bucket.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "confirmationDate":{
            "type":"string",
            "description":"The date and time the impact was confirmed.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"The impacted bucket's description."
        },
        "item":{
            "minItems":1,
            "type":"array",
            "description":"The impacted bucket items.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucketItem"
            }
        },
        "name":{
            "type":"string",
            "description":"The impacted bucket's name."
        },
        "requestedDate":{
            "type":"string",
            "description":"The date and time the request was received.",
            "format":"date-time"
        }
    },
    "description":"A bucket impacted by a balance top-up, adjustment, transfer, or reservation."
}

Nested Schema : item

Type: array

Minimum Number of Items: 1

The impacted bucket items.

Show Source

• Array of: object ImpactedBucketItem
  An impact item that affects an ImpactedBucket object.

{
    "minItems":1,
    "type":"array",
    "description":"The impacted bucket items.",
    "items":{
        "$ref":"#/components/schemas/ImpactedBucketItem"
    }
}

Nested Schema : ImpactedBucketItem

Type: object

An impact item that affects an ImpactedBucket object.

Show Source

• @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 Quantity
  Represents an amount in a specified unit.
• 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 indicates the transaction activity, such as a top-up or bonus. additional bonus, tax, or fees.
• reason: string
  The reason for the impact item.

{
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "amount":{
            "description":"The impact item's amount.",
            "$ref":"#/components/schemas/Quantity"
        },
        "description":{
            "type":"string",
            "description":"The impact item's description."
        },
        "itemType":{
            "type":"string",
            "description":"The impact item's type, indicating if the bucket is incremented (<b>credit</b>) or decremented (<b>debit</b>)."
        },
        "name":{
            "type":"string",
            "description":"The impact item's name indicates the transaction activity, such as a top-up or bonus. additional bonus, tax, or fees."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the impact item."
        }
    },
    "description":"An impact item that affects an ImpactedBucket object."
}

Nested Schema : EntityRef

Match All

Represents an entity reference schema for EntityRef classes.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Addressable
  Defines a base schema for addressable entities.
• object EntityRef-allOf[2]
  Represents an entity reference schema for EntityRef classes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"Represents an entity reference schema for EntityRef classes.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "nullable":true,
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "nullable":true,
                    "description":"The referred entity's name."
                },
                "@referredType":{
                    "type":"string",
                    "nullable":true,
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable

Type: object

Defines a base schema for addressable entities.

Show Source

• href: string
  The hyperlink reference.
• id: string
  The ID.

{
    "type":"object",
    "description":"Defines a base schema for addressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        }
    }
}

Nested Schema : EntityRef-allOf[2]

Type: object

Represents an entity reference schema for EntityRef classes.

Show Source

• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• href: string
  The URI of the referred entity.
• id(required): string
  The identifier of the referred entity.
• name: string
  The referred entity's name.

{
    "type":"object",
    "description":"Represents an entity reference schema for EntityRef classes.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "nullable":true,
            "description":"The referred entity's name."
        },
        "@referredType":{
            "type":"string",
            "nullable":true,
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

400 Response

The request isn't valid.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

401 Response

The client doesn't have the correct privileges.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

403 Response

The request wasn't authorized.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

405 Response

This method is not allowed.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

409 Response

The request could not be processed due to the conflict with the existing state of the resource.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

500 Response

The system encountered an internal error.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

Back to Top

Examples

• Example 1: Create a One-time Noncurrency Top-up Balance

• Example 2: Create a Recurring Currency Top-up Balance

Example 1: Create a One-time Noncurrency Top-up Balance

The following examples shows how to create a one-time noncurrency top-up balance by submitting a POST request 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

Request Body

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": "11",
      "units": "Free Minutes"
   },
   "bucket": {
      "id" : "0.0.0.1+-balance_group+6336883+100002+8"
   }
}

Response Body

The following is an example of the response body in JSON format.

{
   "@baseType": "TopupBalance",
   "@schemaLocation": null,
   "@type": "TopupBalance",
   "amount": {
      "amount": 11.0,
      "units": "Free Minutes",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": null
   },
   "bucket": {
      "id": "0.0.0.1+-balance_group+6336883+100002+8",
      "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+6336883+100002+8",
      "name": null,
      "@baseType": "BucketRef",
      "@schemaLocation": null,
      "@type": "BucketRef",
      "@referredType": null
   },
   "channel": null,
   "confirmationDate": "2025-09-30T02:45:11+05:30",
   "description": null,
   "href": "http://host:port/brm/prepayBalanceManagement/v4/topupBalance/0.0.0.1+-topup+6535618",
   "id": "0.0.0.1+-topup+6535618",
   "impactedBucket": [
      {
         "@baseType": "ImpactedBucket",
         "@schemaLocation": null,
         "@type": "ImpactedBucket",
         "amountAfter": {
            "amount": -23.0,
            "units": "Free Minutes",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null
         },
         "amountBefore": {
            "amount": -12.0,
            "units": "Free Minutes",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null
         },
         "bucket": {
            "id": "0.0.0.1+-balance_group+6336883+100002+8",
            "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+6336883+100002+8",
            "name": null,
            "@baseType": "BucketRef",
            "@schemaLocation": null,
            "@type": "BucketRef",
            "@referredType": null
         },
         "confirmationDate": null,
         "description": null,
         "item": [
            {
               "@baseType": "ImpactedBucketItem",
               "@schemaLocation": null,
               "@type": "ImpactedBucketItem",
               "amount": {
                  "amount": 11.0,
                  "units": "Free Minutes",
                  "@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+6338675",
      "href": null,
      "description": null,
      "name": "Tom Smith",
      "status": "active",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "PartyAccountRef",
      "@referredType": null
   },
   "payment": 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+6338675",
            "href": null,
            "description": null,
            "name": "Tom Smith",
            "@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": "2025-09-30T02:45:11+05:30",
   "requestor": null,
   "status": "CONFIRMED",
   "usageType": "other",
   "voucher": ""
}

Example 2: Create a Recurring Currency Top-up Balance

The following examples shows how to create a currency top-up balance by submitting a POST request 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

Request Body

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"
   }
}

Response Body

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": "2025-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": "2025-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": "2025-09-30T03:06:42+05:30",
   "requestor": null,
   "status": "CONFIRMED",
   "usageType": "monetary",
   "voucher": ""
}

Back to Top