diff --git a/snippets/reports-resource-transfer-type.mdx b/snippets/reports-resource-transfer-type.mdx index 13f7f973..7fea055b 100644 --- a/snippets/reports-resource-transfer-type.mdx +++ b/snippets/reports-resource-transfer-type.mdx @@ -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. | \ No newline at end of file +| 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. | \ No newline at end of file diff --git a/snippets/reports-resources.mdx b/snippets/reports-resources.mdx index 8c523cb0..3178a2f3 100644 --- a/snippets/reports-resources.mdx +++ b/snippets/reports-resources.mdx @@ -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. | \ No newline at end of file +| 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. | \ No newline at end of file diff --git a/snippets/reports-transaction-type.mdx b/snippets/reports-transaction-type.mdx index 96b6d4cf..3d3c6069 100644 --- a/snippets/reports-transaction-type.mdx +++ b/snippets/reports-transaction-type.mdx @@ -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. | \ No newline at end of file