--- updatedAt: 2026-04-21T11:22:20.000Z agentTools: projectIndex: https://docs.lmnl.app/v2/llms.txt --- # Retrieve a list of Travel Rule transactions This API is a request to retrieve a list of Travel Rule transactions along with the details. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "API REFERENCES", "contact": {}, "version": "8" }, "servers": [ { "url": "https://api-sdk.lmnl.dev", "variables": {} } ], "tags": [ { "name": "Travel Rule transactions" } ], "paths": { "/api/travel-rule/get-transaction": { "post": { "tags": [ "Travel Rule transactions" ], "summary": "Retrieve a list of Travel Rule transactions", "description": "This API is a request to retrieve a list of Travel Rule transactions along with the details.", "operationId": "GetTravelRuleTransactionData", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Get-Travel-Rule-Transaction-Data-Object-Request" }, { "example": { "travelRule": { "getTravelRuleTransactionRequest": { "group": "inbox", "direction": "outgoing", "limit": 2, "page": 0 } } } } ] }, "example": { "travelRule": { "getTravelRuleTransactionRequest": { "group": "inbox", "direction": "outgoing", "limit": 2, "page": 0 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetTravelRuleTransactionListResponse" } ], "example": { "success": true, "data": { "paginateInfo": { "totalItems": 20, "itemCount": 10, "itemsPerPage": 10, "totalPages": 2, "currentPage": 1 }, "transactions": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "status": "COMPLETED", "transactionType": "TRANSFER", "transactionAsset": "BTC", "transactionAmount": 0.005, "chargedQuantity": 0.0048, "amountInLocalCurrency": 125, "beneficiaryAmountInLocalCurrency": { "currency": "USD", "amountInLocalCurrency": 125 }, "originatorDid": "did:ethr:0x95e3901e7e0a91ba7e48abf82a619b4a3261aa37", "beneficiaryDid": "did:ethr:0xfba0bf06d7cda3aa31848f1b3ecdfe51fe5a6207", "isTest": true, "originatorVASPdid": "did:ethr:0x1d4eb41bf400506fc5b77defd5ea9171652b3464", "beneficiaryVASPdid": "did:ethr:0xfba0bf06d7cda3aa31848f1b3ecdfe51fe5a6207", "transactionBlockchainInfo": { "origin": 1.2339794881958946e+48, "txHash": "0xExampleTransactionHash", "destination": 6.275613666921069e+47 }, "ivms101": null, "ivms101Encrypted": null, "protocol": "TRLight", "protocolData": null, "originatorProof": null, "beneficiaryProof": null, "actions": [], "createdAt": "2023-08-14T05:43:11.618Z", "createdBy": "did:ethr:0x1d4eb41bf400506fc5b77defd5ea9171652b3464", "updatedAt": "2023-08-14T05:43:11.618Z", "updatedBy": "did:ethr:0x1d4eb41bf400506fc5b77defd5ea9171652b3464", "pii": null, "pii_url": "https://pii.notabene.dev/", "tracked_billing": true, "custom_asset_price": null, "on_behalf_of_myself": false, "blockchainTransactionTimestamp": "2024-01-01T12:00:00.000Z", "beneficiaryRef": null, "transactionAssetDecimals": 18 } ] } } } } } }, "401": { "description": "Access denied", "content": { "application/json": { "schema": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "This indicates whether the list of Travel Rule transactions is successfully retrieved or not.", "example": false }, "data": { "type": "object", "example": {} }, "message": { "type": "string", "description": "A short description of the error.", "example": "access_denied" }, "code": { "type": "string", "description": "The error code for the API failure.", "example": "" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "This indicates whether the list of Travel Rule transactions is successfully retrieved or not.", "example": false }, "data": { "type": "object", "example": {} }, "message": { "type": "string", "description": "A short description of the error.", "example": "fail to fetch travel rule txn" }, "code": { "type": "string", "description": "The error code for the API failure.", "example": "" } } } } } } }, "deprecated": false, "security": [ { "basic": [] } ] } } }, "components": { "schemas": { "GetTravelRuleTransactionRequest-Object-Request": { "title": "GetTravelRuleTransactionRequest-Object-Request", "type": "object", "properties": { "group": { "allOf": [ { "$ref": "#/components/schemas/Group-Enum" }, {} ] }, "direction": { "allOf": [ { "$ref": "#/components/schemas/Direction-Enum" }, {} ] }, "limit": { "type": "integer", "description": "Enter the number of the records to retrieve per page.", "format": "int32" }, "page": { "type": "integer", "description": "Enter the page number of the records.", "format": "int32" } } }, "GetTravelRuleTransactionListResponse": { "title": "GetTravelRuleTransactionListResponse", "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "description": "This indicates whether the list of Travel Rule transactions is successfully retrieved or not.", "example": true }, "data": { "type": "object", "description": "This contains the pagination details and the list of transactions.", "properties": { "paginateInfo": { "type": "object", "description": "This object contains pagination details for the list of transactions.", "properties": { "totalItems": { "type": "integer", "description": "The total number of items available", "example": 20 }, "itemCount": { "type": "integer", "description": "The number of items returned in the current page.", "example": 10 }, "itemsPerPage": { "type": "integer", "description": "The number of items per page.", "example": 10 }, "totalPages": { "type": "integer", "description": "Te total number of pages available.", "example": 2 }, "currentPage": { "type": "integer", "description": "The current page number.", "example": 1 } } }, "transactions": { "type": "array", "description": "The list of transaction records.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The uniqiue identifier (ID) of the transaction.", "example": "abf27e45-5ffd-4355-87c7-b1687efa2195" }, "status": { "type": "string", "description": "The current status of the transaction.", "example": "INCOMPLETE" }, "transactionType": { "type": "string", "description": "The type of transaction.", "example": "UNKNOWN" }, "transactionAsset": { "type": "string", "description": "The type of asset involved in the transaction.", "example": "ETH" }, "transactionAmount": { "type": "string", "description": "The amount of asset in the transaction.", "example": 0.005 }, "chargedQuantity": { "type": "number", "format": "float", "description": "The quantity charged for the transaction.", "example": 0.0048 }, "amountInLocalCurrency": { "type": "number", "format": "float", "description": "The amount in the local currency.", "nullable": true, "example": 125 }, "beneficiaryAmountInLocalCurrency": { "type": "object", "description": "The local currency and amount of the beneficiary.", "properties": { "currency": { "type": "string", "description": "The currency code.", "example": "SGD" }, "amountInLocalCurrency": { "type": "number", "description": "The amount in the local currency.", "example": 2.49122 } } }, "originatorDid": { "type": "string", "description": "The unique dentifier (ID) of the transaction originator.", "nullable": true, "example": "did:ethr:0x95e3901e7e0a91ba7e48abf82a619b4a3261aa37" }, "beneficiaryDid": { "type": "string", "description": "The identifier of the transaction beneficiary.", "example": "did:ethr:0xfba0bf06d7cda3aa31848f1b3ecdfe51fe5a6207" }, "isTest": { "type": "boolean", "description": "This indicates whether the transaction is a test transaction or not. A `null` value indicates that it is not a test transaction.", "nullable": true, "example": null }, "originatorVASPdid": { "type": "string", "description": "The unique identifier (ID) of the originator's VASP.", "nullable": true, "example": "did:ethr:0x1d4eb41bf400506fc5b77defd5ea9171652b3464" }, "beneficiaryVASPdid": { "type": "string", "description": "The unique identifier (ID) of the beneficiary's VASP.", "example": "did:ethr:0xfba0bf06d7cda3aa31848f1b3ecdfe51fe5a6207" }, "transactionBlockchainInfo": { "type": "object", "description": "Blockchain details of the transaction", "properties": { "origin": { "type": "string", "description": "The source blockchain address from where the transaction is initiated.", "example": 1.2339794881958946e+48 }, "txHash": { "type": "string", "description": "A unique identifier (ID) of the transaction, used to view its details and verify it on blockchain explorers.", "example": 4.1754578810420335e+76 }, "destination": { "type": "string", "description": "The destination blockchain address where the transaction is received.", "example": 6.275613666921069e+47 } } }, "ivms101": { "type": "object", "description": "InterVASP Messaging Standard 101 (IVMS 101) is a data standard for VASPs to securely exchange sender and receiver information during the Travel Rule transactions.", "nullable": true }, "ivms101Encrypted": { "type": "object", "description": "The IVMS101 information in the encrypted format.", "nullable": true }, "protocol": { "type": "string", "description": "The protocol used in the transaction.", "example": "TRLight" }, "protocolData": { "type": "object", "description": "The additional data related to the protocol", "nullable": true, "example": null }, "originatorProof": { "type": "object", "description": "The identity proof provided by the originator, if applicable.", "nullable": true, "example": null }, "beneficiaryProof": { "type": "object", "description": "The identity proof provided by the originator, if applicable.", "nullable": true, "example": null }, "actions": { "type": "object", "description": "The array of actions associated with the transaction, including details like action type, issuer, and hash." }, "createdAt": { "type": "string", "format": "date-time", "description": "The timestamp when the transaction was created.", "example": "2023-08-14T05:43:11.618Z" }, "createdBy": { "type": "string", "description": "The unique identifier of the entity that created the transaction.", "example": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59" }, "updatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the transaction was last updated.", "example": "2023-08-14T05:43:07.699Z" }, "updatedBy": { "type": "string", "description": "The unique identifier of the entity that last updated the transaction.", "example": "did:ethr:0xd3e3830e65d2f8c1bfa4ae9a0d03b112b15444a9" }, "pii": { "type": "string", "description": "The personally identifiable information (PII), if available.", "nullable": true, "example": null }, "pii_url": { "type": "string", "description": "The URL where PII is stored or accessed.", "nullable": true }, "tracked_billing": { "type": "boolean", "description": "This indicates whether the transaction is tracked for billing purposes or not.", "example": true }, "custom_asset_price": { "type": "number", "format": "float", "description": "The custom asset price, if applicable.", "nullable": true }, "on_behalf_of_myself": { "type": "boolean", "description": "The originator and beneficiary fields with institution's information.", "example": false }, "blockchainTransactionTimestamp": { "type": "string", "format": "date-time", "description": "The timestamp of the transaction on the blockchain.", "nullable": true, "example": "2024-01-01T12:00:00.000Z" }, "beneficiaryRef": { "type": "string", "description": "The reference identifier for the beneficiary.", "nullable": true, "example": null }, "transactionAssetDecimals": { "type": "integer", "description": "The number of decimal places used for the asset (e.g., 18 for ETH).", "example": 18 } } } } } } } }, "Get-Travel-Rule-Transaction-Data-Object-Request": { "title": "Get-Travel-Rule-Transaction-Data-Object-Request", "required": [ "travelRule" ], "type": "object", "properties": { "travelRule": { "allOf": [ { "$ref": "#/components/schemas/TravelRule-GetTravelRuleTransaction-Object-Request" }, {} ] } } }, "TravelRule-GetTravelRuleTransaction-Object-Request": { "title": "TravelRule-GetTravelRuleTransaction-Object-Request", "required": [ "getTravelRuleTransactionRequest" ], "type": "object", "properties": { "getTravelRuleTransactionRequest": { "allOf": [ { "$ref": "#/components/schemas/GetTravelRuleTransactionRequest-Object-Request" }, {} ] } } }, "Group-Enum": { "title": "Group-Enum", "enum": [ "inbox", "outbox" ], "type": "string", "description": "The group of transactions." }, "Direction-Enum": { "title": "Direction-Enum", "enum": [ "outgoing", "incoming" ], "type": "string", "description": "The type of transactions." } }, "securitySchemes": { "basic": { "type": "http", "scheme": "basic" } } }, "security": [] } ```