Jump to

• Request
• Response
• Examples

Create a Refund

post

/refund

Creates a refund.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json;charset=utf-8

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

Root Schema : Refund Create

Type: object

Title: Refund Create

A refund for a payment used in the create refund request.

The id, href, status, statusDate, and refundDate properties are not used in the create request.

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 refund correlation ID from a client application.
• description: string
  Title: Refund Description

  The refund's description.
• name: string
  Title: Refund Name

  The refund's name.
• payment: object PaymentRef
  A payment received at order time.
• 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.
• refundDate: string (date-time)
  Title: Refund Date

  The date when the refund was made.
• requestor: object Related Party
  Title: Related Party

  A party related to another object.
• taxAmount: object Money
  Represents a monetary amount.
• totalAmount(required): object Money
  Represents a monetary amount.

{
    "required":[
        "account",
        "paymentMethod",
        "totalAmount"
    ],
    "type":"object",
    "title":"Refund Create",
    "properties":{
        "authorizationCode":{
            "type":"string",
            "title":"Authorization code",
            "description":"An authorization code from an external payment gateway."
        },
        "correlatorId":{
            "type":"string",
            "title":"correlator ID",
            "description":"A refund correlation ID from a client application."
        },
        "description":{
            "type":"string",
            "title":"Refund Description",
            "description":"The refund's description."
        },
        "name":{
            "type":"string",
            "title":"Refund Name",
            "description":"The refund's name."
        },
        "refundDate":{
            "type":"string",
            "title":"Refund Date",
            "description":"The date when the refund was made.",
            "format":"date-time"
        },
        "account":{
            "description":"The account associated with the refund.",
            "$ref":"#/components/schemas/AccountRef"
        },
        "amount":{
            "description":"The refund amount.",
            "$ref":"#/components/schemas/Money"
        },
        "channel":{
            "description":"The refund channel.",
            "$ref":"#/components/schemas/ChannelRef"
        },
        "payment":{
            "description":"The payment to be refunded.",
            "$ref":"#/components/schemas/PaymentRef"
        },
        "paymentMethod":{
            "description":"The payment method for the refund.",
            "$ref":"#/components/schemas/PaymentMethodRefOrValue"
        },
        "requestor":{
            "description":"The party requesting the refund.",
            "$ref":"#/components/schemas/RelatedParty"
        },
        "taxAmount":{
            "description":"The refund tax amount.",
            "$ref":"#/components/schemas/Money"
        },
        "totalAmount":{
            "description":"The total refund amount.",
            "$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 refund for a payment used in the create refund request. <p> The <b>id</b>, <b>href</b>, <b>status</b>, <b>statusDate</b>, and <b>refundDate</b> properties are not used in the create request."
}

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

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

201 Response

The refund was created successfully.

Body ()

Root Schema : Refund

Type: object

Title: Refund

A refund for a payment.

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 refund correlation ID from a client application.
• description: string
  Title: Refund Description

  The refund's description.
• href: string
  Title: Refund Href

  The refund's href.
• id: string
  Title: Refund ID

  The refund's ID or item refund number.
• name: string
  Title: Refund Name

  The refund's name.
• payment: object PaymentRef
  A payment received at order time.
• 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.
• refundDate: string (date-time)
  Title: Refund Date

  The date when the refund was made.
• requestor: object Related Party
  Title: Related Party

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

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

  The date when the refund's status was recorded.
• taxAmount: object Money
  Represents a monetary amount.
• totalAmount: object Money
  Represents a monetary amount.

{
    "required":[
        "account",
        "paymentMethod"
    ],
    "type":"object",
    "title":"Refund",
    "properties":{
        "id":{
            "type":"string",
            "title":"Refund ID",
            "description":"The refund's ID or item refund number."
        },
        "href":{
            "type":"string",
            "title":"Refund Href",
            "description":"The refund'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 refund correlation ID from a client application."
        },
        "description":{
            "type":"string",
            "title":"Refund Description",
            "description":"The refund's description."
        },
        "name":{
            "type":"string",
            "title":"Refund Name",
            "description":"The refund's name."
        },
        "refundDate":{
            "type":"string",
            "title":"Refund Date",
            "description":"The date when the refund was made.",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "title":"Refund Status",
            "description":"The refund's status."
        },
        "statusDate":{
            "type":"string",
            "title":"Status Date",
            "description":"The date when the refund's status was recorded.",
            "format":"date-time"
        },
        "account":{
            "description":"The account associated with the refund.",
            "$ref":"#/components/schemas/AccountRef"
        },
        "amount":{
            "description":"The refund amount.",
            "$ref":"#/components/schemas/Money"
        },
        "channel":{
            "description":"The refund channel.",
            "$ref":"#/components/schemas/ChannelRef"
        },
        "payment":{
            "description":"The payment to be refunded.",
            "$ref":"#/components/schemas/PaymentRef"
        },
        "paymentMethod":{
            "description":"The payment method for the refund.",
            "$ref":"#/components/schemas/PaymentMethodRefOrValue"
        },
        "requestor":{
            "description":"The party requesting the refund.",
            "$ref":"#/components/schemas/RelatedParty"
        },
        "taxAmount":{
            "description":"The refund tax amount.",
            "$ref":"#/components/schemas/Money"
        },
        "totalAmount":{
            "description":"The total refund amount.",
            "$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 refund for a payment."
}

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

405 Response

This method is not allowed.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

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

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

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

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

409 Response

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

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

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

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

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

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

500 Response

The system encountered an internal error.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

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

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

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

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

Back to Top

Examples

• Example 1: Create a Refund Using Payment Method and Account POIDs

• Example 2: Create a Refund Using Payment Method and Account Numbers

Example 1: Create a Refund Using Payment Method and Account POIDs

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

The -d option specifies the file to attach as the request body.

curl -X POST 'http://host:port/brm/payment/version/refund' -d @refundCreate.json

Request Body

The following is an example of the contents of the refundCreate.json file sent as the request body.

{
   "@type": "RefundCreate",
   "account": {
      "id": "0.0.0.1+-account+84808"
   },
   "paymentMethod": { 
      "id": "0.0.0.1+-payinfo-dd+249648",
      "@type": "PaymentMethodRef"
   },
   "totalAmount": {
      "value": 10,
      "unit": "USD"
   },
   "description": "Refunding service fee."
}

Response Body

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

{
   "id": "0.0.0.1+-item-refund+82547",
   "href": "http://host:port/brm/payment/version/refund/0.0.0.1+-item-refund+82547",
   "authorizationCode": null,
   "correlatorId": "R1-30",
   "description": "Item refund",
   "name": "Billing Event Log",
   "refundDate": "2025-12-09T00:38:15-08:00",
   "status": "Success",
   "statusDate": "2025-12-09T00:38:15-08:00",
   "account": {
      "id": "0.0.0.1+-account+84808",
      "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
   },
   "payment": null,
   "paymentMethod": {
      "id": "0.0.0.1+-payinfo-dd+249648",
      "href": null,
      "description": null,
      "isPreferred": true,
      "name": "Adam Baker's Direct Debit Account",
      "status": null,
      "statusDate": null,
      "account": "0.0.0.1+-account+104221",
      "relatedParty": null,
      "validFor": null,
      "@baseType": "PaymentMethodRefOrValue",
      "@schemaLocation": null,
      "@type": "PaymentMethodRef",
      "@referredType": null
   },
   "requestor": null,
   "taxAmount": null,
   "totalAmount": {
      "unit": "USD",
      "value": 10.0
   },
   "@baseType": "Refund",
   "@schemaLocation": null,
   "@type": "Refund"
}

Example 2: Create a Refund Using Payment Method and Account Numbers

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

The -d option specifies the file to attach as the request body.

curl -X POST 'http://host:port/brm/payment/version/refund' -d @refundCreate.json

Request Body

The following is an example of the contents of the refundCreate.json file sent as the request body.

{
   "@type": "RefundCreate",
   "account": {
      "id": "0.0.0.1-2172620"
   },
   "paymentMethod": { 
      "id": "P-1",
      "@type": "PaymentMethodRef"
   },
   "totalAmount": {
      "value": 10,
      "unit": "USD"
   },
   "description": "Refunding service fee."
}

Response Body

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

{
   "id": "0.0.0.1+-item-refund+82547",
   "href": "http://host:port/brm/payment/version/refund/0.0.0.1+-item-refund+82547",
   "authorizationCode": null,
   "correlatorId": "R1-30",
   "description": "Item refund",
   "name": "Billing Event Log",
   "refundDate": "2025-12-09T00:38:15-08:00",
   "status": "Success",
   "statusDate": "2025-12-09T00:38:15-08:00",
   "account": {
      "id": "0.0.0.1-2172620",
      "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
   },
   "payment": null,
   "paymentMethod": {
      "id": "P-1",
      "href": null,
      "description": null,
      "isPreferred": true,
      "name": "Adam Baker's Direct Debit Account",
      "status": null,
      "statusDate": null,
      "account": "0.0.0.1+-account+104221",
      "relatedParty": null,
      "validFor": null,
      "@baseType": "PaymentMethodRefOrValue",
      "@schemaLocation": null,
      "@type": "PaymentMethodRef",
      "@referredType": null
   },
   "requestor": null,
   "taxAmount": null,
   "totalAmount": {
      "unit": "USD",
      "value": 10.0
   },
   "@baseType": "Refund",
   "@schemaLocation": null,
   "@type": "Refund"
}

Back to Top