Jump to

• Request
• Response
• Examples

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 Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The audit trails were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object PaymentAuditDetailsType

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PaymentAuditDetailsType"
    }
}

Nested Schema : PaymentAuditDetailsType

Type: object

Show Source

• 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.

{
    "required":[
        "accountRef",
        "activityDate",
        "amount"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "paymentTypeEventRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "activityDate":{
            "type":"string",
            "description":"The date and time the payment activity occurred.",
            "format":"date-time"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "paymentItemRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number."
        },
        "firstName":{
            "type":"string",
            "description":"The first name associated with the account."
        },
        "lastName":{
            "type":"string",
            "description":"The last name associated with the account."
        },
        "amount":{
            "type":"number",
            "description":"The amount of the payment."
        },
        "status":{
            "type":"integer",
            "description":"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.",
            "format":"int32"
        },
        "transactionId":{
            "type":"string",
            "description":"The transaction ID."
        },
        "subTransactionId":{
            "type":"string",
            "description":"The subtransaction ID."
        },
        "csrLoginId":{
            "type":"string",
            "description":"The CSR's login ID."
        },
        "domainId":{
            "type":"integer",
            "description":"The domain ID. 14 is for payment suspense management. 15 is for payment suspense action owners. 16 is for payment suspense reversals.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The ID of the reason code.",
            "format":"int32"
        }
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"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.

Back to Top

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
    }
]

Back to Top