Jump to

• Request
• Response
• Examples

Get Payments

get

/payment

Gets the payments that match the specified query criteria.

Request

Query Parameters

• @type: string
  The type of object to return: Payment for a base object or PaymentOracle for an extended object.
• account.id: string
  Retrieves the payments from the account with the specified ID or account number.

  Examples

  Select an example account.id=0.0.0.1+-account+79731 account.id=0.0.0.1-63156

• bill.id: string
  Retrieves the payments associated with the specified bill ID or bill number.

  Examples

  Select an example bill.id=0.0.0.1+-bill+257531 bill.id=B1-4

• fields: string
  The comma-separated list of fields to return in the response.

  Examples

  Select an example fields=paymentDate,account

• id: string
  Retrieves the payment with the specified payment item ID or payment item number.

  Examples

  Select an example id=0.0.0.1+-item-payment+106589 id=P1-3

• limit: integer
  The maximum number of results to return.

  Examples

  Select an example Use limit=10 to return the first 10 results only.

• offset: integer
  The number of results to offset the response by.

  Examples

  Select an example Use offset=10 to return results 10 and higher.

• paymentDate: string
  Retrieves the payments with a paymentDate that matches the specified date and time.

  Examples

  Select an example paymentDate=2025-01-01T04:00:27-08:00

• paymentDate.gt: string
  Retrieves the payments with a paymentDate that is greater than the specified date and time.

  Examples

  Select an example paymentDate.gt=2025-01-01T04:00:27-08:00

• paymentDate.gte: string
  Retrieves the payments with a paymentDate that is greater than or equal to the specified date and time.

  Examples

  Select an example paymentDate.gte=2025-01-01T04:00:27-08:00

• paymentDate.lt: string
  Retrieves the payments with a paymentDate that is less than the specified date and time.

  Examples

  Select an example paymentDate.lt=2025-01-01T04:00:27-08:00

• paymentDate.lte: string
  Retrieves the payments with a paymentDate that is less than or equal to the specified date and time.

  Examples

  Select an example paymentDate.lte=2025-01-01T04:00:27-08:00

• status: string
  Retrieves the payments with the specified status. The only valid value is Unallocated.

  Examples

  Select an example status=Unallocated

• totalAmount.value: number(float)
  Retrieves the payments with a totalAmount that is equal to the specified amount.

  Examples

  Select an example totalAmount.value=40

• totalAmount.value.gt: number(float)
  Retrieves the payments with a totalAmount that is greater than the specified amount.

  Examples

  Select an example totalAmount.value.gt=40

• totalAmount.value.gte: number(float)
  Retrieves the payments with a totalAmount that is greater than or equal to the specified amount.

  Examples

  Select an example totalAmount.value.gte=40

• totalAmount.value.lt: number(float)
  Retrieves the payments with a totalAmount that is less than the specified amount.

  Examples

  Select an example totalAmount.value.lt=40

• totalAmount.value.lte: number(float)
  Retrieves the payments with a totalAmount that is less than or equal to the specified amount.

  Examples

  Select an example totalAmount.value.lte=40

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

200 Response

The payments were retrieved successfully.

Headers

• X-Result-Count:
  The number of items returned in the response body.
• X-Total-Count:
  The total number of items that matched the criteria.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Payment
  Title: Payment

  A payment, including information about the payment, the payment amount, and the payment method.

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

Nested Schema : Payment

Type: object

Title: Payment

A payment, including information about the payment, the payment amount, and the payment method.

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.
• account(required): object AccountRef
  Refers to an account. An account may be a party account or a financial account.
• amount: object Money
  Represents a monetary amount.
• authorizationCode: string
  Title: Authorization code

  An authorization code from an external payment gateway.
• channel: object ChannelRef
  A reference to a channel.
• correlatorId: string
  Title: correlator ID

  A payment correlation ID from a client application.
• description: string
  Title: Payment Description

  The payment's description.
• href(required): string
  Title: Payment Href

  The payment's href.
• id(required): string
  Title: Payment ID

  The payment's ID.
• name: string
  Title: Payment Name

  The payment's name.
• payer: object Related Party
  Title: Related Party

  A party related to another object.
• paymentDate(required): string (date-time)
  Title: Payment Date

  The date the payment was made.
• paymentItem: array paymentItem
  Payment items that can be assigned to bills.
• paymentMethod(required): object Payment Method Ref Or Value
  Title: Payment Method Ref Or Value

  A link to the resource containing information about the payment method.
• status(required): string
  Title: Payment Status

  The payment's status.
• statusDate: string (date-time)
  Title: Status Date

  The date the payment's status was recorded.
• taxAmount: object Money
  Represents a monetary amount.
• totalAmount(required): object Money
  Represents a monetary amount.

{
    "required":[
        "id",
        "href",
        "paymentDate",
        "totalAmount",
        "account",
        "paymentMethod",
        "status"
    ],
    "type":"object",
    "title":"Payment",
    "properties":{
        "id":{
            "type":"string",
            "title":"Payment ID",
            "description":"The payment's ID."
        },
        "href":{
            "type":"string",
            "title":"Payment Href",
            "description":"The payment's href."
        },
        "authorizationCode":{
            "type":"string",
            "title":"Authorization code",
            "description":"An authorization code from an external payment gateway."
        },
        "correlatorId":{
            "type":"string",
            "title":"correlator ID",
            "description":"A payment correlation ID from a client application."
        },
        "description":{
            "type":"string",
            "title":"Payment Description",
            "description":"The payment's description."
        },
        "name":{
            "type":"string",
            "title":"Payment Name",
            "description":"The payment's name."
        },
        "paymentDate":{
            "type":"string",
            "title":"Payment Date",
            "description":"The date the payment was made.",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "title":"Payment Status",
            "description":"The payment's status."
        },
        "statusDate":{
            "type":"string",
            "title":"Status Date",
            "description":"The date the payment's status was recorded.",
            "format":"date-time"
        },
        "account":{
            "description":"An account related to the payment.",
            "$ref":"#/components/schemas/AccountRef"
        },
        "amount":{
            "description":"The payment's monetary amount.",
            "$ref":"#/components/schemas/Money"
        },
        "channel":{
            "description":"The payment's channel.",
            "$ref":"#/components/schemas/ChannelRef"
        },
        "payer":{
            "description":"The party that made the payment.",
            "$ref":"#/components/schemas/RelatedParty"
        },
        "paymentItem":{
            "type":"array",
            "description":"Payment items that can be assigned to bills.",
            "items":{
                "$ref":"#/components/schemas/PaymentItem"
            }
        },
        "paymentMethod":{
            "description":"The payment method.",
            "$ref":"#/components/schemas/PaymentMethodRefOrValue"
        },
        "taxAmount":{
            "description":"The amount of tax on the payment.",
            "$ref":"#/components/schemas/Money"
        },
        "totalAmount":{
            "description":"The total amount on the payment.",
            "$ref":"#/components/schemas/Money"
        },
        "@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."
        }
    },
    "description":"A payment, including information about the payment, the payment amount, and the payment method."
}

Nested Schema : AccountRef

Type: object

Refers to an account. An account may be a party account or a financial account.

Match All

Refers to an account. An account may be a party account or a financial account.

Show Source

• allOf EntityRef

{
    "type":"object",
    "description":"Refers to an account. An account may be a party account or a financial account.",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : Money

Type: object

Represents a monetary amount.

Show Source

• unit: string
  The currency's ISO 4217 three-letter code.
• value: number (double)
  A signed floating-point number whose sign depends on the API context.

{
    "type":"object",
    "description":"Represents a monetary amount.",
    "properties":{
        "unit":{
            "type":"string",
            "nullable":true,
            "description":"The currency's ISO 4217 three-letter code."
        },
        "value":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "description":"A signed floating-point number whose sign depends on the API context."
        }
    }
}

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 : 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 : paymentItem

Type: array

Payment items that can be assigned to bills.

Show Source

• Array of: object Payment Item
  Title: Payment Item

  A portion of a payment that can be assigned to a bill.

{
    "type":"array",
    "description":"Payment items that can be assigned to bills.",
    "items":{
        "$ref":"#/components/schemas/PaymentItem"
    }
}

Nested Schema : Payment Method Ref Or Value

Type: object

Title: Payment Method Ref Or Value

A link to the resource containing information about the payment method.

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(required): string
  Title: Type

  The payment method's type. Valid values are PaymentMethodRef for a credit or debit card, Cash, or Check. When the value is PaymentMethodRef, the payment method specified must be the one assigned to the bill unit. If you specify a different payment method, the one assigned to the bill unit is refunded instead. (For payments and refunds, @type is not used for subclassing.)
• account: array account
  Accounts associated with the payment method.
• description: string
  Title: Payment Method Description

  The payment method's description.
• href: string
  Title: Payment Method Href

  The payment method's href.
• id(required): string
  Title: Payment Method ID

  The payment method's ID or external ID.
• isPreferred: boolean
  Title: Payment Method Preferred

  Whether this is the preferred payment method (true) or not (false).
• name: string
  Title: Payment Method Name

  The payment method's name.
• relatedParty: object Related Party
  Title: Related Party

  A party related to another object.
• status: string
  Title: Status

  The payment method's status.
• statusDate: string (date-time)
  Title: Status Date

  The date the payment method's status was recorded.
• validFor: object TimePeriod
  Represents a time period with a start date, an end date, or both.

{
    "type":"object",
    "title":"Payment Method Ref Or Value",
    "properties":{
        "id":{
            "type":"string",
            "title":"Payment Method ID",
            "description":"The payment method's ID or external ID."
        },
        "href":{
            "type":"string",
            "title":"Payment Method Href",
            "description":"The payment method's href."
        },
        "description":{
            "type":"string",
            "title":"Payment Method Description",
            "description":"The payment method's description."
        },
        "isPreferred":{
            "type":"boolean",
            "title":"Payment Method Preferred",
            "description":"Whether this is the preferred payment method (<b>true</b>) or not (<b>false</b>)."
        },
        "name":{
            "type":"string",
            "title":"Payment Method Name",
            "description":"The payment method's name."
        },
        "status":{
            "type":"string",
            "title":"Status",
            "description":"The payment method's status."
        },
        "statusDate":{
            "type":"string",
            "title":"Status Date",
            "description":"The date the payment method's status was recorded.",
            "format":"date-time"
        },
        "account":{
            "type":"array",
            "description":"Accounts associated with the payment method.",
            "items":{
                "$ref":"#/components/schemas/AccountRef"
            }
        },
        "relatedParty":{
            "description":"The party associated with the payment method.",
            "$ref":"#/components/schemas/RelatedParty"
        },
        "validFor":{
            "description":"The time period for which the payment method is valid.",
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@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 payment method's type. Valid values are <b>PaymentMethodRef</b> for a credit or debit card, <b>Cash</b>, or <b>Check</b>. When the value is <b>PaymentMethodRef</b>, the payment method specified must be the one assigned to the bill unit. If you specify a different payment method, the one assigned to the bill unit is refunded instead. (For payments and refunds, @type is not used for subclassing.)"
        },
        "@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 link to the resource containing information about the payment method.",
    "required":[
        "id",
        "@type"
    ]
}

Nested Schema : EntityRef

Match All

Represents an entity reference schema for EntityRef classes.

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

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

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

Nested Schema : Addressable

Type: object

Defines a base schema for addressable entities.

Show Source

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

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

Nested Schema : EntityRef-allOf[2]

Type: object

Represents an entity reference schema for EntityRef classes.

Show Source

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

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

Nested Schema : Payment Item

Type: object

Title: Payment Item

A portion of a payment that can be assigned to a bill.

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 Money
  Represents a monetary amount.
• id: string
  Title: Payment Item ID

  The payment item's ID.
• item(required): EntityRef
• taxAmount: object Money
  Represents a monetary amount.
• totalAmount: object Money
  Represents a monetary amount.

{
    "required":[
        "item"
    ],
    "type":"object",
    "title":"Payment Item",
    "properties":{
        "id":{
            "type":"string",
            "title":"Payment Item ID",
            "description":"The payment item's ID."
        },
        "amount":{
            "description":"The payment item amount.",
            "$ref":"#/components/schemas/Money"
        },
        "item":{
            "description":"A payment item entity.",
            "$ref":"#/components/schemas/EntityRef"
        },
        "taxAmount":{
            "description":"The amount of tax on the payment item.",
            "$ref":"#/components/schemas/Money"
        },
        "totalAmount":{
            "description":"The total amount on the payment item.",
            "$ref":"#/components/schemas/Money"
        },
        "@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."
        }
    },
    "description":"A portion of a payment that can be assigned to a bill."
}

Nested Schema : account

Type: array

Accounts associated with the payment method.

Show Source

• Array of: object AccountRef
  Refers to an account. An account may be a party account or a financial account.

{
    "type":"array",
    "description":"Accounts associated with the payment method.",
    "items":{
        "$ref":"#/components/schemas/AccountRef"
    }
}

Nested Schema : TimePeriod

Type: object

Represents a time period with a start date, an end date, or both.

Show Source

• endDateTime: string (date-time)
  The end of the time period in IETF RFC 3339 format.

  Example: 1985-04-12T23:20:50.52Z
• startDateTime: string (date-time)
  The start of the time period in IETF RFC 3339 format.

  Example: 1985-04-12T23:20:50.52Z

{
    "type":"object",
    "description":"Represents a time period with a start date, an end date, or both.",
    "properties":{
        "startDateTime":{
            "description":"The start of the time period in IETF RFC 3339 format.",
            "type":"string",
            "nullable":true,
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z"
        },
        "endDateTime":{
            "description":"The end of the time period in IETF RFC 3339 format.",
            "type":"string",
            "nullable":true,
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z"
        }
    }
}

400 Response

The request isn't valid.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

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

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

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

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

401 Response

The client doesn't have the correct privileges.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

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

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

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

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

403 Response

The request wasn't authorized.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

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

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

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

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

404 Response

The requested resource couldn't be found.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

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

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

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

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

405 Response

This method is not allowed.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

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

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

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

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

409 Response

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

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

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

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

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

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

500 Response

The system encountered an internal error.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

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

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

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

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

Back to Top

Examples

• Example 1: Get Payments with Account ID Query Parameter

• Example 2: Get Payments with Bill Number Query Parameter

Example 1: Get Payments with Account ID Query Parameter

The following example shows how to get payments by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

The request uses the account.id query parameter to limit the results.

curl -X GET 'http://host:port/brm/payment/version/payment?account.id=0.0.0.1+-account+228862'

Response Body

The following example shows the contents of the response body in JSON format.

[
   {
      "id": "0.0.0.1+-item-payment+222690",
      "href": "http://host:port/brm/payment/version/payment/0.0.0.1+-item-payment+222690",
      "authorizationCode": "pinXXX",
      "correlatorId": "P1-8",
      "description": "Credit Card Payment",
      "name": "Billing Event Log",
      "paymentDate": "2025-01-08T07:38:46-08:00",
      "status": "Allocated",
      "statusDate": "2025-01-08T07:38:46-08:00",
      "account": {
         "id": "0.0.0.1+-account+228862",
         "href": null,
         "description": null,
         "name": "Adam Baker",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "billingAccount"
      },
      "amount": null,
      "channel": {
         "id": "0",
         "href": null,
         "name": "Unspecified",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": null
      },
      "payer": null,
      "paymentItem": null,
      "paymentMethod": {
         "id": null,
         "href": null,
         "description": null,
         "isPreferred": null,
         "name": "Credit Card",
         "status": null,
         "statusDate": null,
         "account": null,
         "relatedParty": null,
         "validFor": null,
         "@baseType": "PaymentMethodRefOrValue",
         "@schemaLocation": null,
         "@type": "PaymentMethodRefOrValue",
         "@referredType": null
      },
      "taxAmount": null,
      "totalAmount": {
         "unit": "USD",
         "value": 50.0
      },
      "@baseType": "Payment",
      "@schemaLocation": null,
      "@type": "Payment"
    },
    {
      "id": "0.0.0.1+-item-payment+221042",
      "href": "http://host:port/brm/payment/version/payment/0.0.0.1+-item-payment+221042",
      "authorizationCode": null,
      "correlatorId": "P1-7",
      "description": "",
      "name": "Billing Event Log",
      "paymentDate": "2025-01-08T07:33:05-08:00",
      "status": "Allocated",
      "statusDate": "2025-01-08T07:33:05-08:00",
      "account": {
         "id": "0.0.0.1+-account+228862",
         "href": null,
         "description": null,
         "name": "Adam Baker",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "billingAccount"
      },
      "amount": null,
      "channel": {
         "id": "0",
         "href": null,
         "name": "Unspecified",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": null
      },
      "payer": null,
      "paymentItem": [
         {
            "id": "0.0.0.1+-bill+226434",
            "amount": null,
            "item": {
               "id": "B1-31",
               "href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+226434",
               "name": null,
               "@baseType": "CustomerBill",
               "@schemaLocation": null,
               "@type": "CustomerBill",
               "@referredType": null
            },
            "taxAmount": null,
            "totalAmount": {
               "unit": "USD",
               "value": 55.0
            },
            "@baseType": "PaymentItem",
            "@schemaLocation": null,
            "@type": "PaymentItem"
         }
      ],
      "paymentMethod": {
         "id": null,
         "href": null,
         "description": null,
         "isPreferred": null,
         "name": "Cash",
         "status": null,
         "statusDate": null,
         "account": null,
         "relatedParty": null,
         "validFor": null,
         "@baseType": "PaymentMethodRefOrValue",
         "@schemaLocation": null,
         "@type": "Cash",
         "@referredType": null
      },
      "taxAmount": null,
      "totalAmount": {
         "unit": "USD",
         "value": 200.0
      },
      "@baseType": "Payment",
      "@schemaLocation": null,
      "@type": "Payment"
   }
]

Example 2: Get Payments with Bill Number Query Parameter

The following example shows how to get payments by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

The request uses the bill.id query parameter set to a bill number to limit the results.

curl -X GET 'http://host:port/brm/payment/version/payment?bill.id=Bill-123'

Response Body

The following example shows the contents of the response body in JSON format.

[
    {
      "id": "0.0.0.1+-item-payment+123456",
      "href": "http://host:port/brm/payment/version/payment/0.0.0.1+-item-payment+123456",
      "authorizationCode": "pinXXX",
      "correlatorId": "P1-10",
      "description": "Credit Card Payment",
      "name": "Billing Event Log",
      "paymentDate": "2025-01-08T07:38:46-08:00",
      "status": "Allocated",
      "statusDate": "2025-01-08T07:38:46-08:00",
      "account": {
         "id": "0.0.0.1+-account+099876",
         "href": null,
         "description": null,
         "name": "Mark Miller",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "billingAccount"
      },
      "amount": null,
      "channel": {
         "id": "0",
         "href": null,
         "name": "Unspecified",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": null
      },
      "payer": null,
      "paymentItem": null,
      "paymentMethod": {
         "id": null,
         "href": null,
         "description": null,
         "isPreferred": null,
         "name": "Credit Card",
         "status": null,
         "statusDate": null,
         "account": null,
         "relatedParty": null,
         "validFor": null,
         "@baseType": "PaymentMethodRefOrValue",
         "@schemaLocation": null,
         "@type": "PaymentMethodRefOrValue",
         "@referredType": null
      },
      "taxAmount": null,
      "totalAmount": {
         "unit": "EUR",
         "value": 158.50
      },
      "@baseType": "Payment",
      "@schemaLocation": null,
      "@type": "Payment"
   },
]

Back to Top