Reconciliation Reporting Data Dictionary

Data dictionary for Reconciliation Reporting. Sample report files are available here.  

Take into account the new fields can be added to the existing reports.

Content:

Report Fields

The following tables indicate which fields (columns) are provided in each report.

Field

Data Type

Example values

ProfileID

UUID

7927d51a-a465-49b9-ab0e-1ca17b3a7c5b

Timestamp

Datetime

2020-01-17T00:00:00.000Z

BalanceType

Enum

Balance Type Values & Definitions

Asset

String

USD, BTC, ETH, BCH, LTC, PAXG

Balance

String

9977417.21588054 (38 decimals of precision for fiat, at least 72 for crypto)

Profile Balances Report Fields

The following fields are provided on each row of the Profile Balances Report.

 

Field

Data Type

Example values / notes

Always returns data?

UniqueTxID

String

A unique identifier for the profile transaction for use for uniqueness of a row

Y

Timestamp

Datetime

2020-01-17T18:36:31.345Z - the timestamp of the record

Y

ProfileID

UUID

7927d51a-a465-49b9-ab0e-1ca17b3a7c5b

Y

AccountID

UUID

1ab15e4f-6389-4a52-b908-62c3525b0da2

N

IdentityID

UUID

1ab15e4f-6389-4a52-b908-62c3525b0da2

N

Amount

String

90.12345678
The precision depends on transaction type:
for Orders and Executions it is 10 decimals for fiat; 8 decimals for crypto;
For Transfers it is at least 72 decimal places. 

Y

Asset

String

USD, ETH, BTC, PAXG, BCH, LTC

Y

Direction

String

CREDIT, DEBIT

Y

ResourceRefID

String

custom string specified in CreateOrder request as "ref_id"

N

Side

String

SELL, BUY

N

OrderType

String

LIMIT, MARKET, STOPLIMIT, HRQ

N

Market

String

ETHUSD, XBTUSD, PAXGUSD, BCHUSD, LTCUSD

N

Price

String

100.23

N

BalanceType

Enum

Balance Type Values & Definitions

Y

Resource

Enum

Resource Values & Definitions

Y

ResourceID

UUID

273dfece-3e8e-4148-a38b-afa770088ab7

ID of the Resource in question (Order ID, Execution ID, Transfer ID, etc)

Y

TransactionType

Enum

Transaction Type Values & Definitions

Y

ResourceTimestamp

Datetime

2020-01-17T18:36:31.345Z - 

The timestamp when the Resource was generated (i.e. the time for an Order or an Execution).

N

RecourceTransferType  

Enum

Resource Transfer Type Values & Definitions

N

ExternalID

String

f4184fc596403b9d638783cf57adfe4c75c605f6356fbc91338530e9831e9e16

Contains the transaction hash if it’s a Crypto Deposit. If there’s no data available, it will be returned empty.

N

Metadata

String

"{""key_1"":""value_11"",""key_2"":""value_23"" }"

Contains the customer specified metadata during a transaction on platform (ie. withdrawal, transfer,quote execution) in json-string format. If there's no data available, it will be returned empty.

N

Fee

String

0.017

The fee for this interaction. Currently only supported for Transfers.

N

QuoteAmount

String

10.50

The amount in the quote asset for this trade, currently only supported for QuoteExecutions

N

BaseAmount

String

10.017

The amount in the base asset for this trade, currently only supported for QuoteExecutions

N

Profile Transactions Report Fields

The following fields are provided on each row of the Profile Transactions Report.

 

Enumerated Field Definitions

Balance Type

Definition

AVAILABLE

Balance that is currently available to trade or transfer

TRADING

Balance that is currently reserved for trading (i.e. because a limit order has been placed but not filled)

PENDING_DEBIT

Balance that is currently reserved for pending debits   (i.e. because an outgoing transfer has been requested but not completed)

PENDING_CREDIT

Balance that is currently reserved for pending credits (i.e. because an incoming transfer has been requested but not completed)

BalanceType Values & Definitions

The Balance Type field indicates which specific balance the row is referring to. It allows you to precisely follow movement of funds as transactions complete in the Profile Transaction Report, and identify the volume of funds held in reserve or in pending transactions at the end of each day in the Profile Balances Report.

 

Resource

Definition

ORDER

An order placed for trading (i.e. market order, limit order) using either FIX or the v2 Order service.

EXECUTION

An execution of an order on the order book. There can be multiple executions for one order.

TRANSFER

A transfer on or off the Paxos platform (i.e. wire withdrawal, crypto deposit)

QUOTE_EXECUTION

A Held Rate Quote transaction.

Resource Values & Definitions

The Resource field denotes the category of transaction being recorded on each row of the Profile Transaction Report. 

 

Resource

Transaction Type

Definition

ORDER

RESERVE

A transaction to reserve funds for trading (i.e. because a limit order has been placed)

ORDER

UNRESERVE

A transaction to unreserve funds for trading (i.e. because a limit order has been canceled)

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 (ie. because 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 (e.g.. a limit order used a BUY price of $50,000 but executed at $49,000).

EXECUTION

COMMISSION

A transaction to collect commission from an executed trade

TRANSFER

DEPOSIT_CREATION

A transaction to deposit funds into the Paxos platform

TRANSFER

DEPOSIT_COMPLETION

A transaction to complete a deposit, resulting in funds being credited

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_ENCUMBERMENT

A transaction to reserve the transfer fee

TRANSFER

FEE_DEBIT

A transaction to debit the fees upon completion of the transfer

TRANSFER

WITHDRAWAL_CREATION

A transaction to initiate a withdrawal (e.g. a wire withdrawal or crypto withdrawal), typically reserving the debit amount

TRANSFER

WITHDRAWAL_COMPLETION  

A transaction to complete a withdrawal, resulting in the transfer of funds off the Paxos platform

TRANSFER

WITHDRAWAL_FAILURE 

A transaction to return funds previously reserved for a failed withdrawal

TRANSFER

PAXOS_TRANSFER

A book transfer of funds to another Paxos customer

TRANSFER

INTERNAL_TRANSFER

A book transfer of funds to another profile under the same customer account

QUOTE_EXECUTION  

FUND_EXECUTOR

A record of transaction indicating a credit  of the account

QUOTE_EXECUTION

COLLECT_FROM_EXECUTOR

A record of transaction indicating a debit of the account

TransactionType Values & Definitions

The values of the Transaction Type vary depending on the Resource. The Transaction Type denotes the specific purpose of the transaction.

 

Resource  

Transfer Type

Definition

TRANSFER

SEN_WITHDRAWAL

A withdrawal out of Paxos on the Silvergate Exchange Network 

TRANSFER

WIRE_WITHDRAWAL

A wire withdrawal out of Paxos 

TRANSFER

SEN_DEPOSIT

A deposit into Paxos platform on the Silvergate Exchange Network

TRANSFER

WIRE_DEPOSIT

A wire deposit into Paxos 

TRANSFER

CRYPTO_WITHDRAWAL

A crypto withdrawal out of Paxos

TRANSFER

CRYPTO_DEPOSIT

A crypto deposit into Paxos

TRANSFER

SEND_PROFILE_TRANSFER

Transfer sent to another Profile (CreateProfileTransfer v1 API)

TRANSFER

RECV_PROFILE_TRANSFER

Transfer received from another Profile (CreateProfileTransfer v1 API)

TRANSFER

INTERNAL_TRANSFER_DEBIT

Transfer sent to another Profile

TRANSFER

INTERNAL_TRANSFER_CREDIT

Transfer received from another Profile

TRANSFER

RECV_PEER_TRANSFER

Transfer received from another peer (CreatePeerTransfer v1 API)

TRANSFER

SEND_PEER_TRANSFER

Transfer sent to another Peer (CreatePeerTransfer v1 API)

ResourceTransferType Values & Definitions

The Resource Transfer Type 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).

 

Was this article helpful?
0 out of 0 found this helpful