Ospree docs
API ReferenceWebsiteSocials
  • GETTING STARTED
    • Intro to Ospree
      • What is the Travel Rule?
      • Types of Travel Rule transfers
      • What is a wallet address?
      • What is an Account at Ospree?
      • What is a VASP or CASP?
    • Account
      • Understand user roles
      • Add and manage users
      • Change your password
      • Set up two-factor authentication (2FA)
      • Log in with 2FA-enabled
  • DASHBOARD
    • Overview
    • Travel Rule
      • Start a transfer
      • Search and filter transfers
      • Interoperability
      • Self-hosted wallets
    • Accounts Directory
      • Create an account
      • Edit an account
      • Create a recipient
      • Edit a recipient
      • Add a new wallet
      • VASPs
        • Search and filter
        • Request a VASP
  • OSPREE API
    • Overview
    • API integration flows
    • Authentication
    • Breaking Changes
    • Errors
    • Token Identifier
    • Webhooks
      • Webhook events
      • Webhook request
      • Webhook management
    • Travel Rule
      • Create Transfer
      • List Transfers
      • Retrieve Transfer
      • Update Transfer
      • Action Transfer
    • Accounts Directory
      • Create Account
      • List Accounts
      • Retrieve Account
      • Update Account
      • Remove account
      • Search account
      • Retrieve VASP
      • Search VASP
      • List VASPs
    • Blockchain Analytics
      • Create Address
      • List Addresses
      • Retrieve Address
      • Assign an address to account
      • Create Transaction (Beta)
      • List Transactions (Beta)
      • Retrieve Transaction (Beta)
  • Resources and Help
    • Data pre-validation
    • Sunrise Issue
Powered by GitBook
On this page
  1. OSPREE API
  2. Travel Rule

List Transfers

GET /api/v2/travelrule/transfers

The endpoint provides a comprehensive overview of all initiated transfers between entities within the system. Query Parameters

Name
Type
Description
Required

page

integer

The current page number in pagination.

Minimum: 1

Default: 1

false

size

integer

The size or number of records per page.

Minimum: 1

Default: 50

false

sort

string

Criteria for result sorting.

Examples:

  • -amount

  • amount

false

dti

string

Unique identifier for the assets based on DTIF standards.

false

beneficiary_vasp_id

string

ID of the receiving Virtual Asset Service Provider (VASP).

Example: ABCXYZ

false

originator_address

string

Blockchain address of the sender.

Example: 12higDjoCCNXSA95xZMWUdPvXNmkAduhWv

false

beneficiary_address

string

Blockchain address of the recipient.

Example: bc1qas2rvpejpvncd6z5hcscvw52n4wxw5th2de67v

false

originator_account_reference_id

string

Sender's account ID within the originator VASP.

Example: account5678

false

beneficiary_account_reference_id

string

Recipient's account ID within the originator VASP.

Example: account1234

false

direction

string

Identifier indicating the direction of the transfer.

Accepted values:

  • incoming

  • outgoing

false

transfer_status

string

Identifier indicating the current status of the transfer.

Accepted values:

  • initiated

  • canceled

  • review

  • accepted

  • rejected

  • repair

  • completed

false

beneficiary_account_type

string

Type of the recipient's account.

Accepted values:

  • entity

  • individual

false

transaction_hash

string

The unique hash of the crypto transaction.

false

start_date

string

The minimum date the transfer was initiated. Example: 2025-01-01

false

end_date

string

The maximum date the transfer was initiated. Example: 2025-04-30

false

Response

{
  "status": "success",
  "data": {
    "items": [
      {
        "transfer_id": "018f7212-18be-7713-ad7c-89704e18bd5c",
        "reference_id": "reference-transfer-01",
        "amount": 1,
        "amount_usd": 101234.00,
        "dti": "4H95J0R2X",
        "chain": "bitcoin",
        "symbol": "BTC",
        "protocol": "flow",
        "originator_vasp_id": "ZSHTUF",
        "beneficiary_vasp_id": "ABCXYZ",
        "originator_address": "12higDjoCCNXSA95xZMWUdPvXNmkAduhWv",
        "beneficiary_address": "bc1qas2rvpejpvncd6z5hcscvw52n4wxw5th2de67v",
        "originator_account_reference_id": "account5678",
        "beneficiary_account_reference_id": "account1234",
        "direction": "Outgoing",
        "transaction_hash": "80003fee6bcbb2726b4d6466d690fce6caaa03771aada747eb0651637514b893",
        "transfer_status": "REVIEW"
      }
    ],
    "total": 1,
    "page": 1,
    "size": 50
  }
}

Last updated 23 days ago

Example: 4H95J0R2X(see )

https://dtif.org