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

Retrieve Transfer

GET /api/v2/travelrule/transfers/{transfer_id}

This endpoint enables users to access comprehensive information regarding specific travel rule transfers within the system. It offers detailed insights into the transfer process, encompassing originator and beneficiary details, transaction amount, timestamps, and status. Path Parameters

Name
Type
Description
Required

transfer_id

string

The ID of the transfer. Example: 0663cc41-ef29-7995-8000-2d9b414b3174

True

Response

{
  "status": "success",
  "data": {
    "transfer_data": {
      "transfer_id": "018f85d7-0650-7205-a1d5-011e9587c07c",
      "reference_id": "reference-transfer-01",
      "amount": 1,
      "amount_usd": 101234.00,
      "dti": "4H95J0R2X",
      "chain": "bitcoin",
      "symbol": "BTC",
      "protocol": "flow",
      "originator_address": "14qViLJfdGaP4EeHnDyJbEGQysnCpwk3gd",
      "beneficiary_address": "1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX",
      "transaction_hash": "80003fee6bcbb2726b4d6466d690fce6caaa03771aada747eb0651637514b893",
      "transfer_status": "REVIEW",
      "created": "2024-12-31T12:40:01.138096+00:00",
      "created_by_desc": "John Robert Maxwells"
    },
    "originator_record": {
      "display_name": "John Sean Smith",
      "reference_id": "234234",
      "customer_id": "customer-1234",
      "account_no": 234234,
      "name_first": "John ",
      "name_middle": "Sean",
      "name_last": "Smith",
      "name_local_first": null,
      "name_local_middle": null,
      "name_local_last": null,
      "date_of_birth": "1988-06-27",
      "place_of_birth": "Singapore",
      "nationality_code": "SG",
      "residence_country_code": "SG",
      "name_legal": null,
      "name_business": null,
      "name_local_legal": null,
      "name_local_business": null,
      "registration_country_code": null,
      "address_line": "75 High Street",
      "address_street_no": "75",
      "address_street_name": "High Street ",
      "address_building_name": null,
      "address_floor": null,
      "address_room": null,
      "address_department": null,
      "address_subdepartment": null,
      "address_postbox": null,
      "address_city": "Singapore ",
      "address_city_location": "Singapore",
      "address_region": "Singapore",
      "address_district": null,
      "address_postcode": "179435 ",
      "address_country_code": null,
      "email": "john@example.com",
      "national_id": "AAE4123",
      "national_id_issue_country": "SG"
    },
    "beneficiary_record": {
      "display_name": "Crypto Legal",
      "reference_id": "1234123",
      "customer_id": "non-customer-4321",
      "account_no": null,
      "name_first": null,
      "name_middle": null,
      "name_last": null,
      "name_local_first": null,
      "name_local_middle": null,
      "name_local_last": null,
      "date_of_birth": null,
      "place_of_birth": null,
      "nationality_code": "SG",
      "residence_country_code": "SG",
      "name_legal": "Crypto Legal",
      "name_business": "Crypto Legal",
      "name_local_legal": null,
      "name_local_business": null,
      "registration_country_code": "SG",
      "address_line": "111 North Bridge Road, #08-18 Peninsula Plaza",
      "address_street_no": "3124123",
      "address_street_name": "Peninsula Plaza ",
      "address_building_name": null,
      "address_floor": null,
      "address_room": null,
      "address_department": null,
      "address_subdepartment": null,
      "address_postbox": null,
      "address_city": null,
      "address_city_location": null,
      "address_region": null,
      "address_district": null,
      "address_postcode": "179098 ",
      "address_country_code": "SG",
      "email": "crypto@legal.com",
      "national_id": "ABXYAZ,
      "national_id_issue_country": "SG
    },
    "originator_vasp": {
      "vasp_id": "ABCXYZ",
      "name_legal": "Kraken",
      "name_business": "Kraken",
      "name_local_legal": null,
      "name_local_business": null,
      "registration_country_code": "US",
      "address_type_code": null,
      "address_line": "1009 N 1300th W",
      "address_street_no": null,
      "address_street_name": "1009 N 1300th W",
      "address_building_name": null,
      "address_floor": null,
      "address_room": null,
      "address_department": null,
      "address_subdepartment": null,
      "address_postbox": null,
      "address_city": "Pleasant Grove",
      "address_city_location": null,
      "address_region": "Utah",
      "address_district": null,
      "address_postcode": "84062",
      "address_country_code": "US",
      "address_country_desc": "United States",
      "email": "dummy@kraken.com",
      "website": "https://www.kraken.com/",
      "national_id": "ABCXYZXX",
      "national_id_issue_country": "US"
    },
    "beneficiary_vasp": {
      "vasp_id": "XYZABC",
      "name_legal": "Amber Group",
      "name_business": "Amber Group",
      "name_local_legal": null,
      "name_local_business": null,
      "registration_country_code": null,
      "address_type_code": null,
      "address_line": null,
      "address_street_no": null,
      "address_street_name": null,
      "address_building_name": null,
      "address_floor": null,
      "address_room": null,
      "address_department": null,
      "address_subdepartment": null,
      "address_postbox": null,
      "address_city": null,
      "address_city_location": null,
      "address_region": null,
      "address_district": null,
      "address_postcode": null,
      "address_country_code": "HK",
      "address_country_desc": "Hong Kong",
      "email": "dummy@ambergroup.io",
      "website": "www.ambergroup.io",
      "national_id": "XXABZXYE",
      "national_id_issue_country": "HK"
    }
  }
}

Last updated 23 days ago