Welcome to Paxos APIs. At Paxos, our mission is to enable the movement of any asset, any time, in a trustworthy way. These APIs serve that mission by making it easier than ever for you to directly integrate our product capabilities into your application, leveraging the speed, stability, and security of the Paxos platform.
The documentation that follows gives you access to our Crypto Brokerage, Trading, and Exchange products. It includes APIs for market data, orders, and the held rate quote flow.
To test in our sandbox environment, sign up for an account. For more information about Paxos and our APIs, visit Paxos.com.
\n", + "x-logo": { + "url": "/docs/paxos.svg", + "backgroundColor": "#FFFFFF", + "altText": "Paxos logo" + } + }, + "tags": [ + { + "name": "Profiles", + "description": "Profiles hold asset balances, and every Paxos transaction is on a particular profile.\nDepending on your integration type, Profiles may be used to reflect both corporate balances or individual user balances.\nThere are two types of Profiles:\n- `DEFAULT` Profiles are system-generated.\n- `NORMAL` Profiles are created using the [Create Profile](#operation/CreateProfile) endpoint and are the only type of Profile you can create.\n" + }, + { + "name": "Quotes", + "description": "Quotes are \"held rates\" offered by Paxos to buy or sell assets at a specific\nprice within a period of time - for example, the option to buy BTC within\nthe next 30 seconds for $8,000.\n\nThe typical Quotes workflow is as follows:\n\n1. Call [List Quotes](#operation/ListQuotes) to get the latest available\n quoted prices for the assets you want to buy or sell.\n1. Present the offered price to one or more end-users, with a timer\n indicating the time to expiration.\n1. If a user accepts the price, call [Create Quote Execution](#operation/CreateQuoteExecution) with the amount to buy or sell.\n1. Call [Get Quote Execution](#operation/GetQuoteExecution) to monitor\n for completion and know when the funds from the execution are available.\n\nIt's important to show end-users the latest available price. If you cache\nprices to show them to multiple users, you should refresh the cache once\nper second.\n\nYou can call [List Quote Executions](#operation/ListQuoteExecutions) to\nreview or construct reports on quote execution activity.\n" + }, + { + "name": "Quote Executions", + "description": "Quote Executions buy or sell assets using a Quote obtained from\nthe [Quotes](#tag/Quotes) flow.\n" + }, + { + "name": "Orders", + "description": "There are three types of orders: market, limit and post-only.
\nMarket orders guarantee execution at a variable price and quantity. Limit orders guarantee price and quantity at the time of execution but do not guarantee execution. Post-only is an order type that will only be placed on the order book if it is the maker side of a trade.
\n" + }, + { + "name": "Market Data", + "description": "Market data provides various parameters of the order book and historical order data.\n" + }, + { + "name": "Pricing", + "description": "Pricing provides historical data related to charting of asset prices.\n\nNote: Some Pricing API markets may be unavailable for trading.\n" + }, + { + "name": "Issuer Quotes", + "description": "Issuer Quotes are \"held rates\" offered by Paxos to mint or redeem Paxos-issued assets at a specific price within a period of time - for example, the option to buy PAXG within the next 5 seconds for $3,000.\n\nThe typical Issuer Quotes workflow is as follows:\n\n1. Call [Create Issuer Quote](#operation/CreateIssuerQuote) to get a quote for the asset you want to mint or redeem to a specific profile.\n1. Call [Create Issuer Quote Execution](#operation/CreateIssuerQuoteExecution) with the quote ID and profile ID.\n\nYou can call [List Issuer Quote Executions](#operation/ListIssuerQuoteExecutions) to review or construct reports on issuer quote execution activity.\n" + }, + { + "name": "Identity", + "description": "An Identity represents a person or institution who is able to take actions on the Paxos Platform. Depending on \nyour integration type you might not need to create Identities for your end users. \n\nIdentities must pass a set of verifications and checks before they're able to transact on the Platform. Learn more\nabout getting started with Identity and managing their onboarding lifecycle in the [Identity Developer Guide](https://docs.paxos.com/identity).\n" + }, + { + "name": "Institution Members", + "description": "Institution Members allow you to associate persons with an institution on our Platform.\nEach institution can have multiple members, with each member representing the relationship to a person identity.\n\nWhen creating an institution identity, you must designate at least one institution member.\nThis requirement ensures we have complete information about the institution's ownership structure\nand key personnel, which is necessary to onboard institutions.\n" + }, + { + "name": "Accounts", + "description": "Accounts connect Identities (persons or institutions) to Profiles (asset balances).\nKey features include:\n\n- **Balance Management**: Track and manage profile balances via [Subledgering](https://docs.paxos.com/crypto-brokerage/ledger-type#fiat-and-crypto-subledger)\n- **Joint Account Support**: Link multiple Identities to a single Account for shared on platform balance\n\nAccounts are required for all Identity API integrations.\n" + }, + { + "name": "Account Members", + "description": "Account Members allow you to associate an Identity with an Account on our Platform.\nEach Account can be linked to multiple Identities, which supports Joint Accounts (where two Identities have the ability\nto transact against a single Profile) \n\nAccount members are effectively immutable. In order to update an account member,\nclients should remove then re-add the account member with the desired state.\n\nThe API requires clients to have write access on the account and all identities\nassociated with the account.\n" + }, + { + "name": "Identity Documents", + "description": "The Identity Documents API allows clients to send documents to Paxos to validate identities\nduring the KYC process. Files can be updated multiple times by re-sending the document type\nfor processing.\n\nWe currently accept the following file formats:\n-pdf\n- jpg\n- png\n\nSteps to upload a document are as follows:\n1. Send a PUT request to /identity/identities/{id}/documents to get\n the upload URL.\n1. Send your document to the provided URL via a PUT request. Take the following example using curl:\n $ curl --upload-file Proof_of_residence.jpg $URI \n\nUploaded document metadata will be available via GET request to /identity/identities/{id}/documents\n"
+ },
+ {
+ "name": "Fiat Transfers",
+ "description": "The Fiat Transfers API allows clients to deposit and withdraw fiat via the following Fiat Networks: Wire (Fedwire and SWIFT) and CUBIX. The supported asset is USD.\n\nThe full set of Fiat Transfers API endpoints is:\n- For Deposits:\n - [Create Fiat Deposit Instructions](#operation/CreateFiatDepositInstructions)\n - [List Fiat Deposit Instructions](#operation/ListFiatDepositInstructions)\n - [Get Fiat Deposit Instructions](#operation/GetFiatDepositInstructions)\n- For Withdrawals:\n - [Create Fiat Account](#operation/CreateFiatAccount)\n - [List Fiat Accounts](#operation/ListFiatAccounts)\n - [Get Fiat Account](#operation/GetFiatAccount)\n - [Delete Fiat Account](#operation/DeleteFiatAccount)\n - [Update Fiat Account](#operation/UpdateFiatAccount)\n - [Create Fiat Withdrawal](#operation/CreateFiatWithdrawal)\n"
+ },
+ {
+ "name": "Stablecoin Conversion",
+ "description": "Convert between fiat and stablecoin using Create Stablecoin Conversion and check the status of a single conversion or retrieve a list of conversions.
\n", + "externalDocs": { + "description": "Learn more about stablecoin conversions →", + "url": "https://docs.paxos.com/developer/convert" + } + }, + { + "name": "Transfers", + "description": "Each deposit to and withdrawal from a Paxos account is a Transfer.\nA Transfer is associated with a particular Profile, and increases or\ndecreases the available balance of a single asset in that Profile.\n" + }, + { + "name": "Tax Forms", + "description": "All tax forms are associated to a single account_id.\nAn account_id can have multiple tax forms associated with it.\nUS 1099-B and 1099-Misc tax forms for the previous fiscal year will be available in February of the current calendar year.\nPrevious years tax forms are also available by request.\n" + }, + { + "name": "Crypto Deposits", + "description": "For [Paxos Global PTE Ltd](https://help.paxos.com/hc/en-us/articles/9647005243284) users, update or reject a crypto deposit that does not contain the required [travel rule](https://help.paxos.com/hc/en-us/articles/25928845778068) information.\nDeposits with the `NEEDS_INFO` status require additional sender information before they can be processed.\n- For individuals, both first and last name are required.\n- For institutions, the institution name is required.\n\nIf a deposit is rejected, the funds will no longer be available.\n", + "externalDocs": { + "description": "Learn more about travel rule udpates →", + "url": "https://help.paxos.com/hc/en-us/articles/25422999706900" + } + }, + { + "name": "Settlement", + "description": "Use the Settlements API to facilitate simultaneous exchange of pre-funded assets. Automate a variety of use cases that require two-party approval, including net settlement of over-the-counter trades, withdrawal requests for tri-party collateral, payment requests, and bilateral settlement for marketplace end users.\n\nThe simple request-and-approval workflow supports both one-directional and bidirectional transactions to allow a user to receive an asset (for example, send USDP) or simultaneously send and receive assets (for example, send USD and receive BTC and ETH). Only when all parties are in agreement and assets are fully funded does the Settlements API allow for change of custody. Upon completion, all settled assets are immediately available for trading, transferring, withdrawal or other supported activities.\n\nThe Source Profile initiates the transaction for the Target Profile to approve. The `DIRECTION` of each asset is always relative to the Source Profile and only the owner of the Source Profile can cancel a transaction if it hasn't been approved by the Target Profile.\n", + "externalDocs": { + "description": "Learn more about the Settlement APIs →", + "url": "https://docs.paxos.com/settlements" + } + }, + { + "name": "Paxos Transfers", + "description": "Move assets between two Entities belonging to the same Organization or to a different Organization on the Paxos platform.\n\n> Transferring USD between Entities is prohibited in some jurisdictions. Contact [Support](https://support.paxos.com/) if you run into any problems with this restriction.\n\nEnsure the destination [Profile](https://docs.paxos.com/dashboard/organization#profile) already exists before beginning the transfer. This may require contacting someone outside your Organization to get the destination Profile ID.\n" + }, + { + "name": "Monitoring Addresses", + "description": "A Monitoring Address is a blockchain address that Paxos monitors daily for eligible stablecoin activity and determines the amount of rewards your organization will earn. We recommend adding any addresses you expect to hold, receive, or mint Paxos stablecoins as a monitoring address in order to receive rewards for all of your qualifying on-chain activity. \n\n> Monitoring addresses must be added by month end (`23:59 UTC+0`) in order to earn rewards for that month. Addresses added after month end will start earning rewards for the following month.\n\n*These endpoints are only relevant for Global Dollar Network (GDN) partners.*\n" + }, + { + "name": "Payout Address", + "description": "Endpoints working with Payout Address. These endpoints are only relevant for Global Dollar Network (GDN) partners." + }, + { + "name": "Statements", + "description": "A Statement summarizes all eligible stablecoin rewards for a given organization over a fixed time period. It aggregates earned reward types (e.g., custody, mint, acceptance) and records whether the statement was paid.\n\nStatements are generated monthly and are immutable. Revised statements will be issued as a new statement with a unique ID. Statements can be used to reconcile balances or for accounting and accounts receivable purposes.\n\n*These endpoints are only relevant for Global Dollar Network (GDN) partners.*\n" + }, + { + "name": "Payments", + "description": "Payments represent actual transfers of rewards to the payout address associated with a given statement. Payments are made on-chain to a specified payout address. Payments tie 1:1 with a statement amount.\n\nUse the `ref_id` to link payments to statements. \n\n> Some fields (e.g., `account_id`, `profile_id`) are populated for consistency but are not relevant to reward-specific flows.\n\n*These endpoints are only relevant for Global Dollar Network (GDN) partners.*\n" + }, + { + "name": "API Credentials", + "description": "API credentials allow programmatic access to Paxos APIs. These endpoints enable you to manage and view your API credentials.\n" + }, + { + "name": "Events", + "description": "The Events API allows you to fetch events that occurred on the Paxos platform with the full event payload. This REST API can be used as part of your webhook integrations (including rebuilding your event history should your webhook consumer exceed its retries), or standalone by polling for events related to your identities.\n" + }, + { + "name": "Event Types", + "description": "identity.documents_required\n \n \n Identity requires additional documents, use the UploadDocument endpoint to upload all required documents.\n
\nidentity.approved\n \n \n Identity is APPROVED\n
identity.denied\n \n \n Identity is DENIED\n
identity.disabled\n \n \n Identity is DISABLED\n
identity.kyc_refresh.started\n \n \n Identity is required to undergo its periodic KYC refresh.\n
\nidentity.kyc_refresh.completed\n \n \n Identity has successfully completed its periodic KYC refresh.\n
\nidentity.kyc_refresh.expired\n \n \n Identity has not completed its required KYC refresh within the designated timeframe.\n
\ntransfer.crypto_deposit.pending\n \n \n Crypto deposit detected on-chain and is PENDING confirmation.\n
transfer.crypto_deposit.completed\n \n \n Crypto deposit is COMPLETED and funds are available on platform.\n
transfer.crypto_deposit.failed\n \n \n Crypto deposit has FAILED or been cancelled.\n
transfer.crypto_withdrawal.pending\n \n \n Crypto withdrawal has been initiated and is PENDING on-chain processing.\n
transfer.crypto_withdrawal.completed\n \n \n Crypto withdrawal is COMPLETED and has been sent to the destination address.\n
transfer.crypto_withdrawal.failed\n \n \n Crypto withdrawal has FAILED or been cancelled.\n
transfer.act_deposit.pending\n \n \n Fiat deposit via DBS has been initiated and is PENDING processing.\n
transfer.act_deposit.completed\n \n \n Fiat deposit via DBS is COMPLETED and funds are available on platform.\n
transfer.act_deposit.failed\n \n \n Fiat deposit via DBS has FAILED or been cancelled.\n
transfer.act_withdrawal.pending\n \n \n Fiat withdrawal via DBS has been initiated and is PENDING processing.\n
transfer.act_withdrawal.completed\n \n \n Fiat withdrawal via DBS is COMPLETED and has been sent to the destination account.\n
transfer.act_withdrawal.failed\n \n \n Fiat withdrawal via DBS has FAILED or been cancelled.\n
\n \n Note: We may add additional event types at any time. Your implementation should handle unexpected event types gracefully.\n \n
\n\n The following object schemas describe the structure of data that accompanies each event type.\n
\n \nidentity_documents_required\n \n | Field | \nType | \nDescription | \n
|---|---|---|
\n id\n | \n UUID | \nUnique identifier for this event object | \n
\n identity_id\n | \n UUID | \nIdentifier for the identity requiring documents | \n
\n required_documents\n | \n list enum | \n\n List of required document types\n | \n
identity_summary_status_change\n \n | Field | \nType | \nDescription | \n
|---|---|---|
\n id\n | \n UUID | \nUnique identifier for this event object | \n
\n identity_id\n | \n UUID | \nIdentifier for the affected identity | \n
\n old_summary_status\n | \n enum | \n\n Previous status:\n \n PENDING\n ERROR\n APPROVED\n DENIED\n DISABLED\n \n | \n
\n new_summary_status\n | \n enum | \n\n New status:\n \n PENDING\n ERROR\n APPROVED\n DENIED\n DISABLED\n \n | \n
identity_kyc_refresh\n \n | Field | \nType | \nDescription | \n
|---|---|---|
\n id\n | \n UUID | \nUnique identifier for this event object | \n
\n identity_id\n | \n UUID | \nIdentifier for the affected identity | \n
\n last_kyc_refresh_date\n | \n Datetime | \n\n Date of the most recent completed KYC refresh\n (optional)\n | \n
\n next_kyc_refresh_date\n | \n Datetime | \n\n Scheduled date for the next KYC refresh\n (optional)\n | \n
transfer_status_change\n \n | Field | \nType | \nDescription | \n
|---|---|---|
\n id\n | \n UUID | \nThe Paxos transfer ID. You can call the GetTransfer endpoint with this ID to get more details about it. | \n
\n type\n | \n enum | \n\n Type of transfer:\n \n CRYPTO_DEPOSIT\n CRYPTO_WITHDRAWAL\n ACT_DEPOSIT\n ACT_WITHDRAWAL\n \n | \n
\n status\n | \n enum | \n\n Status of transfer:\n \n PENDING\n COMPLETED\n FAILED\n \n | \n
\n ref_id\n | \n string | \n\n The client-specified ID of the transfer for replay protection and lookup.\n (optional)\n | \n
\n crypto_network\n | \n enum | \n\n Cryptocurrency network (e.g. ETHEREUM, BASE, SOLANA)\n (optional, present for crypto transfers)\n | \n
\n crypto_tx_hash\n | \n string | \n\n On-chain transaction hash\n (optional, present for crypto transfers when available)\n | \n
\n crypto_tx_index\n | \n string | \n\n The output index or output address\n (optional, present for crypto transfers when available)\n | \n
\n memo\n | \n string | \n\n Memo associated with the transfer as an identifier\n (optional, present for fiat transfers when available)\n | \n