Get Details for a Payment
get
/bcws/webresources/v1.0/payments/{id}
Gets the details about a payment.
Request
Path Parameters
-
id(required): string
The ID of the payment or reversal to get, such as 0.0.0.1+-item-payment+123456789732590266.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The payment details were returned successfully.
Root Schema : paymentDetails
Type:
Show Source
object
-
accountId(required): string
The ID of the account.
-
allocatedAmount: number
The amount of the payment that has been allocated.
-
billDetails: array
billDetails
The list of bill details associated with the payment.
-
currencyId: integer
(int32)
The currency ID of the payment.
-
eventRef: object
ResourceRef
-
extension: object
extension
The extended attributes.
-
notes: array
notes
-
originalPaymentAmount: number
The amount paid against the original bill.
-
originalPaymentDetails: object
OriginalPaymentDetails
-
payinfoTypeObject: object
Discriminator: @class
Discriminator:
{ "propertyName":"@class" }
-
paymentAction: integer
(int32)
Whether the payment has been reversed or suspended. Can be one of the following:
- 0: Not reversed.
- 1: Reversed.
- 2: Suspended.
-
paymentAuditDetails: array
paymentAuditDetails
-
paymentId: string
The ID of the payment.
-
paymentType: integer
(int64)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
-
postedDate: string
(date-time)
The date and time the payment was posted.
-
receiptDate: string
(date-time)
The date and time the payment receipt was issued.
-
refundedDetails: array
refundedDetails
-
reversalAmount(required): number
The amount of the payment reversal.
-
reversalDate: string
(date-time)
The date and time the payment reversal occurred.
-
reversalId(required): string
The ID of the payment reversal.
-
subTransactionId: string
The ID of the subtransaction.
-
transactionId: string
The ID of the transaction.
-
unallocatedAmount: number
The amount of the payment that hasn't been allocated yet.
Nested Schema : billDetails
Type:
array
The list of bill details associated with the payment.
Show Source
-
Array of:
object BillDetails
The list of bill details associated with the payment.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : OriginalPaymentDetails
Type:
Show Source
object
-
accountId: string
The account ID.
-
paymentId: string
The payment ID.
-
paymentItemNumber: string
The payment item number.
Nested Schema : Discriminator: @class
Type:
Show Source
object
-
accountObj: object
ResourceRef
-
creationDate: string
(date-time)
The date and time the payment type was created.
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
-
name: string
The name of the payment type.
-
paymentType: integer
(int32)
The payment type.
Nested Schema : BillDetails
Type:
object
The list of bill details associated with the payment.
Show Source
-
accountNumber(required): string
The account number associated with the bill.
-
billId(required): string
The bill ID.
-
billUnitId(required): string
The ID for the bill unit associated with the bill.
-
cycleEnds: string
(date-time)
The date and time the billing cycle ends.
-
cycleStarts: string
(date-time)
The date and time the billing cycle starts.
-
dueAmount(required): number
The total amount due.
-
dueDate(required): string
(date-time)
The due date for the bill.
-
itemsAffected: array
itemsAffected
Affected bill items.
-
itemsAffectedCount: integer
(int64)
The number of bill items affected by the bill.
Nested Schema : itemsAffected
Type:
array
Affected bill items.
Show Source
-
Array of:
object ItemsAffected
Affected bill items.
Nested Schema : ItemsAffected
Type:
object
Affected bill items.
Show Source
-
accountNumber(required): string
The account number associated with the bill item.
-
amount(required): number
The bill item amount.
-
billNumber(required): string
The bill number associated with the bill item.
-
billUnitId(required): string
The ID of the bill unit associated with the bill item.
-
cycleEnds: string
(date-time)
The date and time the billing cycle ends.
-
cycleStarts: string
(date-time)
The date and time the billing cycle starts.
-
item(required): string
The bill item.
-
settledNonTaxedAmount(required): number
The nontaxable amount for the bill item settled by the payment.
-
settledTaxAmount(required): number
The amount of tax for the bill item settled by the payment.
-
settledTaxedAmount(required): number
The taxable amount for the bill item settled by the payment.
Nested Schema : Notes
Type:
Show Source
object
-
accountId(required): string
The ID of the account associated with the note.
-
amount: number
The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
-
billId: string
The ID of the bill associated with the note.
-
billUnitId: string
The ID of the bill unit associated with the note.
-
closedDate: string
(date-time)
The date and time the note was resolved.
-
comments: array
comments
The list of comments associated with the note.
-
count: integer
(int32)
The number of comments associated with the note.
-
domainId: integer
(int32)
The domain ID associated with the note.
-
effectiveDate: string
(date-time)
The date and time the comment was posted.
-
eventId: string
The ID of the event associated with the note.
-
extension: object
extension
The extended attributes.
-
header: string
The header associated with the note.
-
id: string
The ID.
-
itemId: string
The ID of the item associated with the note.
-
reasonId: integer
(int32)
The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
-
serviceId: string
The service ID associated with the note.
-
status: number
The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
-
subType: integer
(int32)
The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
-
type: integer
(int32)
The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
Nested Schema : comments
Type:
array
The list of comments associated with the note.
Show Source
-
Array of:
object Comments
The list of comments associated with the note.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Comments
Type:
object
The list of comments associated with the note.
Show Source
-
comment(required): string
The comment.
-
csrAccountId: string
The CSR's account ID.
-
csrFirstName: string
The CSR's first name.
-
csrLastName: string
The CSR's last name.
-
csrLoginId: string
The login ID associated with the CSR.
-
entryDate: string
(date-time)
The date and time the comment was entered by the CSR.
-
externalUser: string
The external user.
-
trackingId: string
The tracking ID.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : PaymentAuditDetailsType
Type:
Show Source
object
-
accountNumber: string
The account number.
-
accountRef(required): object
ResourceRef
-
activityDate(required): string
(date-time)
The date and time the payment activity occurred.
-
amount(required): number
The amount of the payment.
-
csrLoginId: string
The CSR's login ID.
-
domainId: integer
(int32)
The domain ID. 14 is for payment suspense management. 15 is for payment suspense action owners. 16 is for payment suspense reversals.
-
extension: object
extension
The extended attributes.
-
firstName: string
The first name associated with the account.
-
lastName: string
The last name associated with the account.
-
paymentItemRef: object
ResourceRef
-
paymentTypeEventRef: object
ResourceRef
-
reasonId: integer
(int32)
The ID of the reason code.
-
status: integer
(int32)
The status of the payment. Successful payment statuses are 0 to 14. Suspended payment statuses are 15 to 29. Failed payment statuses are 30 to 44.
-
subTransactionId: string
The subtransaction ID.
-
transactionId: string
The transaction ID.
Nested Schema : extension
Type:
object
The extended attributes.
500 Response
An internal server error occurred.
Examples
This example shows how to get a payment's details by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X GET 'http://hostname:port/bcws/webresources/version/payments/0.0.0.1+-item-payment+119786'
where:
- hostname is the URL for the Billing Care REST server.
- port is the port for the Billing Care REST server.
- version is the version of the API you're using, such as v1.0.
Example of Response Body
This example shows the contents of the response body in JSON format.
{
"extension": null,
"originalPaymentAmount": -200,
"allocatedAmount": 0,
"unallocatedAmount": -200,
"currencyId": 840,
"receiptDate": 1585787580000,
"postedDate": 1585787580000,
"paymentType": 10013,
"paymentAction": null,
"paymentId": "P1-66",
"transactionId": "RG20200000009699",
"subTransactionId": "",
"eventRef": {
"id": "0.0.0.1+-event-billing-payment-wtransfer+322869390473288682",
"uri": null
},
"notes": [
{
"extension": null,
"id": "0.0.0.1+-note+123110",
"accountId": "0.0.0.1+-account+123217",
"amount": 0,
"billUnitId": "0.0.0.0++0",
"billId": null,
"closedDate": 0,
"count": 3,
"effectiveDate": 1594713029000,
"eventId": "0.0.0.0++0",
"header": "",
"itemId": "0.0.0.1+-item-payment+119786",
"subType": 802,
"type": 800,
"domainId": 14,
"reasonId": 0,
"serviceId": "0.0.0.0++0",
"status": 102,
"comments": [
{
"csrLoginId": "HeadCSR",
"csrFirstName": "Alia",
"csrLastName": "Abadi",
"csrAccountId": "CSR1234",
"externalUser": "weblogic",
"comment": "Customer called to confirm we received payment.",
"trackingId": "",
"entryDate": 1594713029000
}
]
}
],
"accountId": "0.0.0.1+-account+123217",
"reversalId": null,
"reversalAmount": null,
"reversalDate": null,
"payinfoTypeObject": {
"@class": "com.oracle.communications.brm.cc.model.Externalpayment10013",
"extension": null,
"id": null,
"creationDate": null,
"accountObj": null,
"paymentType": null,
"name": null,
"externalType": false,
"wireTransferInfo": [
{
"effectiveDate": 0,
"wireTransferId": "33787300000009",
"bankCode": "2B420",
"bankAccountNo": "160010",
"elem": null
}
]
},
"originalPaymentDetails": {
"paymentId": "0.0.0.1+-item-payment+119786",
"accountId": "0.0.0.1+-account+123217",
"paymentItemNumber": ""
},
"billDetails": [
{
"billId": "B1-2",
"cycleStarts": 1589190400000,
"cycleEnds": 1589446445000,
"dueAmount": -200,
"dueDate": 1590641967000,
"eventsAffectedCount": 0,
"itemsAffectedCount": 1,
"itemsAffected": [
{
"accountNumber": "0.0.0.1-57615",
"billNumber": "B1-2",
"amount": -200,
"item": "Cycle forward,B1-2,3",
"billUnitName": "Bill Unit(1)",
"cycleStarts": 1589180400000,
"cycleEnds": 1589446645000,
"settledTaxAmount": 20,
"settledTaxedAmount": 200,
"settledNonTaxedAmount": 0
}
]
"paymentAuditDetails": [
{
"extension": null,
"paymentTypeEventRef": {
"id": "0.0.0.1+-event-billing-payment-wtransfer+322869390473288682",
"uri": null
},
"activityDate": 1585787580000,
"accountRef": {
"id": "0.0.0.1+-account+123217",
"uri": null
},
"paymentItemRef": {
"id": "0.0.0.1+-item-payment+119786",
"uri": null
},
"accountNumber": "",
"firstName": null,
"lastName": null,
"amount": 200,
"status": 15,
"transactionId": "RG20200000009699",
"subTransactionId": "",
"csrLoginId": null,
"domainId": 14,
"reasonId": 2001
}
]
}