Versioning
Changelog
Product updates and announcements
V2 API: Adds DeleteAPICredentials endpoint. To delete existing API credential.
Crypto Deposits and Withdrawals (Stellar PYUSD): Updated API documentation to clarify trustline requirements for PYUSD transfers on Stellar network. Documentation now includes:
- Trustline requirement details - destination addresses must have an established trustline with the PYUSD issuer
- Step-by-step instructions for establishing trustlines using Stellar wallets or SDK
- Verification methods for checking trustline status via blockchain explorers, Horizon API, or Stellar SDK
V2 API: Adds
status, created_at, and updated_at to ListAPICredentials responses. Support for filtering by status also added.V2 API: Adds optional
recipient_metadata field to CreateInternalTransfer.V2 API: Adds ListAPICredentials endpoint. Lists all API credentials that have been created.
V2 API: Add optional ids filter to ListProfiles to support filtering by specific profile IDs.
V2 API: Added
ids filter to ListAPICredentials request.V2 API: Add optional
status_details field to Transfer that can provide more specific information related to a Transfer’s status. v2 API: Add
created_at field to DepositAddress. It is a field used to identify the time at which DepositAddress was created.v2 API: Add optional
memo field to CreateCryptoWithdrawalRequest. It is an optional field used to identify a crypto withdrawal.v2 API: Add optional
from_account_id, from_identity_id, to_account_id, to_identity_id parameters to CreatePaxosTransfer.v2 API: Add field memo to ListTransfers and GetTransfer response. It is an optional field used to identify a transfer. Currently supported for Fiat Transfers.v2 API: Add Events API to power webhook integrations, enabling real-time notifications when events occur on the Paxos platform.
v2 API: Add values
PERSONA and PLAID to parameter person_details.passthrough_verifier_type on Create Identity and Update Identity request and response.v2 API: Add optional
from_account_id, from_identity_id, to_account_id, to_identity_id parameters to CreateInternalTransfer.v2 API: Add Rewards API Documentation.
v2 API: Document the max file upload size for the Identity Documents: Document Upload API.
v2 API: Add parameter
last_kyc_refresh_date to the Identity API for setting the timestamp the Identity last underwent periodic refresh.v2 API: Add Deactivate Profile endpoint to the Profile API.
v2 API: Remove the unused value
RANSOMWARE from the institution_details.institution_sub_type enum on the Identity API.v2 API: Add enum value
TRAVEL_RULE_REJECTED to the secondary_statuses parameter for List Transfers and Get Transfer responses. TRAVEL_RULE_REJECTED may be used as a query parameter for List Transfers. Breaking Change: The Paxos v1 API has reached its end of life. Paxos no longer supports the v1 API. The v2 API fully supports all current API use cases.v2 API: Add
include_deactivated query parameter to the Get Profile endpoint to enable retrieving a deactivated Profile.Reconciliation Reporting: We’re enhancing our reconciliation reports with two new fields:
OrchestrationID links all related transactions within a single end-to-end flow. OrchestrationRuleID identifies which automation rule triggered the transaction set. These additions make it easier to track multi-step transactions and map them to their triggering rules, improving audit trails and simplifying reconciliation processes for treasury and enterprise payment operations. v2 API: Add the
nickname query parameter on List Profiles. Enables searching for Profiles by the given prefix. v2 API: Add Paxos Transfers to enable asset movement between two Entities belonging to the same Organization or to a different Organization on the Paxos platform. v2 API: Add Update Profile to allow changing the
nickname of an existing Profile. v2 API: The identity_id parameter is now optional with Create Fiat Account. Those with 3rd-Party integrations initiating transfers on behalf of their end users must continue to use the parameter. v2 API: Enable optional
business_description parameter for the Create Identity, Update Identity, Get Identity and List Identities endpoints. v2 API: Add REAL_ESTATE and OTHER_SOURCE_OF_WEALTH to the customer_due_diligence.source_of_wealth enumeration on the Identity APIs. Docs, v2 API: Enable USDG on Ethereum. Add USDG docs. Docs, v2 API: Enable support for CUBIX API and update docs for Transfers and Fiat Transfers. All users of the Customers Bank integrations must start using CUBIX by November 11, 2024. See the CUBIX API migration guide.
v2 API: Add
DBS_ACT to Fiat Network Instructions. v2 API: Add optional
crypto_tx_hashes filter to the List Transfers endpoint.
v2 API: Add the following document types to Identity Documents APIs: AML_DOCUMENTS, FUND_STRUCTURE_CHART, FUND_MANAGER_REGISTRATION, MEMORANDUM_OF_ASSOCIATION, ORGANIZATIONAL_CHART, FOUNDATION_BY_LAWS, APPOINTMENT_OF_GUARDIAN_EVIDENCE, LEGAL_DOMICILE_OF_BENEFICIAL_OWNERS, GOVERNING_BODY_MEMBER_NAMES. v2 API: Add three new optional fields to the
customer_due_diligence object of the Identity API (Create Identity and Update Identity). v2 API: Add new ENUM value GOVERNMENT_BENEFITS to the customer_due_diligence object field source_of_funds in the Identity API (Create Identity and Update Identity). v2 API: Add
is_merchant field to the Identity API (Update Identity, Get Identity, List Identities). v2 API: Updated rate limit on Identity API from 50 to 10 requests per second.
Docs, v2 API: Add new Settlement APIs which allow for atomic one-way or two-way transfers across Paxos accounts. Also added Settlement integration guide.
FIX: Enforce a maximum of 150 messages per second, per session.
Docs: Add stablecoin payments documentation.
v2 API: All
metadata specified when creating a crypto deposit address is now inherited by deposit activities. 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. Docs, v2 API: Enable PYUSD on Solana. Update PYUSD docs with mainnet and testnet addresses.
v2 API: Add optional
is_merchant boolean field to the Create Identity request body and the List Identities, Create Identity, Get Identity and Update Identity responses. Breaking Change: Update 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 Support for details.
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. v2 API: Add Insufficient Funds 403 error response to Create Fiat Withdrawal endpoint.
Docs, v2 API: Add Fiat Transfers integration guide to Paxos Documentation and update reference docs.
v2 API: Add new Fiat Transfer APIs which allow for automatic funding and withdrawal of fiat in a Paxos account.
Docs, v2 API: Publish Production version of Fiat Transfers reference documentation.
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
v1 API, v2 API: The
address1, city and province fields are no longer explicitly marked as required in the MailingAddress 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. 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. 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 Support for details.
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. Docs: Correctly identify the
markets, transfer_type, account_id and tax_year query parameters as required to reflect actual API behavior. Auto-generated and other clients relying on the OpenAPI spec file may require updates. 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.
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_attime (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.
Docs: Content updates and fixes.
- Clarify HRQ Quickstart TIP text to state a single Quote Execution default maximum size is 100K USD.
- Update Stablecoin Conversion > Assets to reflect that a conversion uses the lowest maximum precision.
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.
v2 API: Enable HRQ users to trade and retrieve PAX Gold (PAXG) using the Quote Executions and Quotes endpoints.
- Docs: Add search functionality to Paxos Documentation.
- 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=PYUSDandbalance_asset=USDto 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.
v2 API: Add
assets=PYUSD query parameter to List Profile Balances. Add asset=PYUSD path parameter to Get Profile Balances. Add "asset": "PYUSD" to Create Sandbox Deposit request body schema. Add PYUSD to properties base_asset, quote_asset, commission_asset and rebate_asset for the List Executions, List Quotes, List Quote Executions, Create Quote Execution and Get Quote Execution endpoints. About [PYUSD][pyusd]. Docs: Add Held Rate Quotes Quickstart guide, Ledgering Strategy and Orders & Quotes FAQ best practice guides.
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. v1 API: Add new schema
IntrabankDepositInstructions and new field PaxosBankAccount to the GetProfileDepositInstructions endpoint. IntrabankDepositInstructions includes fields memo_id, beneficiary_name account_number, and type. PaxosBankAccount:intrabank is a generic IntrabankDepositInstructions that populates whenever any of the other intrabank type fields (for example, cbit) are populated (the respective existing fields will also be populated and supported). Future intrabank networks will be contained in intrabank only. v1 API:
CreateBankAccount endpoint and CustomerBankAccount 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_numbercan be a wallet address for networks like CBIT). CustomerBankAccountwill fill inIntrabankWithdrawalInstructionsIN 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 onIntrabankWithdrawalInstructionswill differentiate the network types.- Existing network-specific instructions are deprecated, but will continue to work.
Docs: Add FIX overview, onboarding, certification and best practices documentation.
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. Docs: Enable RSS, Atom and JSON feeds for the Paxos Changelog.
v1 API, v2 API, Wallet UI: SOL is now a supported asset for crypto deposits.
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.
v2 API: Add parameter
recipient_profile_id to Create Quote Execution. Docs: Add new parameter precisions to Orders, Precision and Rounding best practice guide.
Docs: Add crypto brokerage and stablecoin and overview pages. Add Crypto Brokerage Orders, Precision and Rounding best practice guide.
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. WebSocket: Add WebSocket documentation, including a quickstart and API reference.
v1 API: Disable wire deposit instructions for Silvergate. Both now return no longer return SEN Deposit Instructions nor Silvergate wire deposit instructions. These endpoints still return SigNet Deposit Instructions and memo IDs. v1 API: Deprecate
GetProfileDepositInstructions and GetCryptoAddressAutoconversionInstructions NULLCreateSenWithdrawal. The endpoint now returns 403 error - Forbidden. Add value
FIS to parameter person_details.passthrough_verifier_type on Create Identity and Update Identity request and response for the v2 REST API. Add value FIS to parameter person_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. Breaking Change: Require
crypto_network on all requests to the Create Crypto Withdrawal v2 API endpoint. Production go-live February 22, 2023. Sandbox: Require
crypto_network on all requests to the Create Crypto Withdrawal and Create Sandbox Deposit v2 API endpoints. Learn more. Production: Return a
500 error only when all requested markets 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. Production: Return a
500 error only when all requested markets 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.~~ Ensure results match filtering criteria when viewing paginated results for v2 REST API endpoints List Transfers and List Deposit Addresses.
Enable statuses
TIN_VERIFICATION_VALID, TIN_VERIFICATION_ERROR and TIN_VERIFICATION_PENDING for parameter tin_verification_status on all Identity v2 REST APIs. The new statuses apply to US-based users and are returned only when tax_details exist. Sandbox: Return a
500 error only when all requested markets 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. 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. - Update itBit REST API documentation with new End of Life date.
- Require v2 REST API docs consume most recent specification file.
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. Sandbox: Enable parameter
group_id for linking the debit and credit legs of an Internal Transfer on the v2 REST API. Add group_id to Create Internal Transfer, List Transfers and Get Transfer responses when the response includes an Internal Transfer. Add query parameter group_ids to List Transfers. Add GroupID to the Profile Transactions Reconciliation Report. Enable statuses TIN_VERIFICATION_VALID, TIN_VERIFICATION_ERROR and TIN_VERIFICATION_PENDING for parameter tin_verification_status on all Identity v2 REST APIs. The new statuses apply to US-based users and are returned only when tax_details exist.~~ 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.~~