Jump to

• Request
• Response
• Examples

Get a Payment by ID

get

/payment/{id}

Gets the specified payment.

Request

Path Parameters

• id(required): string
  The ID of the payment to get.

  Example:

  0.0.0.1+-item-payment+106589

Query Parameters

• @type: string
  The type of object to return.

  Example:

  Use @type=Payment for a base object, or @type=PaymentOracle for an extended object.

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

  Example:

  fields=name,paymentItem

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

200 Response

Success

Body ()

Root 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 Account Ref
  Title: Account Ref

  A reference to an account.
• amount: object Money
  A base / value business entity used to represent money.
• authorizationCode: string
  Title: Authorization code

  An authorization code from an external payment gateway.
• channel: object Channel Ref
  Title: Channel Ref

  A reference to a channel.
• correlatorId: string
  Title: correlator ID

  An 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 which 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
  A base / value business entity used to represent money.
• totalAmount(required): object Money
  A base / value business entity used to represent money.

{
    "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":"An 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 which 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 : Account Ref

Type: object

Title: Account Ref

A reference to an account.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• description: string
  Title: Description

  The account reference's description.
• href: string
  Title: Account Href

  The account reference's href.
• id(required): string
  Title: Account ID

  The account reference's ID.
• name: string
  Title: Account Name

  The account reference's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Account Ref",
    "properties":{
        "id":{
            "type":"string",
            "title":"Account ID",
            "description":"The account reference's ID."
        },
        "href":{
            "type":"string",
            "title":"Account Href",
            "description":"The account reference's href."
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The account reference's description."
        },
        "name":{
            "type":"string",
            "title":"Account Name",
            "description":"The account reference'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 an account."
}

Nested Schema : Money

Type: object

A base / value business entity used to represent money.

Show Source

• unit(required): string
  Refers to the currency (ISO4217 norm uses 3 letters to define the currency).
• value(required): number (float)
  A positive floating point number.

{
    "type":"object",
    "description":"A base / value business entity used to represent money.",
    "required":[
        "value",
        "unit"
    ],
    "properties":{
        "value":{
            "type":"number",
            "format":"float",
            "description":"A positive floating point number."
        },
        "unit":{
            "type":"string",
            "description":"Refers to the  currency (ISO4217 norm uses 3 letters to define the currency)."
        }
    }
}

Nested Schema : Channel Ref

Type: object

Title: Channel Ref

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",
    "title":"Channel Ref",
    "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
  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":{
        "id":{
            "type":"string",
            "title":"Party ID",
            "description":"The party's ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party's href."
        },
        "name":{
            "type":"string",
            "title":"Party Name",
            "description":"The party's name."
        },
        "role":{
            "type":"string",
            "title":"Party Role",
            "description":"The party's role."
        },
        "@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 party related to another object."
}

Nested Schema : paymentItem

Type: array

Payment items which 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 which 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 payment method's type, further refined from the @type value. To create a payment when @type is PaymentMethodRef, this is required, and valid values are tokenizedCard, bankAccountDebit, and bankCard.
• @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 will be used instead.
• 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.
• 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
  A period of time.

{
    "type":"object",
    "title":"Payment Method Ref Or Value",
    "properties":{
        "id":{
            "type":"string",
            "title":"Payment Method ID",
            "description":"The payment method's 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 will be used instead."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The payment method's type, further refined from the <b>@type</b> value. To create a payment when <b>@type</b> is <b>PaymentMethodRef</b>, this is required, and valid values are <b>tokenizedCard</b>, <b>bankAccountDebit</b>, and <b>bankCard</b>."
        }
    },
    "description":"A link to the resource containing information about the payment method.",
    "required":[
        "id",
        "@type"
    ]
}

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
  A base / value business entity used to represent money.
• id: string
  Title: Payment Item ID

  The payment item's ID.
• item(required): object Entity Ref
  Title: Entity Ref

  An entity reference schema.
• taxAmount: object Money
  A base / value business entity used to represent money.
• totalAmount: object Money
  A base / value business entity used to represent money.

{
    "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 : Entity Ref

Type: object

Title: Entity Ref

An entity reference schema.

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

  The entity's href..
• id(required): string
  Title: Entity ID

  The entity's ID.
• name: string
  Title: Entity Name

  The entity's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Entity Ref",
    "properties":{
        "id":{
            "type":"string",
            "title":"Entity ID",
            "description":"The entity's ID."
        },
        "href":{
            "type":"string",
            "title":"Entity Href",
            "description":"The entity's href.."
        },
        "name":{
            "type":"string",
            "title":"Entity Name",
            "description":"The entity'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":"An entity reference schema."
}

Nested Schema : account

Type: array

Accounts associated with the payment method.

Show Source

• Array of: object Account Ref
  Title: Account Ref

  A reference to an account.

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

Nested Schema : TimePeriod

Type: object

A period of time.

Show Source

• endDateTime: string (date-time)
  Title: End Time Period

  The end of the time period in IETC-RFC-3339 format.
• startDateTime: string (date-time)
  Title: Start Time Period

  The start of the time period in IETC-RFC-3339 format.

{
    "type":"object",
    "description":"A period of time.",
    "properties":{
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "title":"End Time Period",
            "description":"The end of the time period in IETC-RFC-3339 format."
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "title":"Start Time Period",
            "description":"The start of the time period in IETC-RFC-3339 format."
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : Error

Type: object

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

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

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

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

403 Response

Forbidden

Body ()

Root Schema : Error

Type: object

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

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

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

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

405 Response

Method Not allowed

Body ()

Root Schema : Error

Type: object

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

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

409 Response

Conflict

Body ()

Root Schema : Error

Type: object

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

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

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

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

Back to Top

Examples

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

curl -X GET 'http://host:port/brm/payment/version/payment/0.0.0.1+-item-payment+84530'

Example of the Response Body

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

{
    "id": "0.0.0.1+-item-payment+84530",
    "href": "http://host:port/brm/payment/version/payment/0.0.0.1+-item-payment+84530",
    "authorizationCode": null,
    "correlatorId": "P1-1",
    "description": "",
    "name": "Billing Event Log",
    "paymentDate": "2020-05-01T12:01:23-07:00",
    "status": "Unallocated",
    "statusDate": "2020-05-01T12:01:23-07:00",
    "account": {
        "id": "0.0.0.1+-account+103533",
        "href": null,
        "description": null,
        "name": "Sunny Awal",
        "@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": "Cash",
        "status": null,
        "statusDate": null,
        "account": null,
        "relatedParty": null,
        "validFor": null,
        "@baseType": "PaymentMethodRefOrValue",
        "@schemaLocation": null,
        "@type": "Cash",
        "@referredType": null,
        "details": {
            "receiptNo": "",
            "receiptDate": "2020-07-13T08:53:10-07:00"
        }
    },
    "taxAmount": null,
    "totalAmount": {
        "unit": "USD",
        "value": 10.0
    },
    "@baseType": "Payment",
    "@schemaLocation": null,
    "@type": "Payment"
}

Back to Top