Transactions API¶

Work with live transactions, manage participants, and handle financial operations.

Overview¶

Transactions API Features

Transaction Management: Get and update live transactions
Participant Management: Add and modify transaction participants
Financial Operations: Process payments and commission splits
Document Management: Generate reports and handle transaction documents
Agent Transactions: Retrieve agent-specific transaction lists
Termination: Request transaction termination

Quick Start¶

from rezen import RezenClient

client = RezenClient()

# Get transaction details
transaction = client.transactions.get_transaction("tx-12345")

# Get agent's current transactions
agent_transactions = client.transactions.get_agent_current_transactions("agent-uuid")

# Add participant to existing transaction
participant = {
    "type": "LENDER",
    "first_name": "Bank",
    "last_name": "Officer",
    "company": "First National Bank"
}
client.transactions.create_participant(transaction_id, participant)

Core Methods¶

Transaction Operations¶

Get a specific transaction by ID.

Parameters:

Name	Type	Description	Default
`transaction_id`	`str`	Transaction ID	required

Returns:

Type	Description
`Dict[str, Any]`	Transaction data

Agent Transaction Methods¶

Get agent's transactions (wrapper for get_participant_transactions).

Parameters:

Name	Type	Description	Default
`yenta_id`	`str`	Agent's user ID	required

Returns:

Type	Description
`Dict[str, Any]`	Agent's transactions data

Get agent's current transactions (wrapper for get_participant_current_transactions).

Parameters:

Name	Type	Description	Default
`yenta_id`	`str`	Agent's user ID	required

Returns:

Type	Description
`Dict[str, Any]`	Agent's current transactions data

Get agent's current listings.

Parameters:

Name	Type	Description	Default
`yenta_id`	`str`	Agent's user ID	required

Returns:

Type	Description
`Dict[str, Any]`	Agent's current listings data

Wrapper Methods

The agent transaction methods are convenience wrappers around the participant transaction methods for backward compatibility.

Transaction Termination¶

Request termination for a transaction.

Parameters:

Name	Type	Description	Default
`transaction_id`	`str`	Transaction ID	required

Returns:

Type	Description
`Dict[str, Any]`	Termination request response data

Participant Management¶

Create transaction participant.

Parameters:

Name	Type	Description	Default
`transaction_id`	`str`	Transaction ID	required
`participant_data`	`Dict[str, Any]`	Participant creation data	required

Returns:

Type	Description
`Dict[str, Any]`	Created participant data

Get transactions for participant.

Parameters:

Name	Type	Description	Default
`yenta_id`	`str`	Participant (user) ID	required

Returns:

Type	Description
`Dict[str, Any]`	Participant transactions data

Get participant's current transactions.

Parameters:

Name	Type	Description	Default
`yenta_id`	`str`	User/participant ID	required

Returns:

Type	Description
`Dict[str, Any]`	Current transactions data

Financial Operations¶

Get payment information for agent.

Parameters:

Name	Type	Description	Default
`transaction_id`	`str`	Transaction ID	required
`agent_id`	`str`	Agent ID	required

Returns:

Type	Description
`Dict[str, Any]`	Payment information data

Get money transfers for transaction.

Parameters:

Name	Type	Description	Default
`transaction_id`	`str`	Transaction ID	required

Returns:

Type	Description
`Dict[str, Any]`	Money transfers data

Document Operations¶

Get transaction summary PDF.

Parameters:

Name	Type	Description	Default
`transaction_id`	`str`	Transaction ID	required

Returns:

Type	Description
`Dict[str, Any]`	PDF download information

Usage Examples¶

Transaction Management

Get TransactionAgent TransactionsAdd ParticipantGet Payment InfoRequest Termination

transaction = client.transactions.get_transaction("tx-12345")
print(f"Status: {transaction['status']}")
print(f"Property: {transaction['property']['address']}")

# Get all agent transactions
all_transactions = client.transactions.get_agent_transactions("agent-uuid")

# Get current active transactions
current_transactions = client.transactions.get_agent_current_transactions("agent-uuid")

# Get current listings only
current_listings = client.transactions.get_agent_current_listings("agent-uuid")

for listing in current_listings:
    print(f"Listing: {listing['address']} - Status: {listing['status']}")

lender = {
    "type": "LENDER",
    "first_name": "Sarah",
    "last_name": "Banker",
    "company": "Community Bank",
    "email": "sarah@communitybank.com"
}

response = client.transactions.create_participant(
    transaction_id,
    lender
)

# Get payment information for an agent
payment_info = client.transactions.get_payment_info(
    transaction_id,
    agent_id
)

print(f"Payment amount: {payment_info['amount']}")
print(f"Payment status: {payment_info['status']}")

# Request to terminate a transaction
termination_response = client.transactions.request_termination("tx-12345")
print(f"Termination status: {termination_response['status']}")

Agent Transaction Retrieval¶

Transaction Filtering

The library provides several methods to retrieve agent-specific transactions:

All Transactions: Get complete transaction history
Current Transactions: Get only active/current transactions
Current Listings: Get only listing-type transactions that are current

Agent Transaction Examples

from rezen import RezenClient

client = RezenClient()
agent_id = "agent-uuid-here"

# Get all transactions for an agent
all_transactions = client.transactions.get_agent_transactions(agent_id)
print(f"Total transactions: {len(all_transactions)}")

# Get only current/active transactions
current = client.transactions.get_agent_current_transactions(agent_id)
print(f"Active transactions: {len(current)}")

# Get only current listings
listings = client.transactions.get_agent_current_listings(agent_id)
for listing in listings:
    print(f"Property: {listing['property']['address']}")
    print(f"List price: ${listing['listPrice']:,}")

Document Management¶

Document Types

Available document operations include:

Summary PDFs: Generate transaction summary reports
Document Lists: Get all transaction-related documents
Status Reports: Track transaction progress

Document Operations

# Generate summary PDF
pdf_data = client.transactions.get_transaction_summary_pdf(transaction_id)

# Get money transfers
transfers = client.transactions.get_money_transfers(transaction_id)
for transfer in transfers:
    print(f"Transfer: {transfer['amount']} - Status: {transfer['status']}")

Next Steps¶

:material-hammer-wrench: Transaction Builder

Create new transactions from scratch
:material-account-tie: Agents API

Find agents to add to transactions
:material-file-document-check: Checklist API

Manage transaction checklists and documents
:material-alert-circle: Exceptions

Handle transaction-related errors