Jump to

• Request
• Response

Update a Top-up Balance

patch

/topupBalance/{id}

Updates the speicied top-up balance.

Request

Path Parameters

• id(required): string
  The ID of the top-up balance to update.

Supported Media Types

• application/json;charset=utf-8

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

Root Schema : Topup Balance Update

Type: object

Title: Topup Balance Update

A top-up, used in TopupBalance update 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: object Quantity
  The amount in a given 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 that top-up was confirmed.
• description: string
  Title: Description

  The top-up's description.
• impactedBucket: array impactedBucket
  A reference to the bucket impacted by the request.
• isAutoTopup: boolean
  Title: Is Auto Topup

  Whether the top-up is automatic (true) or not (false).
• logicalResource: object 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
  The PaymentMethod reference. A payment method defines a specific means of payment, such as direct debit.
• product: object Product Ref
  Title: Product Ref

  A reference to a product.
• reason: string
  Title: Reason

  The reason for the top-up.
• recurringPeriod: string
  The type of recurring period for the top-up.
• relatedParty: array relatedParty
  Parties 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 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 Update",
    "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 that 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 the bucket impacted by the request.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucket"
            }
        },
        "isAutoTopup":{
            "type":"boolean",
            "title":"Is Auto Topup",
            "description":"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":"Parties 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 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, used in <b>TopupBalance</b> update requests."
}

Nested Schema : Quantity

Type: object

The amount in a given unit.

Show Source

• amount: number (float)
  Default Value: 1

  The numeric value in a given unit.
• units: string
  The unit.

{
    "type":"object",
    "description":"The amount in a given unit.",
    "properties":{
        "amount":{
            "type":"number",
            "format":"float",
            "default":1,
            "description":"The numeric value in a given unit."
        },
        "units":{
            "type":"string",
            "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

The PaymentMethod reference. A payment method defines a specific means of payment, such as direct debit.

Match All

The PaymentMethod reference. A payment method defines a specific means of payment, such as direct debit.

Show Source

• allOf EntityRef

{
    "type":"object",
    "description":"The PaymentMethod reference. A payment method defines a specific means of payment, such as direct debit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : Product Ref

Type: object

Title: Product Ref

A reference to a product.

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: Product Href

  The product's href.
• id(required): string
  Title: Product ID

  The product's ID.
• name: string
  Title: Product Name

  The product's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Product Ref",
    "description":"A reference to a product.",
    "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":"Product Href",
            "description":"The product's href."
        },
        "id":{
            "type":"string",
            "title":"Product ID",
            "description":"The product's ID."
        },
        "name":{
            "type":"string",
            "title":"Product Name",
            "description":"The product's name."
        }
    }
}

Nested Schema : relatedParty

Type: array

Parties related to the top-up.

Show Source

• Array of: object Related Party
  Title: Related Party

  A party related to another object.

{
    "type":"array",
    "description":"Parties 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
  The amount in a given unit.
• amountBefore: object Quantity
  The amount in a given 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
  The amount in a given 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, indicating the transaction activity. For example, top-up, 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, indicating the transaction activity. For example, top-up, 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

The entity reference schema to be use for all entityRef class.

Show Source

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Addressable
  The base schema for adressable entities.
• object EntityRef-allOf[2]
  The entity reference schema to be use for all entityRef class.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"The entity reference schema to be use for all entityRef class.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "description":"The name of the referred entity."
                },
                "@referredType":{
                    "type":"string",
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships"
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable

Type: object

The base schema for adressable entities.

Show Source

• href: string
  The hyperlink reference.
• id: string
  The unique identifier.

{
    "type":"object",
    "description":"The base schema for adressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The unique identifier."
        }
    }
}

Nested Schema : EntityRef-allOf[2]

Type: object

The entity reference schema to be use for all entityRef class.

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 name of the referred entity.

{
    "type":"object",
    "description":"The entity reference schema to be use for all entityRef class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "description":"The name of the referred entity."
        },
        "@referredType":{
            "type":"string",
            "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

200 Response

The top-up balance was updated 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
  The amount in a given 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

  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
  The PaymentMethod reference. A payment method defines a specific means of payment, such as direct debit.
• product: object Product Ref
  Title: Product Ref

  A reference to a product.
• reason: string
  Title: Reason

  The reason for the top-up.
• recurringPeriod: string
  The type of recurring period for the top-up.
• relatedParty: array relatedParty
  Parties 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":"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":"Parties 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

The amount in a given unit.

Show Source

• amount: number (float)
  Default Value: 1

  The numeric value in a given unit.
• units: string
  The unit.

{
    "type":"object",
    "description":"The amount in a given unit.",
    "properties":{
        "amount":{
            "type":"number",
            "format":"float",
            "default":1,
            "description":"The numeric value in a given unit."
        },
        "units":{
            "type":"string",
            "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

The PaymentMethod reference. A payment method defines a specific means of payment, such as direct debit.

Match All

The PaymentMethod reference. A payment method defines a specific means of payment, such as direct debit.

Show Source

• allOf EntityRef

{
    "type":"object",
    "description":"The PaymentMethod reference. A payment method defines a specific means of payment, such as direct debit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : Product Ref

Type: object

Title: Product Ref

A reference to a product.

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: Product Href

  The product's href.
• id(required): string
  Title: Product ID

  The product's ID.
• name: string
  Title: Product Name

  The product's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Product Ref",
    "description":"A reference to a product.",
    "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":"Product Href",
            "description":"The product's href."
        },
        "id":{
            "type":"string",
            "title":"Product ID",
            "description":"The product's ID."
        },
        "name":{
            "type":"string",
            "title":"Product Name",
            "description":"The product's name."
        }
    }
}

Nested Schema : relatedParty

Type: array

Parties related to the top-up.

Show Source

• Array of: object Related Party
  Title: Related Party

  A party related to another object.

{
    "type":"array",
    "description":"Parties 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
  The amount in a given unit.
• amountBefore: object Quantity
  The amount in a given 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
  The amount in a given 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, indicating the transaction activity. For example, top-up, 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, indicating the transaction activity. For example, top-up, 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

The entity reference schema to be use for all entityRef class.

Show Source

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Addressable
  The base schema for adressable entities.
• object EntityRef-allOf[2]
  The entity reference schema to be use for all entityRef class.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"The entity reference schema to be use for all entityRef class.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "description":"The name of the referred entity."
                },
                "@referredType":{
                    "type":"string",
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships"
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable

Type: object

The base schema for adressable entities.

Show Source

• href: string
  The hyperlink reference.
• id: string
  The unique identifier.

{
    "type":"object",
    "description":"The base schema for adressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The unique identifier."
        }
    }
}

Nested Schema : EntityRef-allOf[2]

Type: object

The entity reference schema to be use for all entityRef class.

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 name of the referred entity.

{
    "type":"object",
    "description":"The entity reference schema to be use for all entityRef class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "description":"The name of the referred entity."
        },
        "@referredType":{
            "type":"string",
            "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

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

401 Response

The client doesn't have the correct privileges.

Body ()

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

403 Response

The request wasn't authorized.

Body ()

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

404 Response

The requested resource couldn't be found.

Body ()

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

405 Response

This method is not allowed.

Body ()

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing 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

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

500 Response

The system encountered an internal error.

Body ()

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

Back to Top