Skip to content

DOCS-1322 Adding details on Orchestration transactions to Reports docs #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pavloiusim wants to merge 5 commits into
base: main
Choose a base branch
from
Open

DOCS-1322 Adding details on Orchestration transactions to Reports docs #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a247ec7
DOCS-1322 Adding details on Orchestration transactions to Reports docs
pavloiusim Jan 8, 2026
faa690d
typo
pavloiusim Jan 8, 2026
03365d1
wording
pavloiusim Jan 8, 2026
10608f6
Update snippets/reports-transaction-type.mdx
pavloiusim Jan 8, 2026
93de056
Merge branch 'main' into DOCS-1322-add-ORCHESTRATION-to-Reports
pavloiusim Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions snippets/reports-resource-transfer-type.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
The ResourceTransferType identifies the direction of each transfer and whether it was a movement of fiat into or out of the Paxos Platform (WIRE\_, SEN\_), a movement of crypto asset into or out of Paxos (CRYPTO\_), or a movement of crypto or fiat between profiles within the Paxos platform (PROFILE_TRANSFER).

| Resource | TransferType | Description |
| --- | --- | --- |
| TRANSFER | CRYPTO_DEPOSIT | A crypto deposit into Paxos. |
| TRANSFER | CRYPTO_WITHDRAWAL | A crypto withdrawal out of Paxos. |
| TRANSFER | INTERNAL_TRANSFER_CREDIT | Transfer received from another Profile. |
| TRANSFER | INTERNAL_TRANSFER_DEBIT | Transfer sent to another Profile. |
| TRANSFER | PAXOS_TRANSFER_CREDIT | Transfer received from another Peer. |
| TRANSFER | PAXOS_TRANSFER_DEBIT | Transfer sent to another Peer. |
| TRANSFER | SEN_DEPOSIT | Deprecated. Does not appear in new reports. A deposit into Paxos platform on the Silvergate Exchange Network. |
| TRANSFER | SEN_WITHDRAWAL | Deprecated. Does not appear in new reports. A withdrawal out of Paxos on the Silvergate Exchange Network . |
| TRANSFER | WIRE_DEPOSIT | A wire deposit into Paxos. |
| TRANSFER | WIRE_WITHDRAWAL | A wire withdrawal out of Paxos. |
| Resource | TransferType | Description |
|----------|--------------------------|---------------------------------------------------------------------------------------------------------------|
| TRANSFER | CRYPTO_DEPOSIT | A crypto deposit into Paxos. |
| TRANSFER | CRYPTO_WITHDRAWAL | A crypto withdrawal out of Paxos. |
| TRANSFER | INTERNAL_TRANSFER_CREDIT | Transfer received from another Profile. |
| TRANSFER | INTERNAL_TRANSFER_DEBIT | Transfer sent to another Profile. |
| TRANSFER | PAXOS_TRANSFER_CREDIT | Transfer received from another Peer. |
| TRANSFER | PAXOS_TRANSFER_DEBIT | Transfer sent to another Peer. |
| TRANSFER | SEN_DEPOSIT | Deprecated. Does not appear in new reports. A deposit into Paxos platform on the Silvergate Exchange Network. |
| TRANSFER | SEN_WITHDRAWAL | Deprecated. Does not appear in new reports. A withdrawal out of Paxos on the Silvergate Exchange Network . |
| TRANSFER | WIRE_DEPOSIT | A wire deposit into Paxos. |
| TRANSFER | WIRE_WITHDRAWAL | A wire withdrawal out of Paxos. |
17 changes: 9 additions & 8 deletions snippets/reports-resources.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
The Resource field denotes the category of transaction being recorded on each row of the [Profile Transactions Report](#ProfileTransactionReport).

| Resource Enum Value | Description |
| --- | --- |
| CONVERSION | Stablecoin conversion transaction. |
| EXECUTION | An execution of an order on the order book. There can be multiple executions for one order. |
| ORDER | A market or limit order placed for trading. Using either FIX or the v2 Order service. |
| QUOTE_EXECUTION | A Held Rate Quote transaction. |
| TRANSFER | A transfer on or off the Paxos platform. For example, a wire withdrawal or crypto deposit. |
| WIRE_WITHDRAWAL_UPLOAD | A manually created wire withdrawal. |
| Resource Enum Value | Description |
|------------------------|---------------------------------------------------------------------------------------------|
| CONVERSION | Stablecoin conversion transaction. |
| EXECUTION | An execution of an order on the order book. There can be multiple executions for one order. |
| ORCHESTRATION | A multi-step workflow to move between assets, networks, and rails. |
| ORDER | A market or limit order placed for trading. Using either FIX or the v2 Order service. |
| QUOTE_EXECUTION | A Held Rate Quote transaction. |
| TRANSFER | A transfer on or off the Paxos platform. For example, a wire withdrawal or crypto deposit. |
| WIRE_WITHDRAWAL_UPLOAD | A manually created wire withdrawal. |
49 changes: 25 additions & 24 deletions snippets/reports-transaction-type.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
The values of the TransactionType vary depending on the Resource.
The TransactionType denotes the specific purpose of the transaction.

| Resource | TransactionType | Description |
| --- | --- | --- |
| CONVERSION | CONVERSION_CANCELLATION | A transaction to unreserve funds for a created stablecoin conversion. |
| CONVERSION | CONVERSION_CREATION | A transaction to reserve funds for a stablecoin conversion. |
| CONVERSION | CONVERSION_SETTLEMENT | Settlement of the stablecoin conversion transaction. |
| EXECUTION | COMMISSION | A transaction to collect commission from an executed trade. |
| EXECUTION | SETTLE_BASE | Settlement of the base (crypto) side of the trade to/from the counterparty. |
| EXECUTION | SETTLE_QUOTE | Settlement of the quote (cash) side of the trade to/from the counterparty For example, a SELL order has been executed. |
| EXECUTION | SETTLE_UNRESERVE | A transaction to unreserve funds for trading because of a BUY side price improvement on an executed order. For example, a limit order used a BUY price of $50,000 but executed at $49,000). |
| ORDER | RESERVE | A transaction to reserve funds for trading. For example, a limit order has been placed. |
| ORDER | UNRESERVE | A transaction to unreserve funds for trading. For example, a limit order has been canceled. |
| QUOTE_EXECUTION | COLLECT_FROM_EXECUTOR | A record of transaction indicating a credit of the account. |
| QUOTE_EXECUTION | FUND_EXECUTOR | A record of transaction indicating a debit of the account. |
| SWAP | SWAP_TX | A 1:1 conversion of a USD or a stablecoin from one type (in the DEBIT Direction) to another (in the CREDIT Direction) in the same account (no movement) |
| TRANSFER | DEPOSIT_COMPLETION | A transaction to complete a deposit, resulting in funds being credited. |
| TRANSFER | DEPOSIT_CREATION | A transaction to deposit funds into the Paxos platform. |
| TRANSFER | DEPOSIT_FAILURE | A transaction to reserve the funds of a failed deposit into pending debit where they can move off the Paxos platform back to their source. |
| TRANSFER | FEE_DEBIT | A transaction to debit the fees upon completion of the transfer. |
| TRANSFER | FEE_ENCUMBERMENT | A transaction to reserve the transfer fee. |
| TRANSFER | INTERNAL_TRANSFER | A book transfer of funds to another profile under the same customer account. |
| TRANSFER | PAXOS_TRANSFER | A book transfer of funds to another Paxos customer. |
| TRANSFER | WITHDRAWAL_COMPLETION | A transaction to complete a withdrawal, resulting in the transfer of funds off the Paxos platform. |
| TRANSFER | WITHDRAWAL_CREATION | A transaction to initiate a withdrawal typically reserving the debit amount. For example, a wire withdrawal or crypto withdrawal. |
| TRANSFER | WITHDRAWAL_FAILURE | A transaction to return funds previously reserved for a failed withdrawal. |
| Resource | TransactionType | Description |
|-----------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CONVERSION | CONVERSION_CANCELLATION | A transaction to unreserve funds for a created stablecoin conversion. |
| CONVERSION | CONVERSION_CREATION | A transaction to reserve funds for a stablecoin conversion. |
| CONVERSION | CONVERSION_SETTLEMENT | Settlement of the stablecoin conversion transaction. |
| EXECUTION | COMMISSION | A transaction to collect commission from an executed trade. |
| EXECUTION | SETTLE_BASE | Settlement of the base (crypto) side of the trade to/from the counterparty. |
| EXECUTION | SETTLE_QUOTE | Settlement of the quote (cash) side of the trade to/from the counterparty For example, a SELL order has been executed. |
| EXECUTION | SETTLE_UNRESERVE | A transaction to unreserve funds for trading because of a BUY side price improvement on an executed order. For example, a limit order used a BUY price of 90,000 but executed at 89,000). |
| ORCHESTRATION | ORCHESTRATION_RESERVE | A transaction to reserve funds for Orchestration processing. |
| ORCHESTRATION | ORCHESTRATION_UNRESERVE | A transaction to unreserve funds in case of Orchestration failure. |
| ORDER | RESERVE | A transaction to reserve funds for trading. For example, a limit order has been placed. |
| ORDER | UNRESERVE | A transaction to unreserve funds for trading. For example, a limit order has been canceled. |
| QUOTE_EXECUTION | COLLECT_FROM_EXECUTOR | A record of transaction indicating a credit of the account. |
| QUOTE_EXECUTION | FUND_EXECUTOR | A record of transaction indicating a debit of the account. |
| TRANSFER | DEPOSIT_COMPLETION | A transaction to complete a deposit, resulting in funds being credited. |
| TRANSFER | DEPOSIT_CREATION | A transaction to deposit funds into the Paxos platform. |
| TRANSFER | DEPOSIT_FAILURE | A transaction to reserve the funds of a failed deposit into pending debit where they can move off the Paxos platform back to their source. |
| TRANSFER | FEE_DEBIT | A transaction to debit the fees upon completion of the transfer. |
| TRANSFER | FEE_ENCUMBERMENT | A transaction to reserve the transfer fee. |
| TRANSFER | INTERNAL_TRANSFER | A book transfer of funds to another profile under the same customer account. |
| TRANSFER | PAXOS_TRANSFER | A book transfer of funds to another Paxos customer. |
| TRANSFER | WITHDRAWAL_COMPLETION | A transaction to complete a withdrawal, resulting in the transfer of funds off the Paxos platform. |
| TRANSFER | WITHDRAWAL_CREATION | A transaction to initiate a withdrawal typically reserving the debit amount. For example, a wire withdrawal or crypto withdrawal. |
| TRANSFER | WITHDRAWAL_FAILURE | A transaction to return funds previously reserved for a failed withdrawal. |
Loading