1. REST Services Manager API for Billing and Revenue Management
  2. Tasks
  3. Payment Management
  4. Payment

Get a Payment by ID

get

/payment/{id}

Gets the specified payment.

Request

Path Parameters
Query Parameters
  • The type of object to return.
    Example:
    Use @type=Payment for a base object, or @type=PaymentOracle for an extended object.
  • 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

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
Nested Schema : Account Ref
Type: object
Title: Account Ref
An account's reference.
Show Source
Nested Schema : Money
Type: object
Title: Money
An amount of money.
Show Source
Nested Schema : Channel Ref
Type: object
Title: Channel Ref
A reference to a channel.
Show Source
Nested Schema : Related Party
Type: object
Title: Related Party
A party related to another object.
Show Source
Nested Schema : paymentItem
Type: array
Payment items which can be assigned to bills.
Show Source
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
  • Title: Base Type
    The object's superclass.
  • 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.
  • Title: Schema Location
    A URI to a JSON-Schema file that defines additional attributes and relationships.
  • 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
    Accounts associated with the payment method.
  • Title: Payment Method Description
    The payment method's description.
  • Title: Payment Method Href
    The payment method's href.
  • Title: Payment Method ID
    The payment method's ID.
  • Title: Payment Method Preferred
    Whether this is the preferred payment method (true) or not (false).
  • Title: Payment Method Name
    The payment method's name.
  • Related Party
    Title: Related Party
    A party related to another object.
  • Title: Status
    The payment method's status.
  • Title: Status Date
    The date the payment method's status was recorded.
  • Time Period
    Title: Time Period
    A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Nested Schema : Payment Item
Type: object
Title: Payment Item
A portion of a payment that can be assigned to a bill.
Show Source
Nested Schema : Entity Ref
Type: object
Title: Entity Ref
An entity reference schema.
Show Source
Nested Schema : account
Type: array
Accounts associated with the payment method.
Show Source
Nested Schema : Time Period
Type: object
Title: Time Period
A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Show Source

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

404 Response

Not Found
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

405 Response

Method Not allowed
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
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