Auditing

Get event trail for payment

Gets an audit trail of a payment's state changes on a local RippleNet instance.

get/audit/payment/{id}

Request

Base URL
//[domainPrefix].ripplexcurrent.com/v4 (relative, and it does not resolve against the document’s source URL)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/ripple/apis/ripplenet-server-api/docs/audit/payment/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Unique identifier of a payment.

Response

Payment state change event trail.

featureNamestring

Feature name associated with the entityId. Possible values are payment.

eventDetailstring

Detailed description of the event.

entityIdstring uuid

UUID representing an event.

String representation of the action being taken, where DS = downstream and US = upstream in the messaging processing pipeline.

createdAtstring

Timestamp of the audit event.

messageSenderstring RippleNetAddress

The RippleNetAddress of the originator of the message that triggered the creation of this event.

messageTypestring

The type of message that was being processed that triggered the creation of this event.

Example response

[
  {
    "featureName": "payment",
    "eventDetail": "Updated Payment to state PREPARED",
    "entityId": "d485f100-2af7-4e48-9ab1-3c7e28775691",
    "messageAction": "STATE_CHANGE",
    "createdAt": "2019-10-01T18:24:28.040000Z",
    "messageSender": "default",
    "messageType": "SETTLEMENT_PREPARE"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.