django-polaris
v2.3.4
Installation
Create a Django Project
Configure Settings
Set Environment Variables
Add Polaris Endpoints
Configure the Database
Run the Web Server
Publish a Stellar TOML File
Activate SEP-1
Specify File Content
Return Content in Code
Provide a Static File
Check Your Info File
Require Authentication
Configure Settings
Update the TOML File
Confirm the API is Live
Adding Client Attribution
Issuing Tokens for Other Domains
Enable Hosted Deposits & Withdrawals
Configure Settings
Activate SEP-24
Add Browser Session Support
Allow Custom Templates
Secure Session Cookies
Configure Static Assets
Create a Stellar Asset
Add an Asset to the Database
Issue the Asset on Stellar
Integrations
Communicating Fee Structure
Defining Django Forms
Processing Form Data
Register Integrations
Working with Templates
Extending or Replacing Polaris Templates
Using Custom Templates
Providing Context to Templates
Replacing Static Assets
Using an External Interactive Flow
Testing with the Demo Wallet
Connecting Off-Chain Payment Rails
Incoming Payments
Testing Incoming Payments
Outgoing Payments
Testing Outgoing Payments
Enable Deposts & Withdrawals via API
Configure Settings
Activate SEP-24
Create a Stellar Asset
Integrations
Defining Asset Info
Communicating Fee Structure
Accepting Transaction Requests
Deposit Transactions
Withdraw Transactions
Register Integrations
Testing with the Demo Wallet
Support KYC Registration
Configure Settings
Integrations
Defining Different Customer Types
Identifying Customers
Providing Customer Statuses
Validating Customer KYC
Deleting Customer Records
Sending Customer Status Callbacks
Register Integrations
Testing with the Demo Wallet
Enable Cross Border Payments
Configure Settings
Activate SEP-31
Create a Stellar Asset
Integrations
Defining Asset Info
Approving Sending Anchors
Accepting Transaction Requests
Updating Invalid Transaction Information
Register Integrations
Testing with the Demo Wallet
Provide Quotes for Exchanging Assets
Configure Settings
Activate SEP-31
Updating the Data Model
Integrations
Provide Estimated Exchange Rates
Provide Firm Quotes
Using Quotes with SEP-6
Using Quotes with SEP-24
Using Quotes with SEP-31
Charging Fees
Using a Custodial Service
API Reference
CLI Commands
process_pending_deposits
watch_transactions
execute_outgoing_transactions
poll_outgoing_transactions
testnet
Forms
Integrations
Fees
Customers
Deposits
Stellar Info File (TOML)
SEP-6 Info
Rails
Register Integrations
SEP-31 Transactions
Withdrawals
Quotes
Custody
Middleware
Miscellaneous
Models
Asset
Delivery Method
Exchange Pair
Off-Chain Asset
Transaction
Quote
Exceptions
Glossary
Environment Variables
Internationalization
Logging
Multisignature Assets
Background and Definitions
Multisignature Assets in Polaris
Channel Accounts
Rate Limiting
Shared Stellar Accounts
Muxed Accounts
SEP Support for Shared Accounts
SEP 10 Support
SEP 12 Support
SEP 6 & 24 Support
SEP 31 Support
django-polaris
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
V
|
W
A
account (polaris.sep10.token.SEP10Token property)
account_creation_supported (polaris.integrations.CustodyIntegration property)
account_memo (polaris.models.Quote attribute)
(polaris.models.Transaction attribute)
ACTIVE_SEPS
ADDITIVE_FEES_ENABLED
after_deposit() (polaris.integrations.DepositIntegration method)
after_form_validation() (polaris.integrations.DepositIntegration method)
(polaris.integrations.WithdrawalIntegration method)
after_interactive_flow() (polaris.integrations.DepositIntegration method)
(polaris.integrations.WithdrawalIntegration method)
amount_expected (polaris.models.Transaction attribute)
amount_fee (polaris.models.Transaction attribute)
amount_in (polaris.models.Transaction attribute)
amount_out (polaris.models.Transaction attribute)
Asset (class in polaris.models)
asset (polaris.models.Transaction attribute)
asset_identification_format (polaris.models.Asset property)
B
buy_amount (polaris.models.Quote attribute)
buy_asset (polaris.models.ExchangePair attribute)
(polaris.models.Quote attribute)
buy_delivery_method (polaris.models.Quote attribute)
C
calculate_fee() (in module polaris.integrations)
callback() (polaris.integrations.CustomerIntegration method)
CALLBACK_REQUEST_DOMAIN_DENYLIST
CALLBACK_REQUEST_TIMEOUT
channel_seed (polaris.models.Transaction attribute)
claimable_balance_id (polaris.models.Transaction attribute)
claimable_balance_supported (polaris.models.Transaction attribute)
claimable_balances_supported (polaris.integrations.CustodyIntegration property)
client_domain (polaris.models.Transaction attribute)
(polaris.sep10.token.SEP10Token property)
code (polaris.models.Asset attribute)
Command (class in polaris.management.commands.execute_outgoing_transactions)
(class in polaris.management.commands.poll_outgoing_transactions)
(class in polaris.management.commands.process_pending_deposits)
(class in polaris.management.commands.testnet)
(class in polaris.management.commands.watch_transactions)
completed_at (polaris.models.Transaction attribute)
content_for_template() (polaris.integrations.DepositIntegration method)
(polaris.integrations.WithdrawalIntegration method)
country_code (polaris.models.Quote attribute)
country_codes (polaris.models.OffChainAsset attribute)
create_channel_account() (polaris.integrations.DepositIntegration method)
create_destination_account() (polaris.integrations.CustodyIntegration method)
CustodyIntegration (class in polaris.integrations)
CustomerIntegration (class in polaris.integrations)
D
default_info_func() (in module polaris.integrations)
delete() (polaris.integrations.CustomerIntegration method)
delivery_methods (polaris.models.OffChainAsset attribute)
DeliveryMethod (class in polaris.models)
deposit_enabled (polaris.models.Asset attribute)
deposit_fee_fixed (polaris.models.Asset attribute)
deposit_fee_percent (polaris.models.Asset attribute)
deposit_max_amount (polaris.models.Asset attribute)
deposit_min_amount (polaris.models.Asset attribute)
DepositIntegration (class in polaris.integrations)
description (polaris.models.DeliveryMethod attribute)
distribution_account (polaris.models.Asset property)
distribution_seed (polaris.models.Asset attribute)
E
envelope_xdr (polaris.models.Transaction attribute)
ExchangePair (class in polaris.models)
expires_at (polaris.models.Quote attribute)
(polaris.sep10.token.SEP10Token property)
external_transaction_id (polaris.models.Transaction attribute)
F
fee_asset (polaris.models.Transaction attribute)
form_for_transaction() (polaris.integrations.DepositIntegration method)
(polaris.integrations.WithdrawalIntegration method)
from_address (polaris.models.Transaction attribute)
G
get() (polaris.integrations.CustomerIntegration method)
get_distribution_account() (polaris.integrations.CustodyIntegration method)
get_price() (polaris.integrations.QuoteIntegration method)
get_prices() (polaris.integrations.QuoteIntegration method)
get_receiving_account_and_memo() (polaris.integrations.CustodyIntegration method)
get_stellar_toml() (in module polaris.integrations)
H
HORIZON_URI
HOST_URL
I
id (polaris.models.Quote attribute)
(polaris.models.Transaction attribute)
identifier (polaris.models.OffChainAsset attribute)
info() (polaris.integrations.SEP31ReceiverIntegration method)
INTERACTIVE_JWT_EXPIRATION
interactive_url() (polaris.integrations.DepositIntegration method)
(polaris.integrations.WithdrawalIntegration method)
issued_at (polaris.sep10.token.SEP10Token property)
issuer (polaris.models.Asset attribute)
(polaris.sep10.token.SEP10Token property)
K
KIND (polaris.models.Transaction attribute)
kind (polaris.models.Transaction attribute)
L
LOCAL_MODE
M
MAX_TRANSACTION_FEE_STROOPS
memo (polaris.models.Transaction attribute)
(polaris.sep10.token.SEP10Token property)
memo_type (polaris.models.Transaction attribute)
MEMO_TYPES (polaris.models.Transaction attribute)
message (polaris.models.Transaction property)
module
polaris.exceptions
more_info_url (polaris.models.Transaction attribute)
more_info_url() (polaris.integrations.CustomerIntegration method)
muxed_account (polaris.models.Quote attribute)
(polaris.models.Transaction attribute)
(polaris.sep10.token.SEP10Token property)
N
name (polaris.models.DeliveryMethod attribute)
O
OffChainAsset (class in polaris.models)
on_change_callback (polaris.models.Transaction attribute)
P
paging_token (polaris.models.Transaction attribute)
patch_transaction() (polaris.integrations.DepositIntegration method)
(polaris.integrations.WithdrawalIntegration method)
payload (polaris.sep10.token.SEP10Token property)
pending_execution_attempt (polaris.models.Transaction attribute)
pending_signatures (polaris.models.Transaction attribute)
polaris.exceptions
module
post_quote() (polaris.integrations.QuoteIntegration method)
price (polaris.models.Quote attribute)
process_patch_request() (polaris.integrations.SEP31ReceiverIntegration method)
process_post_request() (polaris.integrations.SEP31ReceiverIntegration method)
process_sep6_request() (polaris.integrations.DepositIntegration method)
(polaris.integrations.WithdrawalIntegration method)
PROTOCOL (polaris.models.Transaction attribute)
protocol (polaris.models.Transaction attribute)
put() (polaris.integrations.CustomerIntegration method)
put_verification() (polaris.integrations.CustomerIntegration method)
Q
queue (polaris.models.Transaction attribute)
queued_at (polaris.models.Transaction attribute)
Quote (class in polaris.models)
QuoteIntegration (class in polaris.integrations)
R
RailsIntegration (class in polaris.integrations)
receiving_anchor_account (polaris.models.Transaction attribute)
refunded (polaris.models.Transaction attribute)
register_integrations() (in module polaris.integrations)
requested_expire_after (polaris.models.Quote attribute)
required_info_message (polaris.models.Transaction attribute)
required_info_updates (polaris.models.Transaction attribute)
S
save_sep9_fields() (polaris.integrations.DepositIntegration method)
(polaris.integrations.WithdrawalIntegration method)
scheme (polaris.models.OffChainAsset attribute)
sell_amount (polaris.models.Quote attribute)
sell_asset (polaris.models.ExchangePair attribute)
(polaris.models.Quote attribute)
sell_delivery_method (polaris.models.Quote attribute)
send_fee_fixed (polaris.models.Asset attribute)
send_fee_percent (polaris.models.Asset attribute)
send_max_amount (polaris.models.Asset attribute)
send_min_amount (polaris.models.Asset attribute)
SEP10_CLIENT_ATTRIBUTION_ALLOWLIST
SEP10_CLIENT_ATTRIBUTION_DENYLIST
SEP10_CLIENT_ATTRIBUTION_REQUEST_TIMEOUT
SEP10_CLIENT_ATTRIBUTION_REQUIRED
SEP10_HOME_DOMAINS
SEP10Token (class in polaris.sep10.token)
sep24_enabled (polaris.models.Asset attribute)
sep31_enabled (polaris.models.Asset attribute)
SEP31ReceiverIntegration (class in polaris.integrations)
sep38_enabled (polaris.models.Asset attribute)
sep6_enabled (polaris.models.Asset attribute)
SEP6_USE_MORE_INFO_URL
SERVER_JWT_KEY
significant_decimals (polaris.models.Asset attribute)
(polaris.models.OffChainAsset attribute)
SIGNING_SEED
started_at (polaris.models.Transaction attribute)
status (polaris.models.Transaction attribute)
status_eta (polaris.models.Transaction attribute)
status_message (polaris.models.Transaction attribute)
stellar_account (polaris.models.Quote attribute)
(polaris.models.Transaction attribute)
STELLAR_NETWORK_PASSHRASE
stellar_transaction_id (polaris.models.Transaction attribute)
SUBMISSION_STATUS (polaris.models.Transaction attribute)
submit_deposit_transaction() (polaris.integrations.CustodyIntegration method)
symbol (polaris.models.Asset attribute)
(polaris.models.OffChainAsset attribute)
T
TimezoneMiddleware (class in polaris.middleware)
to_address (polaris.models.Transaction attribute)
Transaction (class in polaris.models)
TransactionForm (class in polaris.integrations)
TransactionSubmissionBlocked
TransactionSubmissionError
TransactionSubmissionFailed
TransactionSubmissionPending
TYPE (polaris.models.DeliveryMethod attribute)
type (polaris.models.DeliveryMethod attribute)
TYPE (polaris.models.Quote attribute)
type (polaris.models.Quote attribute)
V
valid_sending_anchor() (polaris.integrations.SEP31ReceiverIntegration method)
W
withdrawal_enabled (polaris.models.Asset attribute)
withdrawal_fee_fixed (polaris.models.Asset attribute)
withdrawal_fee_percent (polaris.models.Asset attribute)
withdrawal_max_amount (polaris.models.Asset attribute)
withdrawal_min_amount (polaris.models.Asset attribute)
WithdrawalIntegration (class in polaris.integrations)
Read the Docs
v: v2.3.4
Versions
latest
stable
v2.3.4
v2.3.3
v2.3.2
v2.3.1
v2.3.0
v2.2.1
v2.2.0
v2.1.2
v2.1.0
v2.0.9
v2.0.7
v2.0.6
v2.0.5
v2.0.4
v2.0.3
v2.0.2
v2.0.1
v1.6.4
v1.6.3
v1.6.2
v1.6.1
v1.6.0
v1.5.2
v1.5.1
v1.5.0
v1.4.1
v1.4.0
v1.3.2
v1.3.1
v1.3.0
v1.2.2
v1.2.1
v1.2.0
v1.1.5
v1.1.4
v1.1.3
v1.1.2
v1.1.1
v1.1.0
v1.0.1
v1.0
v0.13.2
v0.13.1
v0.13.0
v0.13
v0.12.0
v0.11.3
v0.10.4
v0.10.3
v0.10.1
v0.10.0
v0.9.18
v0.9.16
v0.9.14
v0.9.13
v0.9.12
v0.9.11
v0.9.10
v0.9.9
v0.9.8
v0.9.7
Downloads
On Read the Docs
Project Home
Builds