Get Audit Trails for a Transaction
get
/bcws/webresources/v1.0/payments/audit/{id}
Gets the list of audit details for the entire lifecycle of the payment for the specified transaction ID.
Request
Path Parameters
-
id(required): string
The ID of the payment transaction, such as T1,e7,0.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The audit trails were returned successfully.
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 : 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.
400 Response
The request isn't valid.
500 Response
An internal server error occurred.
Examples
This example shows how to get a payment's audit 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/audit/RG20'
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,
"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": "0.0.0.1+-account+123217",
"firstName": "Anders",
"lastName": "Larsen",
"amount": 200,
"status": 15,
"transactionId": "RG20",
"subTransactionId": "",
"csrLoginId": "HeadCSR",
"domainId": 14,
"reasonId": 2001
}
]