--- title: "GET /v1/portfolios/{portfolioSlug}/payment-requests/{paymentRequestId}/audit-trail" method: GET path: "/v1/portfolios/{portfolioSlug}/payment-requests/{paymentRequestId}/audit-trail" tags: ["PaymentRequestAuditTrail"] --- # GET /v1/portfolios/{portfolioSlug}/payment-requests/{paymentRequestId}/audit-trail `GET /v1/portfolios/{portfolioSlug}/payment-requests/{paymentRequestId}/audit-trail` ## Request - Base URL: `https://api.tokenbooks.io` (the document declares no server; this is the origin it was published from) - URL: `https://api.tokenbooks.io/v1/portfolios/{portfolioSlug}/payment-requests/{paymentRequestId}/audit-trail` - Auth: API key in header `x-api-key` ## Path parameters - `portfolioSlug` string, required - `paymentRequestId` string, required ## Query parameters - `minVersion` number: Only return events at or after this version. - `maxVersion` number: Only return events at or before this version. - `limit` number: Maximum number of events to return. - `reverse` boolean: Return events in descending version order. ## Response `200` - PaymentRequestAuditTrailResponseDto - `success` boolean, required - `aggregateId` string, required - `events` object[], required - `event` union, required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_CREATED', required - `timestamp` string, date-time, required - `payload` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `requestNumber` string, required - `toAddress` string, required - `counterpartyId` string - `token` object, required - `tokenAddress` string, required - `chainId` string, required - `decimals` integer, required - `assetId` string, required - `amount` string, required - `ledgerAccountId` string - `responsibilityCenterAssignments` object[] - `responsibilityCenterTypeId` string, required - `responsibilityCenterId` string, required - `percentageBps` integer, required - `description` string, required - `fileAttachments` object[], required - `id` string, required - `fileName` string, required - `fileSize` integer, required - `mimeType` string, required - `uploadedByUserId` string, required - `uploadedAt` string, date-time, required - `requestedByUserId` string, required - `requestedAt` string, date-time, required - `paymentMethodId` string - `fiatAmount` string - `fiatCurrency` string - `payoutCurrency` string - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_UPDATED', required - `timestamp` string, date-time, required - `payload` object, required - `toAddress` string - `counterpartyId` string - `token` object - `tokenAddress` string, required - `chainId` string, required - `decimals` integer, required - `assetId` string, required - `amount` string - `ledgerAccountId` string - `responsibilityCenterAssignments` object[] - `responsibilityCenterTypeId` string, required - `responsibilityCenterId` string, required - `percentageBps` integer, required - `description` string - `paymentMethodId` union - string - unknown - `fiatAmount` union - string - unknown - `fiatCurrency` union - string - unknown - `payoutCurrency` union - string - unknown - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_SUBMITTED', required - `timestamp` string, date-time, required - `payload` object, required - `submittedAt` string, date-time, required - `assignedApproverIds` string[] - `approvalGroups` object[] - `groupId` string, required - `groupName` string, required - `approverUserIds` string[], required - `requiredCount` integer, required - `approvals` object[], required - … - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_APPROVED', required - `timestamp` string, date-time, required - `payload` object, required - `userId` string, required - `notes` string - `timestamp` string, date-time, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_REJECTED', required - `timestamp` string, date-time, required - `payload` object, required - `userId` string, required - `notes` string - `timestamp` string, date-time, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_RETURNED', required - `timestamp` string, date-time, required - `payload` object, required - `userId` string, required - `notes` string - `timestamp` string, date-time, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_CANCELLED', required - `timestamp` string, date-time, required - `payload` object, required - `reason` string - `cancelledAt` string, date-time, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_CONVERTED', required - `timestamp` string, date-time, required - `payload` object, required - `paymentTransactionId` string - `convertedByUserId` string, required - `convertedAt` string, date-time, required - `purposeOfPayment` 'payment_for_goods' | 'payment_for_business_services' | 'payment_for_salary_or_benefits' | 'capital_investment_or_item' | 'other' - `sourceOfFunds` 'business_income' | 'business_profit' | 'other' - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_MOVED_FROM_CONVERTED_TO_APPROVED', required - `timestamp` string, date-time, required - `payload` object, required - `reason` string, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_MOVED_TO_DUPLICATE_PAYMENT_TRANSACTION', required - `timestamp` string, date-time, required - `payload` object, required - `previousPaymentTransactionId` string, required - `newPaymentTransactionId` string, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_MOVED_TO_RESTARTED_PAYMENT_TRANSACTION', required - `timestamp` string, date-time, required - `payload` object, required - `previousPaymentTransactionId` string, required - `newPaymentTransactionId` string, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_DELETED', required - `timestamp` string, date-time, required - `payload` object, required - `reason` string - `deletedAt` string, date-time, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_FILE_ATTACHED', required - `timestamp` string, date-time, required - `payload` object, required - `file` object, required - `id` string, required - `fileName` string, required - `fileSize` integer, required - `mimeType` string, required - `uploadedByUserId` string, required - `uploadedAt` string, date-time, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_FILE_REMOVED', required - `timestamp` string, date-time, required - `payload` object, required - `fileId` string, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_APPROVERS_UPDATED', required - `timestamp` string, date-time, required - `payload` object, required - `addApproverIds` string[], required - `removeApproverIds` string[], required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_REAP_METADATA_UPDATED', required - `timestamp` string, date-time, required - `payload` object, required - `purposeOfPayment` 'payment_for_goods' | 'payment_for_business_services' | 'payment_for_salary_or_benefits' | 'capital_investment_or_item' | 'other', required - `sourceOfFunds` 'business_income' | 'business_profit' | 'other', required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_REAP_ATTEMPT_CREATED', required - `timestamp` string, date-time, required - `payload` object, required - `reapPaymentId` string, required - `reapReceivingPartyId` union - string - unknown - `status` 'draft' | 'quote_expired' | 'awaiting_approval' | 'awaiting_funds' | 'under_review' | 'requires_action' | 'payout_completed' | 'cancellation_requested' | 'cancelled' | 'failed', required - `statusDetails` union - string - unknown - `senderAmount` union - string - unknown - `senderCurrency` union - string - unknown - `receivingAmount` union - string - unknown - `receivingCurrency` union - string - unknown - `fxInfo` union - object - … - unknown - `feeInfo` union - object - … - unknown - `quoteValidTo` union - string, date-time - unknown - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_REAP_QUOTE_ACCEPTED', required - `timestamp` string, date-time, required - `payload` object, required - `reapPaymentId` string, required - `status` 'draft' | 'quote_expired' | 'awaiting_approval' | 'awaiting_funds' | 'under_review' | 'requires_action' | 'payout_completed' | 'cancellation_requested' | 'cancelled' | 'failed', required - `statusDetails` union - string - unknown - `quoteAcceptedAt` string, date-time, required - `fundingDeadline` union - string, date-time - unknown - `senderAmount` union - string - unknown - `fxInfo` union - object - … - unknown - `feeInfo` union - object - … - unknown - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_REAP_STATUS_UPDATED', required - `timestamp` string, date-time, required - `payload` object, required - `reapPaymentId` string, required - `previousStatus` 'draft' | 'quote_expired' | 'awaiting_approval' | 'awaiting_funds' | 'under_review' | 'requires_action' | 'payout_completed' | 'cancellation_requested' | 'cancelled' | 'failed' - `nextStatus` 'draft' | 'quote_expired' | 'awaiting_approval' | 'awaiting_funds' | 'under_review' | 'requires_action' | 'payout_completed' | 'cancellation_requested' | 'cancelled' | 'failed', required - `statusDetails` union - string - unknown - `fundingDeadline` union - string, date-time - unknown - `fundingDeadlineProvided` boolean - `senderAmount` union - string - unknown - `senderCurrency` union - string - unknown - `receivingAmount` union - string - unknown - `receivingCurrency` union - string - unknown - `fxInfo` union - object - … - unknown - `feeInfo` union - object - … - unknown - `rawProviderPayload` unknown - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_REAP_TRACKING_UPDATED', required - `timestamp` string, date-time, required - `payload` object, required - `reapPaymentId` string, required - `trackingInfo` unknown, required - `rawProviderPayload` unknown - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_REAP_BALANCE_MOVEMENT_RECORDED', required - `timestamp` string, date-time, required - `payload` object, required - `reapPaymentId` string, required - `balanceMovement` unknown, required - `rawProviderPayload` unknown - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_REAP_ATTEMPT_LINKED_TO_PAYMENT_TRANSACTION', required - `timestamp` string, date-time, required - `payload` object, required - `reapPaymentId` string, required - `paymentTransactionId` string, required - `principalPaymentTransactionLineNumber` integer - `processingFeePaymentTransactionLineNumber` integer - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_REAP_DOCUMENT_DELIVERY_REQUESTED', required - `timestamp` string, date-time, required - `payload` object, required - `reapPaymentId` string, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - object - `aggregateId` string, required - `version` integer, required - `type` 'PAYMENT_REQUEST_REAP_DOCUMENT_DELIVERY_RETRY_REQUESTED', required - `timestamp` string, date-time, required - `payload` object, required - `expectedAttemptCount` integer, required - `reapPaymentId` string, required - `requestedByUserId` string, required - `requestedAt` string, date-time, required - `metadata` object, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `userId` string - `source` 'USER' | 'SYSTEM' | 'PROJECTION' | 'SAGA' | 'EXTERNAL' - `userId` string - `user` object - `id` string, required - `name` string, nullable, required - `image` string, nullable, required - `status` 'current' | 'former', required - `before` object, nullable, required - `aggregateId` string, required - `version` number, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `requestNumber` string, required - `status` 'DRAFT' | 'SUBMITTED' | 'APPROVED' | 'REJECTED' | 'RETURNED' | 'CONVERTED' | 'CANCELLED', required - `toAddress` string, required - `counterpartyId` string - `token` object, required - `tokenAddress` string, required - `chainId` string, required - `decimals` integer, required - `assetId` string, required - `amount` string, required - `paymentMethodId` string - `fiatAmount` string - `fiatCurrency` string - `payoutCurrency` string - `purposeOfPayment` string - `sourceOfFunds` string - `ledgerAccountId` string - `responsibilityCenterAssignments` object[] - `responsibilityCenterTypeId` string, required - `responsibilityCenterId` string, required - `percentageBps` integer, required - `description` string, required - `fileAttachments` object[], required - `id` string, required - `fileName` string, required - `fileSize` integer, required - `mimeType` string, required - `uploadedByUserId` string, required - `uploadedAt` string, date-time, required - `requestedByUserId` string, required - `requestedAt` string, date-time, required - `submittedAt` string, date-time - `approvalGroups` object[], required - `groupId` string, required - `groupName` string, required - `approverUserIds` string[], required - `requiredCount` integer, required - `approvals` object[], required - `userId` string, required - `action` 'APPROVED' | 'REJECTED' | 'RETURNED', required - `comment` string - `actionAt` string, date-time, required - `convertedByUserId` string - `convertedAt` string, date-time - `currentPaymentTransactionId` string - `isDeleted` boolean, required - `after` object, nullable, required - `aggregateId` string, required - `version` number, required - `portfolioSlug` union, required - string: Public URL slug. - unknown - `requestNumber` string, required - `status` 'DRAFT' | 'SUBMITTED' | 'APPROVED' | 'REJECTED' | 'RETURNED' | 'CONVERTED' | 'CANCELLED', required - `toAddress` string, required - `counterpartyId` string - `token` object, required - `tokenAddress` string, required - `chainId` string, required - `decimals` integer, required - `assetId` string, required - `amount` string, required - `paymentMethodId` string - `fiatAmount` string - `fiatCurrency` string - `payoutCurrency` string - `purposeOfPayment` string - `sourceOfFunds` string - `ledgerAccountId` string - `responsibilityCenterAssignments` object[] - `responsibilityCenterTypeId` string, required - `responsibilityCenterId` string, required - `percentageBps` integer, required - `description` string, required - `fileAttachments` object[], required - `id` string, required - `fileName` string, required - `fileSize` integer, required - `mimeType` string, required - `uploadedByUserId` string, required - `uploadedAt` string, date-time, required - `requestedByUserId` string, required - `requestedAt` string, date-time, required - `submittedAt` string, date-time - `approvalGroups` object[], required - `groupId` string, required - `groupName` string, required - `approverUserIds` string[], required - `requiredCount` integer, required - `approvals` object[], required - `userId` string, required - `action` 'APPROVED' | 'REJECTED' | 'RETURNED', required - `comment` string - `actionAt` string, date-time, required - `convertedByUserId` string - `convertedAt` string, date-time - `currentPaymentTransactionId` string - `isDeleted` boolean, required - `warnings` string[], required - `error` string - `pagination` object - `requestedLimit` number - `hasMore` boolean, required - `minVersion` number - `maxVersion` number --- [API](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api.md) · [All operations](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/revisions/180622e6255e?raw)