- v2 API: Add new attribute
compatible_crypto_networks
to the Create Deposit Address and List Deposit Addresses API responses. This field contains the compatible networks with the created or already existing deposit address.
Changelog
Keep up to date with Paxos Platform changes.
We deploy new features, fix bugs, and update the documentation on a regular basis. Use this record to review recent and upcoming changes to the Paxos Platform, including breaking changes.
✉️ Question? Contact us: Crypto Brokerage | Commodities Settlement | Help Desk
Upcoming Changes
- v1 API, v2 API Add optional field
secondary_activity_status
parameter to List Transfers, Get Transfer, Get Activities, and Get Activity API endpoints. This field is used to support new transfer processes and features. The changes are planned to be rolled out no earlier than May 8, 2024.
Breaking Changes
- Funding: Paxos is upgrading its wallet infrastructure, impacting customers' crypto deposit addresses for BTC, ETH, BCH, LTC and all ERC20 tokens. This planned change is part of our commitment to continuous product and security improvements. Users will be required to retrieve the new crypto deposit address via the UI or
CreateDepositAddress
API no earlier than February 15, 2024, and no later than June 13, 2024. Old deposit addresses will come with a deprecated warning until June 13, 2024. After this date they will no longer be supported. - FIX: In the upcoming weeks, Paxos plans to begin updating the FIX infrastructure to improve performance, reliability and security for FIX connections. This change enables multiple FIX connections for a single account and improves TLS certificate management, among other changes. All existing FIX users are required to migrate to the new infrastructure no later than May 4, 2024. See the migration guide or contact your Paxos Representative for details.
March 3, 2024
- v2 API: Add Insufficient Funds 403 error response to Create Fiat Withdrawal endpoint.
February 16, 2024
- Docs, v2 API: Add Fiat Transfers integration guide to Paxos Documentation and update reference docs.
January 26, 2024
- v2 API: Add new Fiat Transfer APIs which allow for automatic funding and withdrawal of fiat in a Paxos account.
January 24, 2024
- Docs, v2 API: Publish Production version of Fiat Transfers reference documentation.
January 23, 2024
- v1 API, v2 API: Update REST Transfer API Rate Limit to 20 requests per second.
/v1/transfers/peer
/v1/transfers/profile
/v1/crypto-withdrawals
/v2/transfer/internal
/v2/transfer/crypto-withdrawals
January 17, 2024
- v1 API, v2 API: The
address1
,city
andprovince
fields are no longer explicitly marked as required in theMailingAddress
object. The v1 API CreateBankAccount endpoint and the v2 API Create Fiat Account and Update Fiat Account endpoints will continue to validate these fields if they exist.
January 11, 2024
- FIX: Add
SelfMatchPreventionID
(tag 2362) to prevent matching against an opposite side order submitted by the same Crypto Brokerage customer. If this tag is not submitted, an order that matches against another order submitted by the same customer will cancel the original resting order.
December 15, 2023
- Sandbox: PYUSD trading pairs are available in the Sandbox environment for REST and FIX users. All relevant endpoints support PYUSD-based trading pairs (for example, BTC:PYUSD and ETH:PYUSD among other). Contact your Paxos Representative for details.
December 13, 2023
- v2 API: Add optional field
self_match_prevention_id
to Create Order. This field is used to prevent matching against an opposite side order submitted by the same Crypto Brokerage customer. If this field is not submitted, an order that matches against another order submitted by the same customer will cancel the original resting order.
December 5, 2023
- Docs: Correctly identify the
markets
,transfer_type
,account_id
andtax_year
query parameters as required to reflect actual API behavior. Auto-generated and other clients relying on the OpenAPI spec file may require updates.
November 15, 2023
v2 API: The List Tickers v2 API service has reached End of Life. Requests now return a 404 Error. All integrations must use Get Ticker or List Prices. The migration guide provides additional information.
November 1, 2023
- Reconciliation Reporting: As part of reconciliation reporting improvements, we are incrementally rolling out a few changes to the Profile Balances Report.
- The report no longer lists assets in ordered asset order. New order will be
balance_at
time (start time then end time) first, and asset alphabetical second. - The report now shows assets as long as there is one transaction that happened in history, even if no transactions in the asset were reported during the reporting period. Previously, assets with balances would show up in the report only if there was a transaction in the reporting period or if the asset was pre-configured to show up in the report regardless of transaction history.
- The report no longer lists assets in ordered asset order. New order will be
October 26, 2023
- Docs: Content updates and fixes.
- Clarify HRQ Quickstart TIP text to state a single Quote Execution default maximum size is $50K USD. Previously the TIP stated $100K USD.
- Update Stablecoin Conversion > Assets to reflect that a conversion uses the lowest maximum precision.
October 25, 2023
- v2 API: Add new Stablecoin Conversion API that allows for guaranteed 1:1 conversions between USD and Paxos-issued stablecoins. The Conversions API currently supports USD:USDP and USD:PYUSD pairs.
- Docs: Add Stablecoin Conversion guide to Paxos Documentation.
October 18, 2023
- v2 API: Enable HRQ users to trade and retrieve PAX Gold (PAXG) using the Quote Executions and Quotes endpoints.
August 22, 2023
- Docs: Add search functionality to Paxos Documentation.
August 21, 2023
- v2 API: Enable HRQ users to buy and sell PYUSD using the Create Quote Execution endpoint. Allow all HRQ users to retrieve PYUSD using the List Quotes endpoint.
- v2 API: Add PYUSD to the List Historical Prices endpoint.
- v1 API: Enable PYUSD withdrawal. All PYUSD withdrawals debit USD balance only. Enable USD deposit auto-conversion to PYUSD withdrawal.
- v2 API: Enable PYUSD withdrawals using the Transfers API with the option to debit USD balance. Add values
asset=PYUSD
andbalance_asset=USD
to the Create Crypto Withdrawal request. - Wallet UI: Enable PYUSD withdrawals. All PYUSD withdrawals debit USD balance only. Enable USD deposit Auto-Transfer to PYUSD withdrawal.
- Docs: Add sourcing and implementation information to the Paxos Documentation.
August 10, 2023
- v2 API: Add
assets=PYUSD
query parameter to List Profile Balances. Addasset=PYUSD
path parameter to Get Profile Balances. Add”asset”: “PYUSD”
to Create Sandbox Deposit request body schema. AddPYUSD
to propertiesbase_asset
,quote_asset
,commission_asset
andrebate_asset
for the List Executions, List Quotes, List Quote Executions, Create Quote Execution and Get Quote Execution endpoints. About PYUSD.
July 21, 2023
- Docs: Add Held Rate Quotes Quickstart guide, Ledgering Strategy and Orders & Quotes FAQ best practice guides.
July 11, 2023
- V2 API: Add a default of 100 results to the
limit
query parameter and restrict the maximum page limit to 1,000 for the Paxos v2 API List Deposit Addresses service. Learn more.
June 23, 2023
- v1 API: Add new schema
IntrabankDepositInstructions
and new fieldPaxosBankAccount
to theGetProfileDepositInstructions
endpoint.IntrabankDepositInstructions
includes fieldsmemo_id
,beneficiary_name
account_number
, andtype
.PaxosBankAccount:intrabank
is a genericIntrabankDepositInstructions
that populates whenever any of the otherintrabank
type fields (for example,cbit
) are populated (the respective existing fields will also be populated and supported). Futureintrabank
networks will be contained inintrabank
only.
June 13, 2023
- v1 API:
CreateBankAccount
endpoint andCustomerBankAccount
schema have a new optional field:IntrabankWithdrawalInstructions
.- This generalizes the existing intrabank withdrawal instructions into a single field. Clients may specify the new
IntrabankWithdrawalInstructions
(which consist ofbeneficiary_name
,account_number
, andCustomerBankAccount.Type
) as an alternative to existing network-specific intrabank details (account_number
can be a wallet address for networks like CBIT). CustomerBankAccount
will fill inIntrabankWithdrawalInstructions
IN ADDITION TO the existing intrabank withdrawal instructions in responses. Future intrabank networks will only be supported viaIntrabankWithdrawalInstructions
(as opposed to their own field). The Type field onIntrabankWithdrawalInstructions
will differentiate the network types.- Existing network-specific instructions are deprecated, but will continue to work.
- This generalizes the existing intrabank withdrawal instructions into a single field. Clients may specify the new
June 12, 2023
- Docs: Add FIX overview, onboarding, certification and best practices documentation.
May 24, 2023
- v2 API: Add error code
MARKET_CONDITIONS_PREVENTED_EXECUTION
to Create Order response. - FIX: Add additional detailed failure reason (tag 58)
Market conditions have invalidated this order
.
May 19, 2023
- Docs: Enable RSS, Atom and JSON feeds for the Paxos Changelog.
May 9, 2023
- v1 API, v2 API, Wallet UI: SOL is now a supported asset for crypto deposits.
April 26, 2023
- Breaking Change: itBit REST API End of Life Notification: Paxos will discontinue service for all itBit REST Production and Sandbox APIs. See Migrating from itBit (v1) to Paxos (v2) API.
April 21, 2023
- v2 API: Add parameter
recipient_profile_id
to Create Quote Execution.
April 18, 2023
- Docs: Add new parameter precisions to Orders, Precision and Rounding best practice guide.
April 14, 2023
- Docs: Add crypto brokerage and stablecoin and overview pages. Add Crypto Brokerage Orders, Precision and Rounding best practice guide.
April 12, 2023
v2 API: Add value PROVE
to parameter person_details.passthrough_verifier_type
on Create Identity and Update Identity request and response for the v2 REST API. Add value PROVE
to parameter person_details.passthrough_verifier_type
on List Identities and Get Identity response.
March 14, 2023
- WebSockets Add WebSockets documentation, including a quickstart and API reference.
March 2, 2023
- v1 API: Disable
wiredeposit instructions for Silvergate. BothGetProfileDepositInstructions
andGetCryptoAddressAutoconversionInstructions
now returnno longer return SEN Deposit Instructions nor Silvergate wire deposit instructions. These endpoints still return SigNet Deposit Instructions and memo IDs.NULL
- v1 API: Deprecate
CreateSenWithdrawal
. The endpoint now returns403 error - Forbidden
.
February 23, 2023
- Add value
FIS
to parameterperson_details.passthrough_verifier_type
on Create Identity and Update Identity request and response for the v2 REST API. Add valueFIS
to parameterperson_details.passthrough_verifier_type
on List Identities and Get Identity response. - Paxos Retail UI: Reduce Market Order maximum size for BTC and ETH to $25,000. Does not apply to API initiated orders.
February 22, 2023
- Breaking Change: Require
crypto_network
on all requests to the Create Crypto Withdrawal v2 API endpoint. Production go-live February 22, 2023.
February 15, 2023
- Sandbox: Require
crypto_network
on all requests to the Create Crypto Withdrawal and Create Sandbox Deposit v2 API endpoints. Learn more.
February 14, 2023
- Production: Return a
500
error only when all requestedmarkets
fail to be retrieved for the v2 REST API List Prices service. Any single market that failed to be retrieved is excluded from the response.
February 13, 2023
Production: Return a500
error only when all requestedmarkets
fail to be retrieved for the v2 REST API List Prices service. Any single market that failed to be retrieved is excluded from the response.
February 10, 2023
- Ensure results match filtering criteria when viewing paginated results for v2 REST API endpoints List Transfers and List Deposit Addresses.
February 9, 2023
- Enable statuses
TIN_VERIFICATION_VALID
,TIN_VERIFICATION_ERROR
andTIN_VERIFICATION_PENDING
for parametertin_verification_status
on all Identity v2 REST APIs. The new statuses apply to US-based users and are returned only whentax_details
exist.
February 7, 2023
- Sandbox: Return a
500
error only when all requestedmarkets
fail to be retrieved for the v2 REST API List Prices service. Any single market that failed to be retrieved is excluded from the response. - Improve Request samples dropdown UI when multiple examples exist in the v2 REST API Reference Docs.
January 20, 2023
- Add
metadata[“origin”] = “v1”
to Crypto Withdrawal transfers created via the CreateCryptoWithdrawal v1 REST API endpoint. This allows Crypto Withdrawals created via the v1 REST API to be distinguished from those created using the v2 REST API.
January 19, 2023
- Update itBit REST API documentation with new End of Life date.
- Require v2 REST API docs consume most recent specification file.
January 18, 2023
- Provide a
snapshot_at
field in the v2 REST API List Prices response so API consumers can understand the validity of a price and validate the time at which a price was given.
January 17, 2023
- Sandbox: Enable parameter
group_id
for linking the debit and credit legs of an Internal Transfer on the v2 REST API. Addgroup_id
to Create Internal Transfer, List Transfers and Get Transfer responses when the response includes an Internal Transfer. Add query parametergroup_ids
to List Transfers. - Add
GroupID
to the Profile Transactions Reconciliation Report. Enable statusesTIN_VERIFICATION_VALID
,TIN_VERIFICATION_ERROR
andTIN_VERIFICATION_PENDING
for parametertin_verification_status
on all Identity v2 REST APIs. The new statuses apply to US-based users and are returned only whentax_details
exist.Provide asnapshot_at
field in the v2 REST API List Prices response so API consumers can understand the validity of a price and validate the time at which a price was given.