The Payments API provides the core resources for executing financial operations within the Bity ecosystem. It is designed to simplify the integration of payments, transfers, and trading operations while ensuring speed, security, and cost efficiency.
\nA key feature is the ability to manage both the master account and its associated subaccounts, enabling greater control, flexibility, and centralized governance of financial operations.
\nSubaccounts – Endpoints for creating, managing, and transferring funds between subaccounts, thus obtaining all the user's sub-account information. It also supports status management (active, blocked, canceled) and operational flags for enhanced governance.
\nExchange/FX – Endpoints for retrieving real-time market quotes (Get Order Quote), executing trading orders (Execute Order Quote), and tracking operations through Transactions (all transactions) and Get Transaction (specific transaction).
Wallet – Endpoints for querying balances (Balance) and managing withdrawals (Withdrawal).
OnRamp – Endpoints for managing wallet funding operations, including creating funding requests, generating Quote Payments, generating QR codes, performing Settlements, querying deposit status, and validating incoming transfers. Note****__: Settlement QRCode is used for closing operations between accounts, while Deposit QRCode is intended for incoming deposits.
\nOffRamp – Endpoints to manage fiat off-ramp flows, including creating and retrieving beneficiaries, initiating payments, estimating off-ramp costs via quotes, and accessing compliance reports (IN1888 Report). Supports attaching or referencing documents (typically invoices) as proof of transaction purpose, which is required for regulatory and operational approval before releasing funds to the beneficiary.
Webhooks – Endpoints for setting up webhook integrations to receive real-time updates on payments and account events.
\nThe Sandbox API allows you to test your implementation before going live using fictitious currency and simulated operations.
\nIt mirrors the behavior of the production environment, enabling you to validate the entire flow before going live.
\nTo use the Sandbox environment, simply change the API base URL:
\nhttps://api-sandbox.bitpreco.com/v1\n\nAll endpoints and request formats remain exactly the same — only the base URL changes.
\nThe Production API is the live environment where real operations and real balances are processed.
\nThen, you can switch the environment to Production by updating the base URL:
\nhttps://api.bitpreco.com/v1\n\nAs in Sandbox, the endpoints and request formats are identical.
\nTo create a Sandbox account:
\nRegister at:
https://sandbox.bity.com.br/register
Log in and go to:
https://market-staging.bitypreco.com/
After requesting API access, you may contact our team to expedite approval:
\n💬 Intercom chat (available inside all Bity platforms)
\nNavigate to:
Account Settings → Security → Request API to obtain your staging API credentials.
For assistance or account approval:
\n💬 Intercom chat
\nNote: Sandbox data and credentials are completely separated from Production.
\nTo create a Production (live) account:
\nRegister at:
https://www.bity.com.br/register/
Log in at:
https://market.bitypreco.com/login/
Navigate to:
Account Settings → Security → Request API to obtain your production API credentials.
For assistance or account approval:
\n💬 Intercom chat
\n\n\nImportant: Production credentials and Sandbox credentials are not interchangeable.
\n
All communication with the endpoints is encrypted using SSL to ensure security.
\nRate Limit (Payments API):
The Payments API allows a maximum of 60 requests per minute, including all endpoints within this module. Exceeding this limit may result in temporary throttling of requests, so it’s recommended to implement proper request handling and retries to avoid interruptions.
\n\nImportant:
\n
1. Use the appropriate path for each operation.
2. Always provide your auth_token in the auth_token parameter of the request.
The API structure, endpoints, and request formats are identical in both environments and only the base URL changes.
\nhttps://api-sandbox.bitpreco.com/v1\n\nhttps://api.bitpreco.com/v1\n\nUse the appropriate base URL depending on your environment.
\nAll requests must use the POST method and include the parameter auth_token.
The auth_token is generated by concatenating your signature and API key, which can be requested directly from the BitPreço platform.
Example of credentials received by email:
\nsignature = \"ABg3MTIxOTY………………..tRQXYvWkIxRlAvSlRSV\"\napi_key = \"ApVdlRUCddOd3p0…………..IcUcxZWJpclRpSEpWSQ\"\n\nYour access token is then:
\nauth_token = signature + api_key // concatenated strings\n\nImportant: Always keep your signature and API key secure. Do not share them publicly.
\nTo access the Sandbox API or Production API, you need an auth token. After registering your account, follow these steps:
\nLog in at:
\nProduction: https://market.bitypreco.com/login
\nClick on your name and icon in the top-right corner of the page and select “Conta” (Account).
\nGo to the Security tab.
\nClick the “Request API” button to generate your credentials.
\nImportant:
\nYou must have a valid email associated with your account, as the API credentials will be sent to this email.
\nOnce you receive your auth_token, use it in the auth_token parameter of all API endpoints that require authentication.
Note: The auth_token is valid only for a limited time and must be refreshed after expiration.
Note: This collection will continue to expand, incorporating new endpoints and features, including enhancements to the subaccounts workflow.
\nBelow is the complete centralized map of error codes used across the API, with English translations for client reference.
\nIn case of a timeout during a request, always verify whether the operation was successfully completed by checking the external_id.
If the request returns false (meaning was falied), you can safely retry.
\nIf the request returns true (meaning the operation was created successfully), do not retry the request to avoid creating duplicates.
\n/common:\nINVALID_TOKEN – Invalid token\nINVALID_TOKEN_OR_PRIVILEGES – Invalid token or insufficient privileges\nINVALID_DATA – Some provided data is invalid\nMISSING_DATA – Required parameter is missing\nUSER_NOT_FOUND – User not found\nHTTP_ERROR – HTTP request error\nINVALID_OTP – Invalid OTP\nERROR_ACCESSING_DB – Error accessing database\nMUST_UPDATE_APP_VERSION – App version must be updated\nINVALID_TRANS_ID – Invalid transaction ID\nINVALID_CURRENCY – Invalid currency\nBELOW_MIN_AMOUNT – Below minimum amount\nEXTERNAL_ID_NOT_FOUND – The provided external_id does not exist\nEXTERNAL_ID_ALREADY_USED –The provided external_id is already associated with another resource \n/------------------------------------------------------------------/\n/get_subacc_token:\nMISSING_MAIN_TOKEN_AUTH – Missing main account token\nMISSING_SUBACC_ID – Subaccount ID not provided\nERROR_CREATING_API_TOKEN – Internal error while creating/updating subaccount API token\n/------------------------------------------------------------------/\n/get_related_accounts:\nUSER_NOT_FOUND – User not found\n/------------------------------------------------------------------/\n/subacc_create:\nINVALID_SUBACC_CONF – Invalid subaccount configuration\nCANT_CREATE_SUBACC – User not allowed to create subaccount\nWAIT_TO_CREATE_NEW_SUBACC – Wait before creating a new subaccount\nINSECURE_EMAIL_PROVIDER – Insecure email provider\nUNSUPPORTED_EMAIL_PROVIDER – Unsupported email provider\nINVALID_EMAIL_FORMAT – Invalid email format\nERROR_CREATING_NEW_USER – Error creating new user\nREPROVED_TAXID - The tax ID was rejected during validation.\nUSER_IS_SANCTIONED - The user is sanctioned and cannot create an account.\nINVALID_TAXID_STATUS - The tax ID returned an unknown validation status.\nEMAIL_ALREADY_USED - The provided email is already in use.\nINVALID_STATE_CODE - Invalid state (UF) code provided.\nINVALID_POSTAL_CODE - Invalid postal code format.\nMEI_IS_NOT_ACCEPTED - MEI (Micro-entrepreneur) registrations are not accepted.\nBIRTH_MISMATCH - The birthdate does not match official records.\nTOO_YOUNG - The user does not meet the minimum age requirement.\nINVALID_BIRTHDAY - Invalid birthday format or invalid birthday value.\nINVALID_COMPANY_TAXID - The company tax ID provided is invalid.\nMISSING_COMPANY_DIRECTOR - Missing validated tax ID for the company director.\nINVALID_TAXID_FORMAT - The tax ID does not match expected numeric format.\nDIRECTOR_MUST_HAVE_VALIDATED_ACCOUNT - The company director must have a validated account.\nERROR_CREATING_DIRECTOR_METAMAP_ID - Error while creating the director’s MetaMap identity.\nNOT_SUPPORTED_TAXID - The provided tax ID type or format is not supported.\nINVALID_PERSONAL_TAXID - The personal tax ID is invalid.\nTAXID_ALREADY_REGISTERED - The tax ID is already associated with another account.\n/------------------------------------------------------------------/\n/subaccount_transfer:\nINVALID_TYPE – Invalid account type\nTOKEN_OWNER_MUST_BE_FROM_OR_TO – Token owner must be sender or receiver\nTOKEN_OWNER_MUST_BE_MAIN_ACCOUNT – Token owner must be the main account\nINTERNAL_TRANSFERS_NOT_ALLOWED – Internal transfers not allowed\nFROM_AND_TO_MUST_DIFFERS – Sender and receiver must differ\nINVALID_AMOUNT – Invalid amount\nEMPTY_USER_ID – Empty user ID\nINSUFFICIENT_FUNDS_TO_TRANSFER – Insufficient funds\nDIRECT_TRANSFER_ERROR – Direct transfer error \n/------------------------------------------------------------------/\n/subacc_change_status:\nINVALID_STATUS – Invalid status\nINVALID_SUBACC_ID – Invalid subaccount ID\nNOT_SUBACC_OF_MAIN – Not a subaccount of the main account\nMAIN_ACCOUNT_CANT_CHANGE_STATUS – Main account cannot change status\nEMPTY_OBSERVATION – Observation field empty\nONLY_PENDING_CAN_BE_REPROVED – Only pending status can be rejected\nUSER_HAS_OPEN_CONTRACTS – User has open contracts\nERROR_CANCELING_ALL_CARDS – Error canceling cards\nERROR_CANCELING_CELCOIN_ACCOUNT – Error canceling Celcoin account\n/------------------------------------------------------------------/\n/get_quote:\nNOT_ACTIVE_USER – User not active\nINVALID_MARKET – Invalid market\nMARKET_TEMPORARY_DISABLE – Market temporarily disabled\nERROR_STORING_RFQ_QUOTE – Error storing RFQ quote\nINVALID_OPERATION_TYPE – Invalid operation type\nINVALID_TAG – Invalid tag\nINVALID_OBS – Invalid observation\nBELOW_MINIMUM_AMOUNT – Below minimum amount\nBELOW_MINIMUM_VOLUME – Below minimum volume\nABOVE_MAX_AMOUNT – Above maximum amount\nPRICE_TOO_LOW – Price too low\nINVALID_PRICE – Invalid price\nINVALID_AMOUNT – Invalid amount\nFORBIDEN_MARKET – Forbidden market\nCANT_PROGRAM_BUY_ORDER – Cannot schedule buy order\nCANT_PROGRAM_MARKET_ORDER – Cannot schedule market order\nINVALID_PRICE_OR_AMOUNT_FORMAT – Invalid price/amount format\n/------------------------------------------------------------------/\n/execute_quote:\nQUOTE_EXPIRED_OR_NOT_FOUND – Quote expired or not found\nNOT_QUOTE_OWNER – Not the quote owner\nAMOUNT_BIGGER_THAN_QUOTED – Amount exceeds quoted value\nINVALID_AMOUNT – Invalid amount\nNOT_ENOUGH_USER_BALANCE – Insufficient user balance\nRFQ_ACCOUNT_NOT_FOUND – RFQ account not found\nERROR_EXECUTING_QUOTE – Error executing quote\nQUOTE_EXPIRED – Quote expired\nANNULATED_QUOTE – Quote annulled\nBELOW_MINIMUM_AMOUNT – Below minimum amount\nEXTERNAL_RFQ_BALANCE_UNAVAILABLE – External RFQ balance unavailable\nINSUFFICIENT_EXTERNAL_RFQ_BRL_BALANCE – Insufficient external BRL RFQ balance \n/------------------------------------------------------------------/\n/order_status:\nORDERID_NOT_FOUND - No order found for the given order_id\nNOT_ORDER_OWNER - Order exists but belongs to a different user\nEXTERNAL_ID_NOT_FOUND - No order found matching the external_id for that user\n/------------------------------------------------------------------/\n/transactions:\nINVALID_TIMESTAMPS – Invalid timestamps\nEMPTY_CURRENCY_DETECTED – Empty currency detected\n/------------------------------------------------------------------/\n/transaction_status:\nTRANSACTION_NOT_FOUND – Transaction not found\n/------------------------------------------------------------------/\n/withdrawal:\nBLOCKCHAIN_DISABLED – Blockchain disabled\nINVALID_ADDRESS – Invalid address\nMISSING_BLOCKCHAIN – Blockchain not provided\nBLOCKCHAIN_OR_CURRENCY_NOT_SUPORTED – Unsupported blockchain or currency\nABOVE_MAX_WITHDRAWAL_AMOUNT – Above max withdrawal amount\nEMPTY_ADDRESS - The address field was submitted empty\nPIX_TAXID_DIFFERS – Sender and receiver CPF/CNPJ differ\nINVALID_BANK_ADDRESS – Invalid bank address\nBANK_NUMBER_NOT_FOUND – Bank number not found\nUSER_CANNOT_USE_THIS_FEATURE – User cannot use this feature\nOTP_MUST_BE_ACTIVATED – OTP must be activated\nNOT_WHITELISTED_ADDR - The destination address is not on the user’s approved whitelist\nERROR_REQUESTING_WITHDRAWAL - A system error occurred while processing the withdrawal request.\nWITHDRAWAL_BIGGER_THAN_LIMITS – Withdrawal exceeds limits\nNO_WITHDRAWAL_PRE_APPROVED_USER – Pre-approved user cannot withdraw\nINVALID_ISPB – Invalid ISPB code\nPIX_NOT_FOUND – PIX key not found\nFREE_AMOUNT_SMALLER_THEN_DEBT – Free amount smaller than debt\nINVALID_WITHDRAWAL_TOKEN – Invalid withdrawal token\nINVALID_TRANS_TYPE – Invalid transaction type\nWITHDRAWAL_NOT_ALLOWED - Withdrawals are not allowed for this account or configuration\nTRANSACTION_HAS_CHANGED – Transaction has changed\nMISSING_WITHDRAWAL_PROOF – Missing withdrawal proof\nNO_FUNDS_OR_LIMIT – No funds or insufficient limit\nINVALID_USER_STATUS – Invalid user status\nNOT_ENOUGH_LOCKED_FUNDS – Insufficient locked funds\nALREADY_COMPLETED – Withdrawal already completed\nINVALID_TRANS_STATUS – Invalid transaction status\n/------------------------------------------------------------------/\n/get_settlement:\nBALANCE_NOT_FOUND = Balance not found\nNO_AMOUNT_PENDING_SETTLEMENT = No amount pending settlement\nERROR_GETTING_PIX_KEY = Error retrieving PIX key\n/------------------------------------------------------------------/\n/deposit_qrcode:\nBALANCE_NOT_FOUND = Balance not found\nERROR_GETTING_PIX_KEY = Error retrieving PIX key\nERROR_CREATING_QRCODE = Error creating PIX QR Code\n/------------------------------------------------------------------/\n/quote_to_payment:\n(Route not implemented)\n/------------------------------------------------------------------/\n/pix_get_keys:\nINVALID_TOKEN_OR_ID = Invalid token or ID\nERROR_PIX_GET_KEYS = Error retrieving PIX keys\nERROR_PIX_GET_STATIC_QRCODES = Error retrieving static PIX QR Codes\n/------------------------------------------------------------------/\n/pix_create_key:\nUSER_CANNOT_USE_THIS_FEATURE = User cannot use this feature\nINVALID_VALIDATION_TOKEN = Invalid validation token\nERROR_PIX_CREATE_KEY = Error creating PIX key\nINVALID_MAIN_ACCOUNT = Invalid main account\nMAIN_ACCOUNT_HAS_NO_PIX_KEY = Main account has no PIX key\nERROR_CREATING_QRCODE = Error creating QR Code\n/------------------------------------------------------------------/\n/offramp_create_beneficiary:\n(Route not implemented)\n/------------------------------------------------------------------/\n/offramp_get_beneficiary:\n(Route not implemented)\n/------------------------------------------------------------------/\n/offramp_beneficiary_list:\nINVALID_PRIVILEGES = Invalid privileges\nMISSING_CUSTOMER_ID = Customer ID not provided\nHTTP_ERROR = HTTP request error\n/------------------------------------------------------------------/\n/offramp_payment:\nINVALID_OFFRAMP_QUOTE_ID = Invalid off-ramp quote ID\nERROR_CREATING_TRANSACTION = Error creating transaction\nERROR_UPDATING_TRANSACTION_ORDER_ID = Error updating transaction order ID\nERROR_CREATING_PLANETRAMP_TRANSACTION = Error creating PlanetRamp transaction\nERROR_UPDATING_TRANSACTION_TXID = Error updating transaction TXID\nERROR_FETCHING_TRANSACTION_AFTER_CREATION = Error fetching transaction after creation\nERROR_EXECUTING_RFQ_QUOTE = Error executing RFQ quote\n/------------------------------------------------------------------/\n/offramp_quote:\nMISSING_SOURCE_OR_TARGET_AMOUNT = Source or target amount not provided\nBOTH_SOURCE_AND_TARGET_AMOUNT_PROVIDED = Send only source amount or target amount (not both)\nERROR_GETTING_CUSTOMER_PAYMENT_METHOD = Error retrieving customer payment method\nERROR_GETTING_BENEFICIARY_PAYMENT_METHOD = Error retrieving beneficiary payment method\nERROR_GETTING_OFFRAMP_QUOTE = Error retrieving off-ramp quote\nERROR_GETTING_RFQ_QUOTE = Error retrieving RFQ quote \n/------------------------------------------------------------------/\n/offramp_document:\nINVALID_DATA_FORMAT = Invalid data format\nUNSUPPORTED_FILE_TYPE = Unsupported file type\n/------------------------------------------------------------------/\n/get_offramp_in1888:\n(Route not implemented)\n/------------------------------------------------------------------/\n/set_webhook:\nMISSING_URL_PARAM = URL parameter not provided\nREQUEST_FAILED = Request failed\nINVALID_RESPONSE = Invalid response\n/------------------------------------------------------------------/\n/get_webhook_config:\nREQUEST_FAILED = Request failed\nINVALID_RESPONSE = Invalid response\n\nStructure of error json
\nAll string fields in the Payments API use the UTF-8 encoding standard.
\nThe following special characters are not permitted in string-type fields in any of the Payments API endpoints:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Environments (Sandbox & Production)","slug":"environments-sandbox-production"},{"content":"API Error Codes (Centralized)","slug":"api-error-codes-centralized"},{"content":"Special Characters Restrictions - Payments API","slug":"special-characters-restrictions-payments-api"}],"owner":"25218294","collectionId":"b4802d14-999c-408a-bda2-04e7a34582f5","publishedId":"2sB3HhtNhy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-09-01T13:20:32.000Z"},"item":[{"name":"Sub Accounts","item":[{"name":"Get Subaccount","id":"0f7d8e8a-424a-4c7d-bfc7-bb257eb4c045","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.
\n","type":"text","uuid":"f263c99c-0a6f-434a-8887-92ad7c14612b"},{"key":"user_id","value":"1004","description":"(string, conditional): Subaccount Bity ID
\nNecessary to choose one of them: user_id or external_id
\n","type":"text","uuid":"e5551708-b9d4-4902-8fb4-fa6470028f26"},{"key":"force_token_renew","value":"false","description":"(boolean, required): Indicates whether to generate a new token or reuse the previous one.
Use \"true\" to force the generation of a new token, even if the previous one is still valid.
Use \"false\" to attempt using the existing token; if it has expired, a new token will be automatically generated.
(string, conditional): External identifier used to retrieve the subaccount’s data. One of the following must be provided: subacc_id or external_id.
\n","type":"text","uuid":"10771210-0f87-4b89-94ab-ad2ccc71ebdc","disabled":true}]},"url":"{{generalApiAddress}}/get_subacc","description":"Retrieve an authorization token for a subaccount, allowing operations to be performed on behalf of that subaccount. This enables partners to manage subaccount actions securely while using the main account credentials.
\nThe Get Subaccount endpoint generates or retrieves a token for a specific subaccount linked to a main account. The main account must provide a valid auth_token, and the subaccount can be identified either by its subacc_id or external_id. Clients can choose to renew the token (generate a new one) or reuse an existing valid token.
When querying or retrieving subaccount information, the API returns a JSON object with the following fields:
\nNote: This endpoint is still under development and may be subject to changes.
\n","urlObject":{"path":["get_subacc"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"2f01dda3-6e9a-435a-9705-849501d55b82","name":"Get Subaccount (Using user_id)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"f263c99c-0a6f-434a-8887-92ad7c14612b"},{"key":"user_id","value":"1004","description":"(string, conditional): Subaccount Bity ID\n\nNecessary to choose one of them: user_id or external_id","type":"text","uuid":"e5551708-b9d4-4902-8fb4-fa6470028f26"},{"key":"force_token_renew","value":"false","description":"(boolean, required): Indicates whether to generate a new token or reuse the previous one. \nUse \"true\" to force the generation of a new token, even if the previous one is still valid. \nUse \"false\" to attempt using the existing token; if it has expired, a new token will be automatically generated.","type":"text","uuid":"1ad28b0e-5f3e-4127-8c36-b4d9bbabb248"},{"key":"external_id","value":"a3f5b21e-98c2-4c6f-9d4b-2a5e1f5e8d90","description":"(string, conditional): External identifier used to retrieve the subaccount’s data. One of the following must be provided: subacc_id or external_id.","type":"text","uuid":"10771210-0f87-4b89-94ab-ad2ccc71ebdc","disabled":true}]},"url":"{{generalApiAddress}}/get_subacc"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 02 Dec 2025 11:34:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Server","value":"gocache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"user_id\": \"1004\",\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-d203f1k2af90\",\n \"email\": \"testbity@grr.la\",\n \"tax_id\": \"20687398010\",\n \"name\": \"Ewerton Teste\",\n \"social_name\": \"Ewerton Teste\",\n \"status\": \"ACTIVE\",\n \"phone\": \"+5582996195522\",\n \"countrycode\": null,\n \"auth_token\": \"{subacc_auth_token}\"\n}"},{"id":"6ba0605b-7a12-450e-b530-9019e87a621b","name":"Get Subaccount (Using external_id)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"f263c99c-0a6f-434a-8887-92ad7c14612b"},{"key":"user_id","value":"820","description":"(string, conditional): Subaccount Bity ID\n\nNecessary to choose one of them: user_id or external_id","type":"text","uuid":"e5551708-b9d4-4902-8fb4-fa6470028f26","disabled":true},{"key":"force_token_renew","value":"false","description":"(boolean, required): Indicates whether to generate a new token or reuse the previous one. \nUse \"true\" to force the generation of a new token, even if the previous one is still valid. \nUse \"false\" to attempt using the existing token; if it has expired, a new token will be automatically generated.","type":"text","uuid":"1ad28b0e-5f3e-4127-8c36-b4d9bbabb248"},{"key":"external_id","value":"a3f5b21e-98c2-4c6f-9d4b-2a5e1f5e8d90","description":"(string, conditional): External identifier used to retrieve the subaccount’s data. One of the following must be provided: subacc_id or external_id.","type":"text","uuid":"10771210-0f87-4b89-94ab-ad2ccc71ebdc"}]},"url":"{{generalApiAddress}}/get_subacc"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Fri, 21 Nov 2025 17:08:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"70"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"user_id\": \"1004\",\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-d203f1k2af90\",\n \"email\": \"testbity@grr.la\",\n \"tax_id\": \"20687398010\",\n \"name\": \"Ewerton Teste\",\n \"social_name\": \"Ewerton Teste\",\n \"status\": \"ACTIVE\",\n \"phone\": \"+5582996195522\",\n \"countrycode\": null,\n \"auth_token\": \"{subacc_auth_token}\"\n}"},{"id":"d3992527-7a82-4b64-afec-44f239f44701","name":"Error - Get Subaccount - INVALID SUBACC ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"f263c99c-0a6f-434a-8887-92ad7c14612b"},{"key":"user_id","value":"844","description":"(string, conditional): Subaccount Bity ID\n\nNecessary to choose one of them: user_id or external_id","type":"text","uuid":"e5551708-b9d4-4902-8fb4-fa6470028f26"},{"key":"force_token_renew","value":"false","description":"(boolean, required): Indicates whether to generate a new token or reuse the previous one. \nUse \"true\" to force the generation of a new token, even if the previous one is still valid. \nUse \"false\" to attempt using the existing token; if it has expired, a new token will be automatically generated.","type":"text","uuid":"1ad28b0e-5f3e-4127-8c36-b4d9bbabb248"},{"key":"external_id","value":"a3f5b21e-98c2-4c6f-9d4b-d203f1k2af90","description":"(string, conditional): External identifier used to retrieve the subaccount’s data. One of the following must be provided: subacc_id or external_id.","type":"text","uuid":"10771210-0f87-4b89-94ab-ad2ccc71ebdc","disabled":true}]},"url":"{{generalApiAddress}}/get_subacc"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 03 Dec 2025 01:03:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"INVALID_SUBACC_ID\"\n}"}],"_postman_id":"0f7d8e8a-424a-4c7d-bfc7-bb257eb4c045"},{"name":"Get Related Accounts","id":"edf4a4f7-698e-4cc3-9b57-5b5fab0aa728","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.
\n","type":"text","uuid":"a16fb668-f87b-4bdc-b8a6-70bdaaf4e9ef"},{"key":"user_id","value":"844","description":"(string, required): Main account Id
\n","type":"text","uuid":"ee67b6ee-2215-4e2b-b11c-623d50a8a296"}]},"url":"{{generalApiAddress}}/get_related_accounts","description":"Retrieve all accounts related to the provided auth_token, including the main account (parent) and its subaccounts (children or siblings).
This endpoint returns detailed information about the accounts tied to the authenticated user, such as email, tax ID, legal name, and social name. It also specifies the relation type (main or subacc) for each account. The operation is read-only and helps manage and visualize the account hierarchy.
Note: This endpoint is stable and intended for account management use cases.
\n","urlObject":{"path":["get_related_accounts"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"54cfcf06-800c-403d-b3ed-c9a3983a116e","name":"Success - Get Related Accounts","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"a16fb668-f87b-4bdc-b8a6-70bdaaf4e9ef"},{"key":"user_id","value":"844","description":"String. Main account Id","type":"text","uuid":"ee67b6ee-2215-4e2b-b11c-623d50a8a296"}]},"url":"{{generalApiAddress}}/get_related_accounts"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 13 Oct 2025 12:35:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Server","value":"gocache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"844\",\n \"email\": \"ewerton@grr.la\",\n \"tax_id\": \"02852397080\",\n \"name\": \"Ewerton\",\n \"social_name\": \"Ewerton Main Account\",\n \"subacc_type\": \"main\"\n },\n {\n \"id\": \"1004\",\n \"email\": \"testbity@grr.la\",\n \"tax_id\": \"20687398010\",\n \"name\": \"Ewerton Teste\",\n \"social_name\": \"Ewerton Teste\",\n \"subacc_type\": \"subacc\",\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2a5e1f5e8d90\"\n },\n {\n \"id\": \"1571\",\n \"email\": \"oijtyzmx@subacc.bity.com.br\",\n \"tax_id\": \"19560012045\",\n \"name\": \"Ewerton\",\n \"social_name\": \"Ewerton\",\n \"subacc_type\": \"subacc\",\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2a5e1d5e8d34\"\n },\n {\n \"id\": \"1573\",\n \"email\": \"8hgkahpz@subacc.bity.com.br\",\n \"tax_id\": \"23930319000111\",\n \"name\": \"Ewerton\",\n \"social_name\": \"Ewerton Cnpj\",\n \"subacc_type\": \"subacc\",\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-d203f1k2af90\"\n },\n {\n \"id\": \"1574\",\n \"email\": \"oep7cfdl@subacc.bity.com.br\",\n \"tax_id\": \"68923708000158\",\n \"name\": \"Ewerton\",\n \"social_name\": \"Ewerton\",\n \"subacc_type\": \"subacc\"\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-23ad24f0f1d01\"\n },\n {\n \"id\": \"1592\",\n \"email\": \"rdqa1on3@subacc.bity.com.br\",\n \"tax_id\": \"63453238028\",\n \"name\": \"João da Silva\",\n \"social_name\": \"João Subacc\",\n \"subacc_type\": \"subacc\",\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2fda12dk931dk\"\n },\n {\n \"id\": \"1593\",\n \"email\": \"pzqbxrur@subacc.bity.com.br\",\n \"tax_id\": \"09379676026\",\n \"name\": \"Maria da Silva\",\n \"social_name\": \"Maria Subacc\",\n \"subacc_type\": \"subacc\",\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2adkaf93d1d92\"\n }\n ]\n}"}],"_postman_id":"edf4a4f7-698e-4cc3-9b57-5b5fab0aa728"},{"name":"Create Subaccount","id":"9d157e27-fe65-4cb2-96d5-23504f38bc7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.
\n","type":"text","uuid":"f263c99c-0a6f-434a-8887-92ad7c14612b"},{"key":"data","value":"{\"name\":\"Maria da Silva\",\"email\":\"\",\"tax_id\":\"09379676026\",\"social_name\":\"Maria Subacc\",\"company\":0,\"gender\":\"F\",\"birth_date\":\"1979-05-20\",\"address\":\"Rua Noé Angelim, Centro, 3423, \",\"city\":\"Algodões\",\"state\":\"CE\",\"postalcode\":\"63655973\",\"countrycode\":\"BR\",\"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2a5e1f5e8d90\"}","description":"(string, required): Contains all required information to create a subaccount, including name, tax ID, address, company type, and optionally email. For individuals (PF), birth is required; for companies (PJ), the responsible person’s tax ID may be provided.
\n","type":"text","uuid":"621c7089-a331-4372-9860-69ea54c544cd"}]},"url":"{{generalApiAddress}}/subacc_create","description":"Create a new subaccount linked to the main account identified by the auth_token. This allows partners to manage multiple accounts under a single main account, enabling better separation of operations and balances.
The Subaccount Create endpoint enables the creation of a new subaccount associated with a main account, provided that the main account has the required configuration flag (CREATE_ACCOUNTS) allowing subaccount creation. To have the required flag, please contact Bity's team.
Additional rules:
\nIf the subaccount does not belong to a company (e.g., it is a natural person, PF), the birth field is required.
If the subaccount belongs to a legal entity (PJ), the validated tax ID of the responsible person may also be provided.
\nemail can be specified, otherwise a random email will be generated.
password must not be provided; users should recover it later if needed.
When testing in the staging environment, the tax_id must be an even number. Odd-numbered tax IDs are not accepted in staging.
This endpoint ensures flexibility for partners by supporting both individuals and companies while maintaining security and compliance with Bity’s ecosystem.
\nThe data parameter is a JSON object containing the following fields when creating a subaccount:
When a subaccount is successfully created, the API returns a JSON object containing the following fields:
\nThese message codes indicate the compliance result after creating the subaccount:
\nNote: All error message codes that may be returned by this endpoint can be found in the Error Codes section of the documentation.
\n","urlObject":{"path":["subacc_create"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"787389d1-7e56-4b87-9372-ede3647d7fa1","name":"Success - Create Subaccount","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"f263c99c-0a6f-434a-8887-92ad7c14612b"},{"key":"user_id","value":"844","description":"(string, required): ID of the main account to which the subaccount will be linked.","type":"text","uuid":"0122e78d-e443-427a-a0a6-7516355f6601"},{"key":"data","value":"{\"name\":\"Maria da Silva\",\"email\":\"\",\"tax_id\":\"09379676026\",\"social_name\":\"Maria Subacc\",\"account_type\":\"physical\",\"company\":0,\"gender\":\"F\",\"birth_date\":\"1979-05-20\",\"company_director\":\"\",\"address\":\"Rua Noé Angelim, Centro, 3423, \",\"city\":\"Algodões\",\"state\":\"CE\",\"postalcode\":\"63655973\",\"observation\":\"Teste\",\"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2a5e1f5e8d90\"}","description":"(string, required): Contains all required information to create a subaccount, including name, tax ID, address, company type, and optionally email. For individuals (PF), birth is required; for companies (PJ), the responsible person’s tax ID may be provided.","type":"text","uuid":"621c7089-a331-4372-9860-69ea54c544cd"}]},"url":"{{generalApiAddress}}/subacc_create"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 13 Oct 2025 12:30:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message_cod\": \"KYC_PRE_APPROVED\",\n \"referrer\": null,\n \"user_id\": \"1593\",\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2a5e1f5e8d90\"\n}"},{"id":"8e2fe0ca-65ef-4ec3-bd5f-4251256d3b1b","name":"Error - Create Subaccount - MISSING DATA","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"f263c99c-0a6f-434a-8887-92ad7c14612b"},{"key":"data","value":"{\"email\":\"\",\"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2a5e1f5e8d90\"}","description":"(string, required): Contains all required information to create a subaccount, including name, tax ID, address, company type, and optionally email. For individuals (PF), birth is required; for companies (PJ), the responsible person’s tax ID may be provided.","type":"text","uuid":"621c7089-a331-4372-9860-69ea54c544cd"}]},"url":"{{generalApiAddress}}/subacc_create"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 03 Dec 2025 01:05:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"113"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"MISSING_DATA\",\n \"missing\": [\n \"name\",\n \"address\",\n \"city\",\n \"state\",\n \"postalcode\",\n \"company\"\n ]\n}"},{"id":"c736f7f3-7ec9-4c95-9ad7-404bc88a027b","name":"Error - Create Subaccount- WAIT TO CREATE NEW SUBACC","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"f263c99c-0a6f-434a-8887-92ad7c14612b"},{"key":"data","value":"{\"name\":\"Maria da Silva\",\"email\":\"maria@grr.la\",\"tax_id\":\"09379676026\",\"social_name\":\"Maria Subacc\",\"company\":0,\"gender\":\"F\",\"birth_date\":\"1979-0-20\",\"address\":\"Rua Noé Angelim, Centro, 3423, \",\"city\":\"Algodões\",\"state\":\"CE\",\"postalcode\":\"63655973\",\"countrycode\":\"BR\",\"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2a5e1f5e8d90\"}","description":"(string, required): Contains all required information to create a subaccount, including name, tax ID, address, company type, and optionally email. For individuals (PF), birth is required; for companies (PJ), the responsible person’s tax ID may be provided.","type":"text","uuid":"621c7089-a331-4372-9860-69ea54c544cd"}]},"url":"{{generalApiAddress}}/subacc_create"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 03 Dec 2025 01:08:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"59"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"WAIT_TO_CREATE_NEW_SUBACC\"\n}"}],"_postman_id":"9d157e27-fe65-4cb2-96d5-23504f38bc7d"},{"name":"Subaccount Transfer","id":"ed6eb2ae-c3b6-47ae-b0e2-298703d24ac4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.
\n","type":"text","uuid":"51635723-7ff0-4b89-b522-5209a94227a7"},{"key":"from","value":"1004","description":"(string, required): ID of the account (main or sub) from which the currency will be transferred.
\n","type":"text","uuid":"785eedce-16bf-4113-bb30-7091f7487589"},{"key":"to","value":"844","description":"(string, required): ID of the account (main or sub) to receive the currency.
\n","type":"text","uuid":"38c32caf-fcc4-43a9-9ec1-1a9290773c05"},{"key":"currency","value":"BRL","description":"(string, required): Currency symbol to transfer (e.g., BTC, USDC, ETH, USDT, etc).
\n","type":"text","uuid":"c937441b-4e52-4fea-95c1-9a242cf72a9f"},{"key":"amount","value":"50","description":"(string, required): Amount of the currency to transfer
\n","type":"text","uuid":"adde00c3-7b8d-4464-8c72-f864f20978d2"}]},"url":"{{generalApiAddress}}/subaccount_transfer","description":"Transfer a specific currency between subaccounts or between a subaccount and the main account. Only the main account can perform this operation.
\nThis endpoint moves funds securely and allows controlled transfers within the account hierarchy. Additionally, requires the main account to have the necessary flag enabled to permit transfers.
\nNote: This endpoint is still under development and may be subject to changes.
\n","urlObject":{"path":["subaccount_transfer"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"020f71f5-6912-47df-a696-445cdbe8733c","name":"Success - Subaccount Transfer","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"51635723-7ff0-4b89-b522-5209a94227a7"},{"key":"from","value":"1004","description":"(string, required): ID of the account (main or sub) from which the currency will be transferred.","type":"text","uuid":"785eedce-16bf-4113-bb30-7091f7487589"},{"key":"to","value":"844","description":"(string, required): ID of the account (main or sub) to receive the currency.","type":"text","uuid":"38c32caf-fcc4-43a9-9ec1-1a9290773c05"},{"key":"currency","value":"BRL","description":"(string, required): Currency symbol to transfer (e.g., BTC, USDC, ETH, USDT, etc).","type":"text","uuid":"c937441b-4e52-4fea-95c1-9a242cf72a9f"},{"key":"amount","value":"40","description":"(string, required): Amount of the currency to transfer","type":"text","uuid":"adde00c3-7b8d-4464-8c72-f864f20978d2"}]},"url":"{{generalApiAddress}}/subaccount_transfer"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 13 Oct 2025 14:37:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"190c2325-6bdb-4087-adec-24d49c201dd5","name":"Error - Insufficient Funds","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"51635723-7ff0-4b89-b522-5209a94227a7"},{"key":"from","value":"1004","description":"(string, required): ID of the account (main or sub) from which the currency will be transferred.","type":"text","uuid":"785eedce-16bf-4113-bb30-7091f7487589"},{"key":"to","value":"844","description":"(string, required): ID of the account (main or sub) to receive the currency.","type":"text","uuid":"38c32caf-fcc4-43a9-9ec1-1a9290773c05"},{"key":"currency","value":"BRL","description":"(string, required): Currency symbol to transfer (e.g., BTC, USDC, ETH, USDT, etc).","type":"text","uuid":"c937441b-4e52-4fea-95c1-9a242cf72a9f"},{"key":"amount","value":"50","description":"(string, required): Amount of the currency to transfer","type":"text","uuid":"adde00c3-7b8d-4464-8c72-f864f20978d2"}]},"url":"{{generalApiAddress}}/subaccount_transfer"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 13 Oct 2025 14:43:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"158"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"INSUFFICIENT_FUNDS_TO_TRANSFER\",\n \"from\": \"1004\",\n \"to\": \"844\",\n \"currency\": \"BRL\",\n \"available\": \"40000000\",\n \"requested\": 50000000,\n \"fee\": 0\n}"}],"_postman_id":"ed6eb2ae-c3b6-47ae-b0e2-298703d24ac4"},{"name":"Subaccount Change Status","id":"c7e2efeb-af06-46f7-b3b4-8a10850b60ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.
\n","type":"text","uuid":"093490b4-b32d-41f2-bd23-d734becb233f"},{"key":"user_id","value":"444","description":"(string, required): ID of the subaccount whose status will be changed.
\n","type":"text","uuid":"ad0bd1a2-58c6-4fbf-9211-7047c3e6a8ae"},{"key":"new_status","value":"CANCELED","description":"(string, required): New status of the subaccount. Allowed values: \"active\", \"blocked\", \"canceled\".
\n","type":"text","uuid":"385de2c0-cf8b-480d-a961-ef5023c71a60"},{"key":"obs","value":"Doing some test","description":"(string, required): Reason of the change
\n","type":"text","uuid":"95f0c150-3526-47f5-affe-e91c7c2b5790"}]},"url":"{{generalApiAddress}}/subacc_change_status","description":"Change the status of a subaccount to blocked, active, or canceled. Only the main account can perform this operation if allowed, and certain subaccounts may restrict this control.
The Subaccount Change Status endpoint enables the main account to modify the status of a subaccount, provided it has the necessary flag. Some subaccounts may have a flag that prevents the main account from changing their status, ensuring that Bity can override or lock specific subaccounts when needed. This mechanism ensures secure and controlled management of subaccount statuses.
\nWhen performing an operation related to account status update, the API may return the following response:
\nThese message codes indicate the compliance result after creating the subaccount:
\nNote: All error message codes that may be returned by this endpoint can be found in the Error Codes section of the documentation.
\nNote: This endpoint is still under development and may be subject to changes.
\n","urlObject":{"path":["subacc_change_status"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"861df77b-68b4-46c0-8b2d-45db196c2407","name":"ACTIVE - Subaccount Change Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"093490b4-b32d-41f2-bd23-d734becb233f"},{"key":"user_id","value":"1004","description":"(string, required): ID of the subaccount whose status will be changed.","type":"text","uuid":"ad0bd1a2-58c6-4fbf-9211-7047c3e6a8ae"},{"key":"new_status","value":"ACTIVE","description":"(string, required): New status of the subaccount. Allowed values: \"active\", \"blocked\", \"canceled\".","type":"text","uuid":"385de2c0-cf8b-480d-a961-ef5023c71a60"},{"key":"obs","value":"Doing some test","description":"(string, required): Reason of the change","type":"text","uuid":"95f0c150-3526-47f5-affe-e91c7c2b5790"}]},"url":"{{generalApiAddress}}/subacc_change_status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 14 Jan 2026 13:47:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"76859f5d-066d-4f5e-9057-cd2536a38b3c","name":"BLOCKED - Subaccount Change Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"093490b4-b32d-41f2-bd23-d734becb233f"},{"key":"user_id","value":"1004","description":"(string, required): ID of the subaccount whose status will be changed.","type":"text","uuid":"ad0bd1a2-58c6-4fbf-9211-7047c3e6a8ae"},{"key":"new_status","value":"BLOCKED","description":"(string, required): New status of the subaccount. Allowed values: \"active\", \"blocked\", \"canceled\".","type":"text","uuid":"385de2c0-cf8b-480d-a961-ef5023c71a60"},{"key":"obs","value":"Doing some test","description":"(string, required): Reason of the change","type":"text","uuid":"95f0c150-3526-47f5-affe-e91c7c2b5790"}]},"url":"{{generalApiAddress}}/subacc_change_status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 14 Jan 2026 13:47:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"0828cb4b-87f3-46b5-99b4-a2bebfc1da2c","name":"CANCELED - Subaccount Change Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"093490b4-b32d-41f2-bd23-d734becb233f"},{"key":"user_id","value":"1004","description":"(string, required): ID of the subaccount whose status will be changed.","type":"text","uuid":"ad0bd1a2-58c6-4fbf-9211-7047c3e6a8ae"},{"key":"new_status","value":"CANCELED","description":"(string, required): New status of the subaccount. Allowed values: \"active\", \"blocked\", \"canceled\".","type":"text","uuid":"385de2c0-cf8b-480d-a961-ef5023c71a60"},{"key":"obs","value":"Doing some test","description":"(string, required): Reason of the change","type":"text","uuid":"95f0c150-3526-47f5-affe-e91c7c2b5790"}]},"url":"{{generalApiAddress}}/subacc_change_status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 14 Jan 2026 13:47:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"9a45332a-fe7d-4b0f-92aa-3b2d022bd784","name":"Error - Invalid Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"093490b4-b32d-41f2-bd23-d734becb233f"},{"key":"user_id","value":"444","description":"(string, required): ID of the subaccount whose status will be changed.","type":"text","uuid":"ad0bd1a2-58c6-4fbf-9211-7047c3e6a8ae"},{"key":"new_status","value":"PENDING","description":"(string, required): New status of the subaccount. Allowed values: \"active\", \"blocked\", \"canceled\".","type":"text","uuid":"385de2c0-cf8b-480d-a961-ef5023c71a60"},{"key":"obs","value":"Doing some test","description":"(string, required): Reason of the change","type":"text","uuid":"95f0c150-3526-47f5-affe-e91c7c2b5790"}]},"url":"{{generalApiAddress}}/subacc_change_status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 14 Jan 2026 13:46:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"48"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"INVALID_STATUS\"\n}"},{"id":"ad4f5733-cd5b-4c57-9563-874f78899647","name":"Error - Main Account Cant Change Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"093490b4-b32d-41f2-bd23-d734becb233f"},{"key":"user_id","value":"1004","description":"(string, required): ID of the subaccount whose status will be changed.","type":"text","uuid":"ad0bd1a2-58c6-4fbf-9211-7047c3e6a8ae"},{"key":"new_status","value":"ACTIVE","description":"(string, required): New status of the subaccount. Allowed values: \"active\", \"blocked\", \"canceled\".","type":"text","uuid":"385de2c0-cf8b-480d-a961-ef5023c71a60"},{"key":"obs","value":"Doing some test","description":"(string, required): Reason of the change","type":"text","uuid":"95f0c150-3526-47f5-affe-e91c7c2b5790"}]},"url":"{{generalApiAddress}}/subacc_change_status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 13 Oct 2025 14:54:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"MAIN_ACCOUNT_CANT_CHANGE_STATUS\"\n}"},{"id":"9db918d5-6cb1-4a98-91b2-9db2b6ab1942","name":"Error - Not Subacc of Main","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): Authentication token of the main account.","type":"text","uuid":"093490b4-b32d-41f2-bd23-d734becb233f"},{"key":"user_id","value":"844","description":"(string, required): ID of the subaccount whose status will be changed.","type":"text","uuid":"ad0bd1a2-58c6-4fbf-9211-7047c3e6a8ae"},{"key":"new_status","value":"ACTIVE","description":"(string, required): New status of the subaccount. Allowed values: \"active\", \"blocked\", \"canceled\".","type":"text","uuid":"385de2c0-cf8b-480d-a961-ef5023c71a60"},{"key":"obs","value":"Doing some test","description":"(string, required): Reason of the change","type":"text","uuid":"95f0c150-3526-47f5-affe-e91c7c2b5790"}]},"url":"{{generalApiAddress}}/subacc_change_status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 13 Oct 2025 14:55:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"52"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"NOT_SUBACC_OF_MAIN\"\n}"}],"_postman_id":"c7e2efeb-af06-46f7-b3b4-8a10850b60ba"},{"name":"Get Subaccount Transactions","id":"73373194-89a0-4faa-9ab8-299e425a895e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string & required): This token is generated via the subacc_get_token endpoint and must be provided in the request to authenticate access.
\n","type":"text"},{"key":"currency","value":"!, BTC","description":"(string & optional): Accepts one of [BTC, BRL].\nPrefix with \"!\" to exclude a currency.
Example: [!, BTC, ETH] returns all transactions except BTC and ETH.
(string & optional): Accepts one of [BUY, SELL, DEPOSIT, WITHDRAWAL, CREDIT, DEBIT, SUBACC_CREDIT, SUBACC_DEBIT].
Prefix with \"!\" to exclude a type.
Example: [!, DEPOSIT, CREDIT] returns all transactions except DEPOSIT and CREDIT.
(string & optional): One of [PENDING, COMPLETE, CANCELED, WAITING_2FA, ERROR, BLOCKED]\nPrefix with \"!\" to exclude a status.\nExample:[!, PENDING, COMPLETE] will return all transactions except those PENDING and COMPLETE.
\n","type":"text"},{"key":"from","value":"2025-11-16 19:58:31","description":"(string & optional): Filter transactions from this date onward (ISO 8601 format).
\nExample: 2025-01-01T00:00:00Z
\n","type":"text"},{"key":"to","value":"2025-11-27 19:58:32","description":"(string & optional): Filter transactions up to this date (ISO 8601 format).\nExample: 2025-01-31T23:59:59Z
\n","type":"text"},{"key":"user_ids","value":"[1626]","description":"(array string & optional): List of related user accounts from which to fetch transactions. If not provided, the endpoint will fetch transactions for all related accounts, including the main account.
\n","type":"text","uuid":"5d6572e1-86b5-47a6-abf8-d56b3ed8792a"}]},"url":"{{generalApiAddress}}/subacc_transactions","description":"Retrieve the transaction history of the user’s wallet. This allows partners to track deposits, withdrawals, trades, and other movements across different assets.
\nThe Transactions endpoint provides a detailed and real-time view of all operations originated from the user’s wallet. Results can be filtered by optional parameters such as currency, type, status, start date (from), and end date (to). If no filters are applied, the endpoint returns the complete history of transactions. By default, the values for currency, type, and status are set to ALL, meaning no filtering is applied. This helps partners monitor account activity, reconcile balances, and analyze historical movements efficiently.
The Sub Accounts functionality allows a main account to create and manage multiple subaccounts, enabling better organization and control over different units, users, or operations while maintaining centralized oversight.
\nWith this functionality, it is possible to:
\nGet all the user's sub-account information using get_subacc
Create subaccounts for individuals (PF) or companies (PJ), providing flexibility in user management.
\nPerform secure fund transfers between subaccounts or between a subaccount and the main account (subacc_transfer).
\nControl subaccount status (active, blocked, canceled) with rules to restrict or grant the main account’s ability to modify status (subacc_change_status).
\nMaintain compliance, traceability, and governance while enabling operational scalability.
\nAdditional notes:
\nNote: More endpoints will be added over time to expand subaccount functionality.
\n","_postman_id":"1dcb047f-5591-4b77-9229-f3ebfede8e9f"},{"name":"Exchange/FX","item":[{"name":"Get Order Quote","event":[{"listen":"test","script":{"id":"f462a67b-44d2-4a44-956b-6a36b96db07a","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"04de213e-fd16-411d-b1c1-6781cc3fe488","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"24bb0f7e-6b69-453d-a63d-07e3cc9c940c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): If it is a subaccount, this token is generated via the get_subacc endpoint and must be provided in the request to authenticate access.
\n","type":"text"},{"key":"type","value":"BUY","description":"(string, required): Specifies the type of order.
One of [BUY, SELL].
Example: BUY → retrieves a quote for buying the asset.
(string, required): Specifies the market pair: BTC-BRL, ETH-BRL\nExample: BTC-BRL → Bitcoin to Brazilian Real.
\n","type":"text"},{"key":"base_amount","value":"0.01","description":"(number, optional): Quantity in the base token.
\nExample: 0.01 → 0.01 BTC in the BTC-BRL market.
\nbase_amount and quote_amount cannot be sent simultaneously.
\n","type":"text","disabled":true},{"key":"quote_amount","value":"100.23","description":"(number, optional): Quantity in the quote currency.
\nNote: base_amount and quote_amount cannot be sent simultaneously.
\nNote: When the amount refers to a fiat currency, specific precision rules apply:
\nFor BRL (base fiat currency): values must use 2 decimal places.\nExample: 1500.75 → represents R$1500.75\nExample: 20.00 → represents R$20.00
\nFor USD: values must use 4 decimal places.\nExample: 15.1234 → represents US$15.1234\nExample: 0.5000 → represents US$0.5000
\nRetrieve a real-time quote for buying or selling a specific cryptocurrency pair. This allows partners to see the expected rates before executing a trade.
\nThe Get Order Quote endpoint provides a fast and secure way to obtain a market quote within the Bity ecosystem. It supports specifying the market pair, the trade type (BUY or SELL), and the desired amount either in the base currency or the quote currency. An optional source parameter allows selecting the origin of the quote (express, easybuy, orderbook, converter).
\n(string, required): If it is a subaccount, this token is generated via the get_subacc endpoint and must be provided in the request to authenticate access.
\n","type":"text"},{"key":"quote_id","value":"omMGoRtkZmL5Ywt3AwN1ZQH3AmRgZQV4","description":"(string, conditional): ID generated on Get Order Quote
\nNote: Must be provided one of them: quote_id or external_id
\n","type":"text","disabled":true},{"key":"base_amount","value":"0.00484003","description":"(string, optional): Quantity in the base token to execute part of quote\nDefault: null.
Example: 0.01 → executes the quote for 0.01 BTC in the BTC-BRL market.
(string, conditional): Allows partners to associate their own external identifier with the executed order.
\nNote: Must be provided one of them: external_id or quote_id
\n","type":"text","uuid":"c7d327dc-4870-4456-9caf-f048de55dbb5"}]},"url":"{{generalApiAddress}}/execute_quote","description":"Execute a previously generated quote to create an actual trade on the platform. Partners can execute the full amount or only a partial portion of the quote.
\nThe Execute Quote endpoint allows partners to convert a quote obtained from Get Order Quote into a real trade. It requires the quote_id and optionally accepts base_amount if only part of the quote should be executed. The endpoint returns details of the executed trade, including amounts in base and quote currencies, the executed price, and the order status.
\nThe message_code field in the response will contain one of the following status codes:
Note: All error message codes that may be returned by this endpoint can be found in the Error Codes section of the documentation.
\n","urlObject":{"path":["execute_quote"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"6fefb5ca-51ff-4f25-a513-23fa16ef6c95","name":"Success - Execute Order Quote","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): This token is generated via the subacc_get_token endpoint and must be provided in the request to authenticate access.","type":"text"},{"key":"quote_id","value":"qSc2E3t2BGRjYwR4BGZlBQH2AmRgAQD4","description":"(string, conditional): ID generated on Get Order Quote\n\nNote: Must be provided one of them: quote_id or external_id","type":"text"},{"key":"base_amount","value":"0.00484003\n","description":"(string, optional): Quantity in the base token to execute part of quote\n\nDefault: null. \n\nExample: 0.01 → executes the quote for 0.01 BTC in the BTC-BRL market.","type":"text","disabled":true},{"key":"external_id","value":"a3f5b21e-98c2-4c6f-9d4b-2adkaf93d1d99","description":"(string, conditional): Allows partners to associate their own external identifier with the executed order.\n\nNote: Must be provided one of them: external_id or quote_id","type":"text","uuid":"60405629-bcfe-4273-94e4-07df75ba53c7"}]},"url":"{{publicTradingApi}}/execute_quote"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Sep 2025 16:24:41 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"226"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"order_id\": \"10051832147\",\n \"amount\": 18.43513767,\n \"exec_amount\": 18.43513767,\n \"type\": \"BUY\",\n \"market\": \"USDT-BRL\",\n \"price\": 5.4368999999999996,\n \"timestamp\": \"2025-12-15 15:39:46\",\n \"tag\": \"a3f5b21e-98c2-4c6f-9d4b-2adkaf93d1d99\",\n \"fee\": 0.23965678000000001,\n \"message_cod\": \"ORDER_FULLY_EXECUTED\"\n}"},{"id":"c071ada5-31cc-4c47-aac2-a1ba6d513387","name":"Error - Execute Order Quote - QUOTE EXPIRED OR NOT FOUND","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): If it is a subaccount, this token is generated via the get_subacc endpoint and must be provided in the request to authenticate access.","type":"text"},{"key":"quote_id","value":"JIO5Ezb3ZGN3Ywt0ZGH0BQL1AmRgAQNjZD","description":"(string, conditional): ID generated on Get Order Quote\n\nNote: Must be provided one of them: quote_id or external_id","type":"text"},{"key":"base_amount","value":"0.00484003\n","description":"(string, optional): Quantity in the base token to execute part of quote\nDefault: null. \nExample: 0.01 → executes the quote for 0.01 BTC in the BTC-BRL market.","type":"text","disabled":true},{"key":"external_id","value":"a3f5b21e-98c2-4c6f-9d4b-2adkaf93d1d92","description":"(string, conditional): Allows partners to associate their own external identifier with the executed order.\n\nNote: Must be provided one of them: external_id or quote_id","type":"text","uuid":"c7d327dc-4870-4456-9caf-f048de55dbb5"}]},"url":"{{generalApiAddress}}/execute_quote"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 03 Dec 2025 01:36:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"60"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"QUOTE_EXPIRED_OR_NOT_FOUND\"\n}"},{"id":"574ec0be-c760-4302-b2ed-f1b2ba02005d","name":"Error - Execute Order Quote - AMOUNT BIGGER THAN QUOTED","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): If it is a subaccount, this token is generated via the get_subacc endpoint and must be provided in the request to authenticate access.","type":"text"},{"key":"quote_id","value":"IUy5F1D2ZwD1YwL4BQHlAmD2AmRgAQD4","description":"(string, conditional): ID generated on Get Order Quote\n\nNote: Must be provided one of them: quote_id or external_id","type":"text"},{"key":"base_amount","value":"0.004","description":"(string, optional): Quantity in the base token to execute part of quote\nDefault: null. \nExample: 0.01 → executes the quote for 0.01 BTC in the BTC-BRL market.","type":"text"},{"key":"external_id","value":"a3f5b21e-98c2-4c6f-9d4b-2adkaf93d1d92","description":"(string, conditional): Allows partners to associate their own external identifier with the executed order.\n\nNote: Must be provided one of them: external_id or quote_id","type":"text","uuid":"c7d327dc-4870-4456-9caf-f048de55dbb5","disabled":true}]},"url":"{{generalApiAddress}}/execute_quote"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 03 Dec 2025 01:38:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"110"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"AMOUNT_BIGGER_THAN_QUOTED\",\n \"quoted\": 0.0030388300000000002,\n \"requested\": \"0.004\"\n}"},{"id":"f28547f6-aff4-437d-b11b-812e57fedecf","name":"Erro - Execute Order Quote - NOT_ENOGH_USER_BALANCE","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): If it is a subaccount, this token is generated via the get_subacc endpoint and must be provided in the request to authenticate access.","type":"text"},{"key":"quote_id","value":"H3OFpRR3ZGtmYwtjZmRkBQH2AmRgAQD4","description":"(string, conditional): ID generated on Get Order Quote\n\nNote: Must be provided one of them: quote_id or external_id","type":"text"},{"key":"base_amount","value":"0.00484003\n","description":"(string, optional): Quantity in the base token to execute part of quote\nDefault: null. \nExample: 0.01 → executes the quote for 0.01 BTC in the BTC-BRL market.","type":"text","disabled":true},{"key":"external_id","value":"a3f5b21e-98c2-4c6f-9d4b-2adkaf93d1d98","description":"(string, conditional): Allows partners to associate their own external identifier with the executed order.\n\nNote: Must be provided one of them: external_id or quote_id","type":"text","uuid":"c7d327dc-4870-4456-9caf-f048de55dbb5"}]},"url":"{{generalApiAddress}}/execute_quote"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 15 Dec 2025 15:08:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"147"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"NOT_ENOUGH_USER_BALANCE\",\n \"function\": \"RFQ\",\n \"user_balance\": \"384368590\",\n \"user_locked\": \"176000000\",\n \"needed\": 1500750000\n}"}],"_postman_id":"183445ea-eef9-48ec-933f-01f0e59830cd"},{"name":"Order Status","id":"2f2fe8f2-2990-4a0a-be62-dbfa51d1fbaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): This token is generated via the subacc_get_token endpoint and must be provided in the request to authenticate access.
\n","type":"text"},{"key":"order_id","value":"{order_id}","description":"(string, conditional): The unique identifier of the order whose status you want to retrieve
\nNote: Must be provided one of them: order_id or external_id
\n","type":"text","disabled":true},{"key":"external_id","value":"a3f5b21e-98c2-4c6f-9d4b-2adkaf93d1d99","description":"(string, optional): External identifier used to retrieve the status of an order.
\nNote: Must be provided one of them: external_id or order_id
\n","type":"text","uuid":"e6a45c63-90e3-4c2d-a41d-3d3198e8efed"}]},"url":"{{generalApiAddress}}/order_status","description":"Endpoint purpose:
\nRetrieve the current status of a previously executed order. This allows partners to track whether the order has been completed, is still processing, or has failed.
\nDescription:
\nThe Order Status endpoint enables partners to check the real-time status of an order created through the Execute Quote endpoint. It requires the order_id, which uniquely identifies the order whose status is being queried. The endpoint returns detailed information about the order, including its current status, timestamps, involved currencies, amounts, and any relevant execution details.
(string, required): If it is a subaccount, this token is generated via the get_subacc endpoint and must be provided in the request to authenticate access.
\n","type":"text"},{"key":"currency","value":"BRL","description":"(string, optional): Prefix with \"!\" to exclude a currency.
Example: [!, BTC, ETH] returns all transactions except BTC and ETH.
(string, required): Accepts one of [BUY, SELL, DEPOSIT, WITHDRAWAL, CREDIT, DEBIT, PAYMENT].
Prefix with \"!\" to exclude a type.
Example: [!, DEPOSIT, CREDIT] returns all transactions except DEPOSIT and CREDIT.
(string, optional): Accepts one of [PENDING, COMPLETE, CANCELED, WAITING_2FA, ERROR, BLOCKED]\nPrefix with \"!\" to exclude a status.\nExample:[!, PENDING, COMPLETE] will return all transactions except those PENDING and COMPLETE.
\n","type":"text"},{"key":"from","value":"2025-07-24 08:28:31","description":"(string, optional): Filter transactions from this date onward (ISO 8601 format).
\nExample: 2025-01-01T00:00:00Z
\n","type":"text","disabled":true},{"key":"to","value":"2025-07-25 08:28:32","description":"(string, optional): Filter transactions up to this date (ISO 8601 format).\nExample: 2025-01-31T23:59:59Z
\n","type":"text","disabled":true}]},"url":"{{generalApiAddress}}/transactions","description":"Retrieve the transaction history of the user’. This allows partners to track deposits, withdrawals, trades, and other movements across different assets.
\nThe Transactions endpoint provides a detailed and real-time view of all operations originating from the user’s wallet.
\nIt supports optional filters for:
\ncurrency
\ntype
\nstatus
\ndate range (from and to)
If a filter is sent empty, it is interpreted as ALL for that specific filter.
\nThis behavior allows querying:
\na fully unfiltered history
\nor only filtering specific categories
\nPrefixing values with \"!\" enables exclusion-based filtering (NOT logic).
This endpoint is essential for:
\nReconciling balances
\nTracking user activity
\nAuditing deposits, withdrawals, and trades
\nMonitoring historical movements
\nType: string or list — optional
Default: \"\" → ALL types
Behavior:
\nEmpty value = ALL types
\nExclusion example: \"[!, DEPOSIT, CREDIT]\"
Type: string or list — optional
Default: \"\" → ALL statuses
Behavior:
\nEmpty value = ALL statuses
\nExclusion example: \"[!, PENDING, COMPLETE]\"
(string, required): The authentication token of the account used to authorize the request.
\n","type":"text","uuid":"7673b15c-2bce-4615-9a48-482e11f8219a"},{"key":"trans_id","value":"87519403","description":"(number, conditional): Unique identifier of the transaction to be retrieved.
\nNote: Must be provided one of them: trans_id or external_id
\n","type":"text","uuid":"5894b65f-5a94-4cd8-862d-e9c114892fbf","disabled":true},{"key":"external_id","value":"a3f5b21e-98c2-4c6f-9d4b-2adkaf93d1d99","description":"(string, conditional): External identifier assigned by the partner system to retrieve the transaction.
\nNote: Must be provided one of them: external_id or trans_id
\n","type":"text","uuid":"f839ee12-03cf-4d2b-a184-0ac11c8c0d29"}]},"url":"{{generalApiAddress}}/get_transaction","description":"Retrieve a single transaction using either its internal identifier (trans_id) or the partner-defined external identifier (external_id).
Only one of them must be provided.
\nRetrieves the full details of a specific transaction, allowing partners to query accurate information about operations previously created in the system.
\nThis endpoint is used to verify the status, amounts, identifiers, and metadata of an existing transaction — whether deposit, withdrawal, trade, or transfer — ensuring transparency and traceability within the Bity ecosystem.
\nEach returned transaction follows the same schema used in the Transactions list endpoint.
\ntype)Indicates the nature of the financial operation:
\nstatus)Represents the current processing state of the transaction:
\nNote: This endpoint is still under development and may be subject to changes.
\n","urlObject":{"path":["get_transaction"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"f6b0d9a0-e719-4aef-b0db-12e56c299337","name":"Success - Get Transaction - BRL & DEPOSIT","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"7673b15c-2bce-4615-9a48-482e11f8219a"},{"key":"trans_id","value":"4321","description":"(number, conditional): Unique identifier of the transaction to be retrieved.\n\nNote: Must be provided one of them: trans_id or external_id","type":"text","uuid":"5894b65f-5a94-4cd8-862d-e9c114892fbf"},{"key":"external_id","value":"a3f5b21e-98c2-4c6f-9d4b-2a5e1f5e8d90","description":"(string, conditional): External identifier assigned by the partner system to retrieve the transaction.\n\nNote: Must be provided one of them: trans_id or external_id","type":"text","uuid":"f839ee12-03cf-4d2b-a184-0ac11c8c0d29","disabled":true}]},"url":"https://api-sandbox.bitpreco.com/v1/get_transaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 19 Nov 2025 17:02:54 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"227"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"53860640\",\n \"created\": \"2023-03-03 09:23:40\",\n \"concluded\": \"2023-03-03 09:23:41\",\n \"currency\": \"BRL\",\n \"type\": \"DEPOSIT\",\n \"amount\": 10,\n \"fee\": 0.02,\n \"balance\": 74.2,\n \"address\": \"001|1234|12345\",\n \"tx_id\": \"E33938907654401413xwBoxcNVDsFCfe\",\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2a5e1f5e8d90\",\n \"blockchain\": \"\",\n \"confirmations\": \"1\",\n \"status\": \"COMPLETE\",\n \"transaction_id\": \"53860640\",\n \"extra_data\": {\n \"provider\":\"CELCOIN\",\n \"description\": \"Deposit via bank transfer\", \n \"from\":{\n \"name\":\"Gustavo Peixoto\",\n \"tax_id\":\"13086457082\",\n \"bank\":{\n \"code\":\"237\",\n \"branch\":\"0740\",\n \"account\":\"61501\",\n \"account_type\":\"CHECKING\"\n }\n }\n }\n }\n ]\n}"},{"id":"94f50ebf-2dbd-458c-bbb6-480cdaccbfeb","name":"Success - Get Transaction - BRL & WITHDRAWAL","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"7673b15c-2bce-4615-9a48-482e11f8219a"},{"key":"trans_id","value":"53842743","description":"(number, conditional): Unique identifier of the transaction to be retrieved.\n\nNote: Must be provided one of them: trans_id or external_id","type":"text","uuid":"5894b65f-5a94-4cd8-862d-e9c114892fbf"},{"key":"external_id","value":"f2b19e77-8c34-4e0d-94f3-6a1cb0c2d845","description":"(string, conditional): External identifier assigned by the partner system to retrieve the transaction.\n\nNote: Must be provided one of them: external_id or trans_id","type":"text","uuid":"f839ee12-03cf-4d2b-a184-0ac11c8c0d29","disabled":true}]},"url":"{{generalApiAddress}}/get_transaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Dec 2025 11:44:45 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"47"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"53842743\",\n \"user_id\": \"803\",\n \"created\": \"2024-05-09 10:08:29\",\n \"concluded\": \"2024-07-04 11:10:41\",\n \"currency\": \"BRL\",\n \"type\": \"WITHDRAWAL\",\n \"amount\": -0.01,\n \"price\": 1,\n \"fee\": 0,\n \"balance\": 17.61,\n \"address\": \"001|0000|******|CHECKING|pix:test@example.com\",\n \"tx_id\": \"d8be39c5-348f-4b92-ab1f-16adbffe98cb\",\n \"external_id\": null,\n \"blockchain\": \"\",\n \"confirmations\": \"1\",\n \"status\": \"COMPLETE\",\n \"transaction_id\": \"53842743\",\n \"extra_data\": {\n \"provider\": \"CELCOIN\",\n \"description\": \"Withdrawal via Pix\"\n }\n }\n ]\n}"},{"id":"c2870f60-854f-4300-8458-03f8a87ea6a8","name":"Success - Get Transaction - USDC & BUY","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"7673b15c-2bce-4615-9a48-482e11f8219a"},{"key":"trans_id","value":"87519403","description":"(number, conditional): Unique identifier of the transaction to be retrieved.\n\nNote: Must be provided one of them: trans_id or external_id","type":"text","uuid":"5894b65f-5a94-4cd8-862d-e9c114892fbf"},{"key":"external_id","value":"c7e8d134-41b9-4fa3-9ac1-7f94e2bb53f2","description":"(string, conditional): External identifier assigned by the partner system to retrieve the transaction.\n\nNote: Must be provided one of them: trans_id or external_id","type":"text","uuid":"f839ee12-03cf-4d2b-a184-0ac11c8c0d29","disabled":true}]},"url":"{{generalApiAddress}}/get_transaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 19 Nov 2025 17:02:54 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"227"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"103330096\",\n \"user_id\": \"844\",\n \"created\": \"2025-12-15 15:39:46\",\n \"concluded\": \"2025-12-15 15:39:46\",\n \"currency\": \"USDT\",\n \"type\": \"BUY\",\n \"amount\": 18.43513767,\n \"price\": 5.4368999999999996,\n \"fee\": 0.23965678000000001,\n \"balance\": 1832.39732101,\n \"address\": null,\n \"tx_id\": null,\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2adkaf93d1d99\",\n \"blockchain\": null,\n \"confirmations\": \"0\",\n \"status\": \"COMPLETE\",\n \"extra_data\": null,\n \"transaction_id\": \"103330096\"\n }\n ]\n}"}],"_postman_id":"246ea06d-9a16-437c-acc6-3348d0c5ec3c"}],"id":"b1c18d57-0f1d-4500-bc31-5e769bc67fd0","description":"The Exchange/FX module provides fast and secure access to trading operations within the Bity ecosystem.
\nIt allows you to retrieve real-time market quotes, execute orders, and track trading operations, ensuring transparency and reliability.
\nCurrently available endpoints:
\nGet Order Quote: retrieve a quote for buying or selling. Quotes expire every 10 seconds, so you must use the quote_id promptly.
Execute Order Quote: execute a previously retrieved quote. Make sure to use the quote_id before it expires to successfully execute the order.
Order Status – Returns the current status of a previously executed order. This allows partners to track whether an order is pending, completed, failed, or still being processed.
\nTransactions – Retrieves a list of executed transactions, enabling you to track all trading activity.
\nGet Transaction – Provides detailed status information for a specific transaction, helping you monitor completion, pending states, or failures.
\nImportant:
\nbase_amount and quote_amount cannot be sent simultaneously.
Only one of them should be provided per request.
\nIf both are sent, the request will be rejected.
\n(string, required): If it is a subaccount, this token is generated via the get_subacc endpoint and must be provided in the request to authenticate access.
\n","type":"text"}]},"url":"{{generalApiAddress}}/balance","description":"Retrieve the current balances of all currencies in the user’s account. This allows partners to monitor available and locked funds across different assets.
\nThe Balance endpoint provides a secure and real-time overview of the user’s wallet. It returns the available and locked amounts for each supported currency, enabling partners to manage funds and plan trades or withdrawals efficiently.
\n","urlObject":{"path":["balance"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"ace137b6-2c58-4567-9b59-0d5cf7d84342","name":"Balance","originalRequest":{"method":"POST","header":[{"key":"Referer","value":"{{headReferer}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): This token is generated via the subacc_get_token endpoint and must be provided in the request to authenticate access.","type":"text"}]},"url":"{{generalApiAddress}}/balance"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 01 Sep 2025 16:25:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Server","value":"gocache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"timestamp\": \"2025-09-01 13:25:05\",\n \"utimestamp\": \"2025-09-01 13:25:05\",\n \"A\": 0,\n \"A_locked\": 0,\n \"AAVE\": 0,\n \"AAVE_locked\": 0,\n \"ADA\": 0,\n \"ADA_locked\": 0,\n \"AERO\": 0,\n \"AERO_locked\": 0,\n \"AKT\": 0,\n \"AKT_locked\": 0,\n \"ALGO\": 0,\n \"ALGO_locked\": 0,\n \"ALT\": 0,\n \"ALT_locked\": 0,\n \"APE\": 0,\n \"APE_locked\": 0,\n \"APT\": 0,\n \"APT_locked\": 0,\n \"AR\": 0,\n \"AR_locked\": 0,\n \"ARB\": 0,\n \"ARB_locked\": 0,\n \"ASTR\": 0,\n \"ASTR_locked\": 0,\n \"ATH\": 0,\n \"ATH_locked\": 0,\n \"ATLAS\": 0,\n \"ATLAS_locked\": 0,\n \"ATOM\": 0,\n \"ATOM_locked\": 0,\n \"AVAX\": 0,\n \"AVAX_locked\": 0,\n \"AXS\": 0,\n \"AXS_locked\": 0,\n \"BANANA\": 0,\n \"BANANA_locked\": 0,\n \"BCH\": 0,\n \"BCH_locked\": 0,\n \"BEAM\": 0,\n \"BEAM_locked\": 0,\n \"BIO\": 0,\n \"BIO_locked\": 0,\n \"BLUR\": 0,\n \"BLUR_locked\": 0,\n \"BNB\": 0,\n \"BNB_locked\": 0,\n \"BOME\": 0,\n \"BOME_locked\": 0,\n \"BRETT\": 0,\n \"BRETT_locked\": 0,\n \"BRZ\": 0,\n \"BRZ_locked\": 0,\n \"BTC\": 0,\n \"BTC_locked\": 0,\n \"CAKE\": 0,\n \"CAKE_locked\": 0,\n \"CATI\": 0,\n \"CATI_locked\": 0,\n \"CFX\": 0,\n \"CFX_locked\": 0,\n \"CGPT\": 0,\n \"CGPT_locked\": 0,\n \"CHILLGUY\": 0,\n \"CHILLGUY_locked\": 0,\n \"CHZ\": 0,\n \"CHZ_locked\": 0,\n \"COMP\": 0,\n \"COMP_locked\": 0,\n \"CORE\": 0,\n \"CORE_locked\": 0,\n \"CRV\": 0,\n \"CRV_locked\": 0,\n \"CRZO\": 0,\n \"CRZO_locked\": 0,\n \"CTC\": 0,\n \"CTC_locked\": 0,\n \"DEGEN\": 0,\n \"DEGEN_locked\": 0,\n \"DOG\": 0,\n \"DOG_locked\": 0,\n \"DOGE\": 0,\n \"DOGE_locked\": 0,\n \"DOGS\": 0,\n \"DOGS_locked\": 0,\n \"DOT\": 0,\n \"DOT_locked\": 0,\n \"DYDX\": 0,\n \"DYDX_locked\": 0,\n \"DYM\": 0,\n \"DYM_locked\": 0,\n \"EGLD\": 0,\n \"EGLD_locked\": 0,\n \"EIGEN\": 0,\n \"EIGEN_locked\": 0,\n \"ELF\": 0,\n \"ELF_locked\": 0,\n \"ENA\": 0,\n \"ENA_locked\": 0,\n \"ENJ\": 0,\n \"ENJ_locked\": 0,\n \"ENS\": 0,\n \"ENS_locked\": 0,\n \"ETH\": 0,\n \"ETH_locked\": 0,\n \"ETHFI\": 0,\n \"ETHFI_locked\": 0,\n \"EURI\": 0,\n \"EURI_locked\": 0,\n \"FARTCOIN\": 0,\n \"FARTCOIN_locked\": 0,\n \"FET\": 0,\n \"FET_locked\": 0,\n \"FIL\": 0,\n \"FIL_locked\": 0,\n \"FLOW\": 0,\n \"FLOW_locked\": 0,\n \"FLR\": 0,\n \"FLR_locked\": 0,\n \"G\": 0,\n \"G_locked\": 0,\n \"GALA\": 0,\n \"GALA_locked\": 0,\n \"GLM\": 0,\n \"GLM_locked\": 0,\n \"GME\": 0,\n \"GME_locked\": 0,\n \"GMT\": 0,\n \"GMT_locked\": 0,\n \"GMX\": 0,\n \"GMX_locked\": 0,\n \"GNO\": 0,\n \"GNO_locked\": 0,\n \"GOAT\": 0,\n \"GOAT_locked\": 0,\n \"GORILLA\": 0,\n \"GORILLA_locked\": 0,\n \"GRASS\": 0,\n \"GRASS_locked\": 0,\n \"GRT\": 0,\n \"GRT_locked\": 0,\n \"HBAR\": 0,\n \"HBAR_locked\": 0,\n \"HMSTR\": 0,\n \"HMSTR_locked\": 0,\n \"HNT\": 0,\n \"HNT_locked\": 0,\n \"HYPE\": 0,\n \"HYPE_locked\": 0,\n \"HYPERSKIDS\": 0,\n \"HYPERSKIDS_locked\": 0,\n \"ICP\": 0,\n \"ICP_locked\": 0,\n \"IMX\": 0,\n \"IMX_locked\": 0,\n \"INJ\": 0,\n \"INJ_locked\": 0,\n \"IO\": 0,\n \"IO_locked\": 0,\n \"IOTA\": 0,\n \"IOTA_locked\": 0,\n \"IOTX\": 0,\n \"IOTX_locked\": 0,\n \"JASMY\": 0,\n \"JASMY_locked\": 0,\n \"JTO\": 0,\n \"JTO_locked\": 0,\n \"JUP\": 0,\n \"JUP_locked\": 0,\n \"KAS\": 0,\n \"KAS_locked\": 0,\n \"KAVA\": 0,\n \"KAVA_locked\": 0,\n \"KSM\": 0,\n \"KSM_locked\": 0,\n \"L3\": 0,\n \"L3_locked\": 0,\n \"LDO\": 0,\n \"LDO_locked\": 0,\n \"LINK\": 0,\n \"LINK_locked\": 0,\n \"LOOKS\": 0,\n \"LOOKS_locked\": 0,\n \"LPT\": 0,\n \"LPT_locked\": 0,\n \"LTC\": 0,\n \"LTC_locked\": 0,\n \"LUNA\": 0,\n \"LUNA_locked\": 0,\n \"LUNC\": 0,\n \"LUNC_locked\": 0,\n \"MANA\": 0,\n \"MANA_locked\": 0,\n \"MANTA\": 0,\n \"MANTA_locked\": 0,\n \"MAVIA\": 0,\n \"MAVIA_locked\": 0,\n \"MBONK\": 0,\n \"MBONK_locked\": 0,\n \"MBTT\": 0,\n \"MBTT_locked\": 0,\n \"MCAT\": 0,\n \"MCAT_locked\": 0,\n \"MCATS\": 0,\n \"MCATS_locked\": 0,\n \"MELANIA\": 0,\n \"MELANIA_locked\": 0,\n \"MEME\": 0,\n \"MEME_locked\": 0,\n \"MEW\": 0,\n \"MEW_locked\": 0,\n \"MFLOKI\": 0,\n \"MFLOKI_locked\": 0,\n \"MKR\": 0,\n \"MKR_locked\": 0,\n \"MMAGA\": 0,\n \"MMAGA_locked\": 0,\n \"MMOG\": 0,\n \"MMOG_locked\": 0,\n \"MNT\": 0,\n \"MNT_locked\": 0,\n \"MOODENG\": 0,\n \"MOODENG_locked\": 0,\n \"MOVE\": 0,\n \"MOVE_locked\": 0,\n \"MPEPE\": 0,\n \"MPEPE_locked\": 0,\n \"MSHIB\": 0,\n \"MSHIB_locked\": 0,\n \"MWEN\": 0,\n \"MWEN_locked\": 0,\n \"MXEC\": 0,\n \"MXEC_locked\": 0,\n \"MYRO\": 0,\n \"MYRO_locked\": 0,\n \"NEAR\": 0,\n \"NEAR_locked\": 0,\n \"NEIRO\": 0,\n \"NEIRO_locked\": 0,\n \"NEO\": 0,\n \"NEO_locked\": 0,\n \"NOT\": 0,\n \"NOT_locked\": 0,\n \"OM\": 0,\n \"OM_locked\": 0,\n \"ONDO\": 0,\n \"ONDO_locked\": 0,\n \"ONT\": 0,\n \"ONT_locked\": 0,\n \"OP\": 0,\n \"OP_locked\": 0,\n \"ORDI\": 0,\n \"ORDI_locked\": 0,\n \"OSMO\": 0,\n \"OSMO_locked\": 0,\n \"PAAL\": 0,\n \"PAAL_locked\": 0,\n \"PAXG\": 0,\n \"PAXG_locked\": 0,\n \"PENDLE\": 0,\n \"PENDLE_locked\": 0,\n \"PENGU\": 0,\n \"PENGU_locked\": 0,\n \"PIXEL\": 0,\n \"PIXEL_locked\": 0,\n \"PIXFI\": 0,\n \"PIXFI_locked\": 0,\n \"PNUT\": 0,\n \"PNUT_locked\": 0,\n \"POL\": 0,\n \"POL_locked\": 0,\n \"POLIS\": 0,\n \"POLIS_locked\": 0,\n \"PONKE\": 0,\n \"PONKE_locked\": 0,\n \"POPCAT\": 0,\n \"POPCAT_locked\": 0,\n \"PRIME\": 0,\n \"PRIME_locked\": 0,\n \"PUFFER\": 0,\n \"PUFFER_locked\": 0,\n \"PYTH\": 0,\n \"PYTH_locked\": 0,\n \"QNT\": 0,\n \"QNT_locked\": 0,\n \"RACA\": 0,\n \"RACA_locked\": 0,\n \"RAY\": 0,\n \"RAY_locked\": 0,\n \"RDNT\": 0,\n \"RDNT_locked\": 0,\n \"RNDR\": 0,\n \"RNDR_locked\": 0,\n \"RON\": 0,\n \"RON_locked\": 0,\n \"S\": 0,\n \"S_locked\": 0,\n \"SAGA\": 0,\n \"SAGA_locked\": 0,\n \"SAND\": 0,\n \"SAND_locked\": 0,\n \"SC\": 0,\n \"SC_locked\": 0,\n \"SCR\": 0,\n \"SCR_locked\": 0,\n \"SCRT\": 0,\n \"SCRT_locked\": 0,\n \"SEI\": 0,\n \"SEI_locked\": 0,\n \"SFI\": 0,\n \"SFI_locked\": 0,\n \"SLERF\": 0,\n \"SLERF_locked\": 0,\n \"SLP\": 0,\n \"SLP_locked\": 0,\n \"SNX\": 0,\n \"SNX_locked\": 0,\n \"SOL\": 0,\n \"SOL_locked\": 0,\n \"SPEC\": 0,\n \"SPEC_locked\": 0,\n \"STRK\": 0,\n \"STRK_locked\": 0,\n \"STX\": 0,\n \"STX_locked\": 0,\n \"SUI\": 0,\n \"SUI_locked\": 0,\n \"SUNDOG\": 0,\n \"SUNDOG_locked\": 0,\n \"TAO\": 0,\n \"TAO_locked\": 0,\n \"THETA\": 0,\n \"THETA_locked\": 0,\n \"TIA\": 0,\n \"TIA_locked\": 0,\n \"TNSR\": 0,\n \"TNSR_locked\": 0,\n \"TOKEN\": 0,\n \"TOKEN_locked\": 0,\n \"TON\": 0,\n \"TON_locked\": 0,\n \"TRUMP\": 0,\n \"TRUMP_locked\": 0,\n \"TRX\": 0,\n \"TRX_locked\": 0,\n \"TURBO\": 0,\n \"TURBO_locked\": 0,\n \"UNI\": 0,\n \"UNI_locked\": 0,\n \"USDBP\": 0,\n \"USDBP_locked\": 0,\n \"USDBRAZA\": 0,\n \"USDBRAZA_locked\": 0,\n \"USDC\": 0,\n \"USDC_locked\": 0,\n \"USDENIG\": 0,\n \"USDENIG_locked\": 0,\n \"USDHR\": 0,\n \"USDHR_locked\": 0,\n \"USDKRAKEN\": 0,\n \"USDKRAKEN_locked\": 0,\n \"USDNONCO\": 0,\n \"USDNONCO_locked\": 0,\n \"USDSFOX\": 0,\n \"USDSFOX_locked\": 0,\n \"USDSTILL\": 0,\n \"USDSTILL_locked\": 0,\n \"USDT\": 0,\n \"USDT_locked\": 0,\n \"USDWIN\": 0,\n \"USDWIN_locked\": 0,\n \"USDWINTER\": 0,\n \"USDWINTER_locked\": 0,\n \"USUAL\": 0,\n \"USUAL_locked\": 0,\n \"VANA\": 0,\n \"VANA_locked\": 0,\n \"VET\": 0,\n \"VET_locked\": 0,\n \"VIRTUAL\": 0,\n \"VIRTUAL_locked\": 0,\n \"VISTA\": 0,\n \"VISTA_locked\": 0,\n \"W\": 0,\n \"W_locked\": 0,\n \"WIF\": 0,\n \"WIF_locked\": 0,\n \"WLD\": 0,\n \"WLD_locked\": 0,\n \"XLM\": 0,\n \"XLM_locked\": 0,\n \"XNO\": 0,\n \"XNO_locked\": 0,\n \"XRD\": 0,\n \"XRD_locked\": 0,\n \"XRP\": 0,\n \"XRP_locked\": 0,\n \"XTZ\": 0,\n \"XTZ_locked\": 0,\n \"ZEN\": 0,\n \"ZEN_locked\": 0,\n \"ZEREBRO\": 0,\n \"ZEREBRO_locked\": 0,\n \"ZETA\": 0,\n \"ZETA_locked\": 0,\n \"ZIL\": 0,\n \"ZIL_locked\": 0,\n \"ZK\": 0,\n \"ZK_locked\": 0,\n \"ZRO\": 0,\n \"ZRO_locked\": 0,\n \"ZRX\": 0,\n \"ZRX_locked\": 0,\n \"ASI\": 0,\n \"ASI_locked\": 0,\n \"SKY\": 0,\n \"SKY_locked\": 0,\n \"BRL\": 0,\n \"BRL_locked\": 0\n}"}],"_postman_id":"23b98e96-18bc-416e-b023-e22e083cf2ac"},{"name":"Withdrawal","id":"745f55a1-fc08-43f9-9908-ea49d30eea8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string & required): If it is a subaccount, this token is generated via the get_subacc endpoint and must be provided in the request to authenticate access.
\n","type":"text"},{"key":"amount","value":"15","description":"(string & required): Asset amount to be withdrawed.
\nNote: When the currency is a fiat currency, specific decimal precision rules apply:
\nExample: 150.75 → represents R$150.75
\nExample: 20.00 → represents R$20.00
\nExample: 15.1234 → represents US$15.1234
\nExample: 0.5000 → represents US$0.5000
\n","type":"text"},{"key":"currency","value":"BRL","description":"(string & required): Asset currency intended to be withdrawn. One of [BTC, BRL, ETH, etc]
\n","type":"text"},{"key":"priority","value":"","description":"(string & optional): Priority of withdrawal transaction. One of [high, medium, low]
\n","type":"text"},{"key":"blockchain","value":"","description":"(string & conditional): Blockchain from wich the withdrawl will be executed.
\nNECESSARY if currency is NOT \"BRL\". If blank, defaults to BRL withdrawals.
\nExamples of currencies: [BRL, BTC, ETH, BSC, SOL, etc]
\n","type":"text"},{"key":"address","value":"021|232323|2323","description":"(string & required): Destination account identifier.\nFormatted as ${Bank}|${Branch}|${Account}.
\n⚡ This field accepts:
\nA bank address (e.g. Nubank data):
\nA Pix key (minimum 11 characters)
\nBlockchain address (e.g. 0x742d35Cc6634C0532925a3b844Bc454e4438f44e)
\n(string & optional): Allows partners to attach their own external identifier to the withdrawal request.
\n","type":"text","uuid":"feb19570-8b35-45e2-912d-1e82acab556b"},{"key":"description","value":"Withdrawal via Pix","description":"(string & optional): Textual note provided by the partner to describe the purpose or context of the withdrawal.
\n","type":"text","uuid":"4c520e60-ea2d-40da-8d3d-f6b7fb52e0a4"}]},"url":"{{generalApiAddress}}/withdrawal","description":"Initiate a secure withdrawal of funds from the user’s account to an external address or bank account.
\nThe Withdrawal endpoint allows partners to request the transfer of assets from their Bity wallet. Partners must provide the currency, amount, and a valid destination address or bank account. Optional parameters like priority and blockchain can be used to control the speed and method of execution.
\nThis endpoint ensures that withdrawals are executed safely and in accordance with the user’s specified preferences, while also providing real-time feedback on the transaction status.
\nThese status codes represent system results when submitting a withdrawal request.
\nEach code indicates a business rule, validation failure, or processing outcome.
\nThe Wallet API allows partners to manage and query existing wallet resources, serving as the central hub for account-related financial operations.
\nIt focuses on monitoring balances and executing withdrawals, ensuring secure, transparent, and efficient funds management and outflow operations within the Bity ecosystem.
\nBalance – Retrieves the current available balance of the account, providing real-time visibility of funds.
\nWithdrawal – Initiates and manages withdrawal requests from the account, enabling secure transfer of funds out of the platform.
\nNote: More endpoints will be added over time to expand subaccount functionality.
\n","_postman_id":"5ad8dfeb-3960-4589-abb0-234a964712f0"},{"name":"OnRamp","item":[{"name":"Settlement QRCode","id":"3de28517-c2c7-410e-89f9-c58875add860","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.
\n","type":"text","uuid":"cbce0a88-b1da-4cd3-b4ee-4b1d6bc40925"}]},"url":"{{generalApiAddress}}/get_settlement","description":"Generate a QR code for settling account credits, allowing the account to pay off its outstanding balance efficiently.
\nThe get_settlement endpoint provides a simplified way to determine how much an account owes and generates a QR code (which can be static) for completing the payment. This ensures that credits previously granted to the account are properly liquidated.
The QR code complies with payment standards and can be scanned to complete the settlement.
\nPlanned feature: a payment_link may be provided in the future to display the QR code and payment details on a web page.
Note: This endpoint is still under development and may be subject to changes.
\n","urlObject":{"path":["get_settlement"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"50dd63f0-40eb-482c-bad1-9c5f808037e1","name":"Success – Settlement QRCode Generated","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"cbce0a88-b1da-4cd3-b4ee-4b1d6bc40925"}]},"url":"{{generalApiAddress}}/get_settlement"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 05 Sep 2025 17:53:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Server","value":"gocache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"emv\": \"00020101021226930014br.gov.bcb.pix2571qrcode-h.pix.celcoin.com.br/pixqrcode/v2/095f2949533dce456d8b13bba776055204000053039865802BR5923Vitor Rafael dos Santos6006Recife62070503***63042DD9\",\n \"qrcode_image\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAAAAklEQVR4AewaftIAABBJSURBVO3BUY4cOJYEwXCi7n9lX30/UAAbVKbE2TDDX1JV9YCVqqpHrFRVPWKlquoRK1VVj1ipqnrET34DyL9IzSkgk5odIKfUfAKQSc3fBmRScwrIKTWfAOQT1NwAckPNLSD/IjXTSlXVI1aqqh6xUlX1iJWqqkf85D9Q801AbqiZgOyouQFkR80NIKfUTEB21ExATgHZUTOpOQVkR80JIDtqJiA7aiYgp4B8C5AdNTfUfBOQEytVVY9Yqap6xEpV1SNWqqoesVJV9Yif/AFAbqi5BeQGkEnNKTU7QE6pOQVkAnIKyKRmB8ik5hSQU2p2gJxQswPkFJAbanaATGpuAPkmIDfU3FipqnrESlXVI1aqqh6xUlX1iJ/8D1PzCUAmNbeATGo+Qc0pNROQHTWTmlNATqk5peYGkB0gp9RMQHbUTEAmNTtAJjWvW6mqesRKVdUjVqqqHrFSVfWIlaqqR/zk/xkgp9ScAnJKzbeo2QEyqdkBcgrIDTWfAGRSswPklJoJyA6Qb1Hzv2ilquoRK1VVj1ipqnrESlXVI37yB6h5nZoJyI6aCciOmgnIJ6g5pWYCckrNLSCngNxQc0rNBGQHyA01L1HzN61UVT1iparqEStVVY9Yqap6xEpV1SN+8h8Aqc9RMwHZUTMBmdTsAJnU7AA5BWRS8wlqJiCngOyoOaVmArKjZgKyo+YGkEnNKSD/opWqqkesVFU9YqWq6hErVVWP+MlvqKk9IJOaW0AmNTtA/kVq/iY1O0C+Rc0pNTeA3FLzipWqqkesVFU9YqWq6hErVVWPWKmqesRPfgPIpGYHyLeo2VEzAfkWILfUTEBOqZmAfAKQb1IzATml5hSQSc0OkEnNDpBTaiY1E5AdNaeAfIuaGytVVY9Yqap6xEpV1SNWqqoegb9kA8gpNROQU2pOAbmh5l8F5IaaG0B21JwCckrNBGRHzQkgt9RMQHbUTEBuqZmAfIKaCcgtNROQHTUnVqqqHrFSVfWIlaqqR6xUVT3iJx+iZgfIKSCTmh0gJ4CcUvNNaiYgO2puAJnU7ACZ1OyomYDcAnJDzQTkFpBvUfMSIH/aSlXVI1aqqh6xUlX1iJWqqkesVFU94if/gZpTQE4B2VEzAbmh5hSQU2p2gPxNQL4JyA01O0AmNaeAnAJySs0EZEfNBOQUkEnNDpBJzSk1nwDkxkpV1SNWqqoesVJV9YiVqqpH4C85BOQT1OwAmdTsAJnUTEB21JwCMqn5JiCTmhtAdtRMQG6pmYB8i5pbQG6o2QHyp6nZAfK3qTmxUlX1iJWqqkesVFU9YqWq6hErVVWPwF+yAWRSswNkUrMDZFLzCUBOqTkF5BPUTEB21ExATqn524BManaATGomIDtqJiA7aiYgO2puANlRcwPIKTUTkFNqTgHZUXNiparqEStVVY9Yqap6xEpV1SPwl1wCckPNDpAbaiYgO2omIDtqTgGZ1JwCckrNDSCn1OwAOaVmAnJDzTcBOaXmFJBJzQRkR80pIJOaU0BOqdkBMqmZVqqqHrFSVfWIlaqqR6xUVT1iparqEfhLNoBMak4B2VHzCUBuqDkFZFJzCsjfpuYUkEnNDpAbak4BOaVmAnJKzQ6QU2omIDtqJiCTmh0gk5odIJOaTwCyo+bESlXVI1aqqh6xUlX1iJWqqkfgLzkEZEfNBOSUmh0gk5odIJOaCciOmgnIjpoJyCeo+QQgn6BmArKjZgJySs0pIKfUTEB21JwCMqm5AeSWmgnIjpoJyI6aU0AmNdNKVdUjVqqqHrFSVfWIlaqqR6xUVT3iJ/+BmltqTqn5FiCngJxScwrInwZkR823qNkBMqnZAXJDzQRkB8gpIKfUTEB21ExAJjWngOwA+dvUnFipqnrESlXVI1aqqh6xUlX1iJ/8BpBTaiY1O0AmNTtAJjX/IjU7QCY1p4DsqDmhZgfIKTU3gJwCcgPIKTWngOyouaFmB8ik5hSQSc0nqDkFZEfNiZWqqkesVFU9YqWq6hErVVWPWKmqesRP/gAgk5pTQHbUnFJzQs0OkFNqvkXNDpBJzQTklJpvUnMDyCcAmdTsAJnUfAuQHTUTkE9Q8y0rVVWPWKmqesRKVdUjVqqqHvGT/0DNLTWngPxpanbUTEB2gLxCzQ6QCciOmgnIjppTQG6o+QQ1E5BvUnMDyCk1p4BMQE6pubFSVfWIlaqqR6xUVT1iparqET/5DTU3gNxSMwE5peZfBGRHzSk1E5BTaiYgO0BOATml5hSQG0AmNTtAPgHIpGYHyKTmlJpPUHMKyCkgk5ppparqEStVVY9Yqap6xEpV1SNWqqoegb/kEJAdNROQf5GaHSCn1HwLkE9QcwrIpOYWkFNqJiCn1NwAsqNmArKjZgKyo+ZPA7Kj5hOA3FAzrVRVPWKlquoRK1VVj1ipqnrET34DyKRmB8ikZgfIpOYWkBNATqnZAXJKzQ01O0AmNROQHSCn1ExAdtRMQG4B+RcBmdTsAJnUnAIyqfkEIKfU7KiZgNxYqap6xEpV1SNWqqoesVJV9YiVqqpH/OQ/ALKj5gaQT1AzAfnbgJxScwrIDTU7QE4BuaFmB8ikZgJyCsgpNTtAJiA7aiYgO2omNROQW0A+AciftlJV9YiVqqpHrFRVPWKlquoRP/kQIKfU3AJyQs0OkFNqJiA7QCY1O0BOqfnTgJxScwvIn6ZmB8gpNafUTEB2gExqdoBMaiY1O0AmNbeAnFLzp61UVT1iparqEStVVY9Yqap6xEpV1SN+8h+o2QEyqdkBcgrIpOYGkB01E5AdNZOaU0BOAdlRcwLINwGZ1HwCkEnNjpoJyA6QSc0OkFNqbgD5BCCTmlNAbqk5sVJV9YiVqqpHrFRVPWKlquoRP/kNNTeA3FLzp6nZAXIKyCk1k5odIN+iZgJyS80NIDtqJiCngExqTgE5peaWmhtATqm5oeYUkBsrVVWPWKmqesRKVdUjVqqqHrFSVfUI/CUfAORvU3MDyI6aU0AmNbeATGomIDtqTgH5FjU7QCY1nwDkW9R8ApBvUbMDZFJzY6Wq6hErVVWPWKmqesRKVdUj8JdcAnJKzQ0gO2puAJnU7AC5oWYHyKTmW4DsqDkFZFKzA+SUmgnIpGYHyKTmFJAdNROQW2omIJOaU0B21JwCMqnZAXJKzYmVqqpHrFRVPWKlquoRK1VVj1ipqnoE/pJDQHbUnAIyqdkB8jepuQVkUnMLyAk1t4B8i5pvAbKj5hSQb1FzA8gpNTtAJjWngOyoObFSVfWIlaqqR6xUVT1iparqEfhLNoBMak4B2VFzA8iOmhNATqnZAXJKzQ0gp9RMQHbUnAIyqdkBMqnZAXJKzQkgO2omILfUfAKQb1EzAdlR8zetVFU9YqWq6hErVVWPWKmqesRPvgzIpGYHyA0g36LmFJAdNZOaHSAn1NxSMwE5BeSUmk8AckrNBOQUkFNqTqmZgOyomYB8ApBTam6sVFU9YqWq6hErVVWPWKmqesRKVdUj8JdsADml5gaQHTUTkBtqPgHIjpoJyI6aCciOmgnIKTUTkB01nwDklJo/DcgtNTeA7Kg5AWRHzQRkR80pIJOaHSCn1JxYqap6xEpV1SNWqqoesVJV9Qj8JRtAJjWngOyoOQXklJobQE6pmYCcUnMKyI6aE0A+Qc0OkBtqdoBMak4BOaVmAnJKzS0gk5pTQCY1O0AmNaeA7Kg5BWRSM61UVT1iparqEStVVY9Yqap6xEpV1SPwlxwCsqPmFJBTaiYgN9TsADml5gaQHTUTkG9RcwrIjpp/EZBJzQ6QSc3fBmRS8xIgp9RMK1VVj1ipqnrESlXVI1aqqh6Bv2QDyKTmm4D8TWpOATmlZgfIKTU3gExqPgHIKTU3gOyouQFkR80E5JSaHSDfomYCckvNBGRHzYmVqqpHrFRVPWKlquoRK1VVj1ipqnoE/pJDQE6p+QQgO2puADml5hSQG2pOATml5hSQG2r+NiCTmh0gk5odIKfUvALIjppTQCY1O0AmNdNKVdUjVqqqHrFSVfWIlaqqR/zkHwbkFJBJzQTklJodIDfU7AD5F6mZgOyoOQXkhppTam4A2VFzCsgNNROQT1CzA2RSc0vNiZWqqkesVFU9YqWq6hErVVWPWKmqegT+kktAPkHN3wRkR83/IiB/m5odIDfUnAIyqfkmIDfUnAJyQ80OkFNqTqxUVT1iparqEStVVY9Yqap6xE9+A8gpNROQU2p2gExqvkXNDpBTaiYgO2r+NCA7ak6pOQVkUrMDZAJySs0E5BSQHTUTkB01E5BTanbUTEBuADml5paaCciNlaqqR6xUVT1iparqEStVVY9Yqap6BP6SS0AmNTtATqk5BWRSMwHZUTMBuaXmE4BMam4A+QQ1fxuQSc0OkEnNDpBJzQ6Qb1EzAbml5m9aqap6xEpV1SNWqqoesVJV9Yif/AaQU2omILeA3AAyqdkBckrNKSCTmlNA/jY1p4DcALKjZgIyqdlRMwE5BWRHzQ01p4BManaA3FDzCUBOqZlWqqoesVJV9YiVqqpHrFRVPQJ/ySEgp9R8E5ATak4B+f9EzQ6QSc0OkNepmYDsqJmAfIKaCciOmk8AckrNBGRHzYmVqqpHrFRVPWKlquoRK1VVj1ipqnoE/pIPALKj5hSQb1EzAfkENTtATqm5AWRSswPkW9R8ApBJzSkg36RmAvIvUnMLyKRmWqmqesRKVdUjVqqqHrFSVfWIn3yImltqTgGZ1HyLmltqTgGZ1JxSMwE5peYWkAnIjpp/kZpTQCY1N9TsAJnU3AIyAdlR86etVFU9YqWq6hErVVWPWKmqesRKVdUjfvIbQP5FanbUTEAmNafU7ACZgNxSMwHZUXMDyKRmB8gpIJOaU2puANlRMwHZUXMKyKTmE9R8ApBJzSk1p4DcWKmqesRKVdUjVqqqHrFSVfWIn/wHar4JyCkgk5pPUDMB2VEzAdkBMqnZAfIvUvM3qdkBMqnZAfIJam4A+QQ1r1ipqnrESlXVI1aqqh6xUlX1iJWqqkf85A8AckPNJwA5pWYCckrNDpAbQE6pOQXkBpBvAnJDzQ01p4B8i5odIBOQv03NjZWqqkesVFU9YqWq6hErVVWP+En9Z2omIDtqTgG5AeSUmgnIKTU7QCY1O0AmIDtqTgDZATKp2VHzt6mZgHyCmgnIKSA7aiYgO2pOrFRVPWKlquoRK1VVj1ipqnrESlXVI37yP0zNKSCTmlNqTgHZUTMB2VHzp6nZAXJKzQTkFpAbaiYgO2pOAZnU7ACZ1OwAmdScUjMBOaXmX7RSVfWIlaqqR6xUVT1iparqET/5A9T8bWomIKfUnAIyqdkBMqnZAfKnATmlZkfNDTW3gExqbqjZATKpOQVkR80E5BSQG2p2gExqdoBManaATGpurFRVPWKlquoRK1VVj1ipqnrESlXVI/CXbAD5F6nZATKpOQXkhpodIDfUnALyLWpOAdlRMwG5oWYHyCk1E5AdNaeAnFIzAZnUfAKQHTUTkFtqTqxUVT1iparqEStVVY9Yqap6BP6SqqoHrFRVPWKlquoRK1VVj1ipqnrE/wHtXB2bP/iN8wAAAABJRU5ErkJggg==\",\n \"expiration\": \"2025-09-05T18:53:18.449Z\",\n \"transactionId\": \"4000396589\",\n \"transactionIdentification\": \"kk6g232xel65a0daee4dd13kk4000396589\"\n }\n}"},{"id":"4e72832f-0e37-4d32-af44-8af856d8233c","name":"Error – Pix Key Retrieval (Settlement QRCode)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"cbce0a88-b1da-4cd3-b4ee-4b1d6bc40925"}]},"url":"{{generalApiAddress}}/get_settlement"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 05 Sep 2025 14:14:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"55"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"ERROR_GETTING_PIX_KEY\"\n}"},{"id":"bd3727d3-2b51-4269-8208-b15dff0c920d","name":"Error – No Pending Amount (Settlement QRCode)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"cbce0a88-b1da-4cd3-b4ee-4b1d6bc40925"}]},"url":"{{generalApiAddress}}/get_settlement"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 05 Sep 2025 14:29:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"62"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"NO_AMOUNT_PENDING_SETTLEMENT\"\n}"},{"id":"93eda316-cd3a-4055-9477-6cc6e214c3ea","name":"Error – QRCode Creation (Settlement QRCode)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"cbce0a88-b1da-4cd3-b4ee-4b1d6bc40925"}]},"url":"{{generalApiAddress}}/get_settlement"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 05 Sep 2025 17:31:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"100"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"ERROR_CREATING_QRCODE\",\n \"data\": \"{\\\"message\\\":\\\"KYC not approved.\\\"}\"\n}"}],"_postman_id":"3de28517-c2c7-410e-89f9-c58875add860"},{"name":"Deposit QRCode","id":"49b58da4-796d-4aae-95ed-7ea027eb3b11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.
\n","type":"text","uuid":"54f6d8da-ea80-4c8e-83dd-e6b1cac59265"},{"key":"amount","value":"{amount}","description":"(number, required): Amount of the QR Code in the specified currency. Represents the value the payer will need to pay.
\nNote: When the amount refers to a fiat currency, specific precision rules apply:
\nExample: 150.75 → represents R$150.75
\nExample: 20.00 → represents R$20.00
\nExample: 15.1234 → represents US$15.1234
\nExample: 0.5000 → represents US$0.5000
\n","type":"text","uuid":"e6675997-1150-4bce-bf70-34f7af21e48d"},{"key":"payer_name","value":"{payer_name}","description":"(string, optional): Name of the payer. This field is optional and can be used to personalize the payment.
\n","type":"text","uuid":"cab03f3c-8540-47bf-9a8d-52518ee6c876"},{"key":"payer_taxid","value":"{payer_taxid}","description":"(string, optional): Tax ID or document of the payer. Optional; used for identification purposes if provided.
\n","type":"text","uuid":"92a7abe0-5716-40a4-acc1-9eeeaf965eda"},{"key":"payer_note","value":"{payer_note}","description":"(string, optional): A message displayed to the payer during payment, limited to 140 characters.
\nExample: 150.75
\n","type":"text","uuid":"abaf9648-e961-424a-9955-654f15ea6034"},{"key":"expiration","value":"{expiration}","description":"(number, optional): Time in seconds for the QR Code to expire. Defaults to 24 hours (86400 seconds) if not provided.
\nExample: 3600
\n","type":"text","uuid":"eb46d5bf-81a5-4e3d-8e99-69dec3592201"}]},"url":"{{generalApiAddress}}/deposit_qrcode","urlObject":{"path":["deposit_qrcode"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"275dd737-ca30-4e58-ac83-0b06f0968fa5","name":"Deposit QRCode","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"54f6d8da-ea80-4c8e-83dd-e6b1cac59265"},{"key":"amount","value":"{amount}","description":"(number, required): Amount of the QR Code in the specified currency. Represents the value the payer will need to pay.\n\nNote: When the amount refers to a fiat currency, specific precision rules apply:\n\n- For BRL (base fiat currency): values must use 2 decimal places.\n\nExample: 150.75 → represents R$150.75\n\nExample: 20.00 → represents R$20.00\n\n- For USD: values must use 4 decimal places.\n\nExample: 15.1234 → represents US$15.1234\n\nExample: 0.5000 → represents US$0.5000\n\n","type":"text","uuid":"e6675997-1150-4bce-bf70-34f7af21e48d"},{"key":"payer_name","value":"{payer_name}","description":"(string, optional): Name of the payer. This field is optional and can be used to personalize the payment.","type":"text","uuid":"cab03f3c-8540-47bf-9a8d-52518ee6c876"},{"key":"payer_taxid","value":"{payer_taxid}","description":"(string, optional): Tax ID or document of the payer. Optional; used for identification purposes if provided.","type":"text","uuid":"92a7abe0-5716-40a4-acc1-9eeeaf965eda"},{"key":"payer_note","value":"{payer_note}","description":"(string, optional): A message displayed to the payer during payment, limited to 140 characters.\n\nExample: 150.75","type":"text","uuid":"abaf9648-e961-424a-9955-654f15ea6034"},{"key":"expiration","value":"{expiration}","description":"(number, optional): Time in seconds for the QR Code to expire. Defaults to 24 hours (86400 seconds) if not provided.\n\nExample: 3600","type":"text","uuid":"eb46d5bf-81a5-4e3d-8e99-69dec3592201"}]},"url":"{{generalApiAddress}}/deposit_qrcode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 31 Dec 2025 14:09:45 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Server","value":"gocache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"emv\": \"00020101021226930014br.gov.bcb.pix2571qrcode-h.pix.celcoin.com.br/pixqrcode/v2/e5f3a67a9a77c8865bee6ce5b505b25204000053039865802BR5914Felipe Andrade6009Fortaleza62070503***630430B2\",\n \"qrcode_image\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAAAAklEQVR4AewaftIAABA5SURBVO3BUY4cOJYEwXCi7n9lX30TFPAaVKbE2TDDX1JV9YCVqqpHrFRVPWKlquoRK1VVj1ipqnrET34DyL9IzQmQnZodkCk1U0Cm1HwLkBM1U0A+Qc0NIFNqdkBuqbkB5IaaW0D+RWp2K1VVj1ipqnrESlXVI1aqqh7xk/9AzTcBmVJzQ80nqNkBmVJzAmSnZqdmCsiUmhMgOzUnQKbUTKg5ATKlZgfkBMjfBOREzQ013wRkYqWq6hErVVWPWKmqesRKVdUjVqqqHvGTPwDIDTWfAOQlanZATtTsgEypmVIzpWYH5BaQP03NlJpbQKbUTAD5JiA31NxYqap6xEpV1SNWqqoesVJV9Yif/I8AMqHmBMiUmp2abwKyU7MDcgJkp2YKyImanZopICdqbqjZAZlScwJkSs0OyAmQCTUnQHZqXrdSVfWIlaqqR6xUVT1iparqEStVVY/4yf8zQE7U7ICcAJlSs1NzAmSn5luA3AJyQ80JkBtqdmpOgOyATKk5AbJTMwVkSs3/opWqqkesVFU9YqWq6hErVVWP+MkfoOYVak6ATKnZATkBMqVmB+REzQ01U0B2am4B2QGZUjMFZKfmRM0OyImaKTU7ICdq/kVq/qaVqqpHrFRVPWKlquoRK1VVj1ipqnrET/4DIC9RswNyomYH5JaaHZBPALJTcwJkp+YWkJ2aKTUnQCaAnKjZATlRcwPIiZpvAbJTMwXkX7RSVfWIlaqqR6xUVT1iparqET/5DTWvA7JTcwJkp+YEyCcA2ak5AXJDzSeo+ZvUnAC5oWZKzS0gOzVTaqbUvGKlquoRK1VVj1ipqnrESlXVI1aqqh7xk98AslNzC8hOzQmQG2qm1HwCkCk1OyAnam4A2amZAvI6NZ8A5ETNTs0nAPnb1EwB2anZrVRVPWKlquoRK1VVj1ipqnoE/pJLQHZq/kVATtTsgNxS8y1AbqiZAnKiZgdkSs0JkAk1U0BO1OyATKk5ATKlZgdkSs0NIFNqToDs1NxYqap6xEpV1SNWqqoesVJV9Qj8JUNAptScANmpOQEypeYGkJ2aKSCfoOYEyE7NFJAbam4BmVKzAzKl5gaQT1BzAmRCzQmQnZoTIDs1U0A+Qc1uparqEStVVY9Yqap6xEpV1SNWqqoe8ZP/QM0JkCk1U2qmgOzU7IDcArJTcwJkSs0OyBSQT1AzBeRb1EwB2am5pWYH5ETNDTU7ICdqbgCZUjMF5MZKVdUjVqqqHrFSVfWIlaqqR/zkN4B8C5ApNVNAptTsgNxSswNyS80EkCk1J0B2ak7UTAGZAnJDzScA2an5BCA7NSdAPkHNDTU3VqqqHrFSVfWIlaqqR6xUVT1iparqEfhLhoCcqJkCslPzCUCm1EwBmVKzA3Ki5m8C8repOQHyp6k5AbJTcwJkp+YEyJSaCSAnam4AOVGzA3KiZgrITs1uparqEStVVY9Yqap6xEpV1SN+8htAdmpuqZkCMqXmTwNyouaGmhMgOzVTQHZqptTcAvIJanZAptTsgEwBmQJyomYHZArIFJCdmltAbgC5sVJV9YiVqqpHrFRVPWKlquoRK1VVj/jJb6i5AeREzQ7IiZopIBNqToBMAdmpOQGyU/MtQE7U7ICcqPkENTsgN9RMqZkCcqJmB2RKzQmQCTUnQHZAptTcArJTc2OlquoRK1VVj1ipqnrESlXVI37yHwD5BDUnQHZqTtRMALmlZkrNDsgtIDs1U0CmgOzUTKn5FwE5UTMF5FvUTKm5AWRKzYmaKSA7NbuVqqpHrFRVPWKlquoRK1VVj1ipqnoE/pIhIFNqToDs1NwCMqHmBMhOzQmQnZoTIDs1t4DcUPMtQKbUnACZUHMC5CVqJoBMqTkBMqVmB+REzZ+2UlX1iJWqqkesVFU9YqWq6hH4Sz4AyCeouQHkRM0OyImaHZATNd8CZKfmFpCdmhMgU2r+NCCfoOYEyE7NFJATNTsgOzUnQHZqToDs1HwCkBM1EytVVY9Yqap6xEpV1SNWqqoesVJV9Qj8JR8A5ETNtwD5BDVTQG6ouQHkRM0OyJSaKSAvUbMDcqJmCsi3qNkBmVJzAmSnZgrIlJrdSlXVI1aqqh6xUlX1iJWqqkf85DeAfAKQT1DzL1KzAzIFZErNFJApNTsgU2pOgPxNaj4ByImaKSATaqbU3FKzAzKl5sZKVdUjVqqqHrFSVfWIlaqqR/zkP1BzAmSn5gTIlJodkBtqPgHIlJpbQCbUTAE5AbJTc0vNFJAbaqaATAH5FwHZqZkCcqJmp2YKyImaiZWqqkesVFU9YqWq6hErVVWPWKmqesRPfkPNDsiJmhtqToD8aUCm1JwAmVKzAzKl5gaQW2p2QE7UvALIlJoTIDs1J0Cm1NxQ8wlAdmpuAdmp2a1UVT1iparqEStVVY9Yqap6xE++TM0OyImaHZATIBNqpoBMqTkBslMzBWQKyJSaKSA7NVNATtTsgPyvUrMDcgJkQs0UkCk1n6DmxkpV1SNWqqoesVJV9YiVqqpHrFRVPQJ/yQGQG2pOgHyLmh2QKTV/G5ATNTeA7NScAPkWNVNAdmpOgNxQ801Admp2QP42NSdAdmpurFRVPWKlquoRK1VVj1ipqnrET35DzQ7IFJApNbeA3FAzBWSn5puA7NTsgJyo2QGZUnMLyJ8G5ETNDsiJmikgOzWfAOSGmltAdkCmgJyomVipqnrESlXVI1aqqh6xUlX1iJWqqkf85DeA3FBzAmQKyE7NFJBPULMDMqXmE4BMAdmpOQEyBWSn5haQCTVTaqaATAE5UTOlZgfkE4Ds1HwTkJ2a3UpV1SNWqqoesVJV9YiVqqpH/ORDgNxSc0PNDSC31EwBmVKzAzKl5hPU/IuATKnZqTkBslMzBeREzYSaEyBTam6omQJyY6Wq6hErVVWPWKmqesRKVdUjVqqqHoG/5ABInamZAjKlZgfkRM0NIP8iNVNAptTsgJyo2QE5UfMtQF6iZgfkRM3ESlXVI1aqqh6xUlX1iJWqqkf85D9QcwJkp+YEyE7NFJATNTsgU2qmgNxQM6XmBpATNVNAdmpOgNwAMqVmB+QWkCkgOzV/m5pPAHJDzY2VqqpHrFRVPWKlquoRK1VVj1ipqnoE/pIPAPIJak6A7NTsgEyp+QQgJ2qmgOzUTAH5FjUnQHZqvgXIN6m5AWSn5haQKTU3gEyp2a1UVT1iparqEStVVY9Yqap6xE9+A8hOzQmQKTU7ICdqdkBO1OyA7NScAJkCslNzAuQGkBM1N9R8ApApNVNAdmqmgOzU/G1ATtTs1HyLmhMgOzVTak6ATKxUVT1iparqEStVVY9Yqap6BP6SAyBTaj4ByE7NDSBTam4BmVIzBWSnZgfkRM0OyJSaKSBTaqaA7NScANmp+QQgJ2qmgOzU7ICcqLkB5ETNDSAnaiZWqqoesVJV9YiVqqpHrFRVPWKlquoRP/kNNTsgnwDkRM0OyImaHZCdmk8AcqJmB+SWmj9NzQmQHZApNSdAdkBO1OzU7ICcqPkEIFNAptT8TWpOgPxNK1VVj1ipqnrESlXVI1aqqh7xk/9AzRSQW0BuqNkBmVJzAmSnZkrNCZApNTsgN4CcqJkCsgNyomYHZArIDSBTam6p2QGZAjIFZKdmCsiUmikgN1aqqh6xUlX1iJWqqkesVFU9YqWq6hE/+Q0gU2qm1NwAckPNCZAbQG6p2QE5AXIDyA0gJ2p2QE6ATAGZUHMCZErNDsiJmk8AslPzCUA+AcgUkJ2a3UpV1SNWqqoesVJV9YiVqqpH/OQfAGRKzQ0gJ2qm1EwB+QQ1E0BO1HwCkJ2aTwCyAzKl5haQKTU7NSdAdkB2ak6A7NScqJkCckPNCZCJlaqqR6xUVT1iparqEStVVY9Yqap6xE8+RM0tNTsgU2qmgEyp2QE5UbMD8i1qbgHZqbkFZKdmSs0OyImaKSA7NVNAToDs1JyomQAyBeREzSeomVIzsVJV9YiVqqpHrFRVPWKlquoR+EuGgEypOQHyLWp2QKbUTAGZUnMC5HVqXgHkRM0UkJ2aEyA7NZ8AZErNDsiJmikgOzUnQHZqditVVY9Yqap6xEpV1SNWqqoesVJV9Qj8JR8A5ETNJwDZqflfBWSnZgrITs0UkFtqdkBO1OyATKnZATlRswNyS80OyCeo+duATKmZWKmqesRKVdUjVqqqHrFSVfWIn/wBQG4AuaVmB2RKzd8GZKfmRM0NNTsgJ2qm1OyAnACZAjKh5gTIt6iZUnMCZKdmCsgNNSdAbqi5sVJV9YiVqqpHrFRVPWKlquoRK1VVj/jJbwD5FjXfouYTgEypOVFzA8iUmikgOzW31NwAsgNyomYKyE7NJwA5UbMDslMzpeaWmh2QKSBTanYrVVWPWKmqesRKVdUjVqqqHoG/5ADIlJodkG9SswOyU3MCZKfmBMgnqPkWIDs1J0Cm1EwB2ak5ATKh5iVATtTcADKlZgdkSs0UkBM1EytVVY9Yqap6xEpV1SNWqqoegb9kCMiUmn8RkBM1nwBkp2YKyImaCSC31OyAnKjZATlRswNyomYH5IaaTwByomYHZErNDsiJmhtATtTsgJyo2QE5UTOxUlX1iJWqqkesVFU9YqWq6hErVVWPwF/yAUBO1EwBmVLzpwH5JjU7ICdqvgXI69TcAHKiZgrITs0UkJ2aEyB/m5opIDs1u5WqqkesVFU9YqWq6hErVVWP+MmHqLmlZgrITs0OyJSaKSAnaqaA7NScAJlQMwVkSs0tIDs1J0C+BcgUkCk1OyAnaiaATKm5BWSn5gTIn7ZSVfWIlaqqR6xUVT1iparqEStVVY/4yW8A+Rep+duATAHZqTlRc0PN3wZkp2YKyImaCSCfoOYEyE7NCZCdmik1U0CmgOzU3FKzA3KiZmKlquoRK1VVj1ipqnrESlXVI37yH6j5JiBTanZAdmpuqdkB+SY1E0BO1HyCmr9JzQmQnZoTNZ+gZgdkSs0OyC01r1ipqnrESlXVI1aqqh6xUlX1iJWqqkf85A8AckPNLSA7NTeAnKjZqZkCcqJmB+REzQ0gOzUnQHZAvgnITs2Umh2QEzXfouYEyA7IDSCfAORbVqqqHrFSVfWIlaqqR6xUVT3iJ/8j1OyAfAKQKTU7NVNqbqiZAvK3qZkCslNzC8hOzTep2QG5oWYKyJSaEyA7NTdWqqoesVJV9YiVqqpHrFRVPWKlquoRP/kfpmYH5ETNDsgnADlRswNyomYCyImaKTU3gJyo+dOAnKjZqTkBsgPyL1JzAmQKyJSaKTU7IFNqditVVY9Yqap6xEpV1SNWqqoe8ZM/QM2/CMi3qLkFZKfmBMiEmhMgOzW3gOzUnACZUrNTMwVkp+ZEzQ7IiZpvUbMDMgVkSs0JkJ2aEyA7NSdAJlaqqh6xUlX1iJWqqkesVFU9YqWq6hH4Sw6A/IvUnAD5FjVTQHZqToD8aWqmgHyCmikgU2p2QKbU3AKyUzMF5ETNDsiUmh2QKTX/opWqqkesVFU9YqWq6hErVVWPwF9SVfWAlaqqR6xUVT1iparqEStVVY/4P35ZHn8tIQy2AAAAAElFTkSuQmCC\",\n \"expiration\": \"2025-12-31T15:09:45.333Z\",\n \"transactionId\": \"4000496659\",\n \"transactionIdentification\": \"kk6g232xel65a0daee4dd13kk4000496659\",\n \"type\": \"DYNAMIC\"\n }\n}"}],"_postman_id":"49b58da4-796d-4aae-95ed-7ea027eb3b11"},{"name":"Get Pix Keys","id":"8532abc8-cd57-4c6d-8c19-a60a3fc32b5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.
\n","type":"text"}]},"url":"{{generalApiAddress}}/pix_get_keys","description":"Retrieve all static PIX keys registered by the user, providing visibility into the identifiers available for receiving payments.
\nThis endpoint returns all static PIX keys associated with the authenticated user.
\n✔ PIX keys belonging to standard user accounts return:
\nA regular EVP key
\nimage returned as an empty string (\"\")
This indicates that the PIX key is not QR-based.
\n✔ PIX keys associated with subaccounts return:
\nA STATIC PIX payload instead of a random EVP key
\nThe image field populated with a Base64-encoded PNG containing the QR Code
The qrcode_identifier field is only present for subaccounts and identifies the associated QR Code.
This behavior allows partners to visually render the QR code and identify that deposits are associated with a subaccount.
\n","urlObject":{"path":["pix_get_keys"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"5ff36379-28b4-4a51-8540-06c9084bd8b2","name":"Success - Get Pix Keys Subaccount","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text"}]},"url":"{{generalApiAddress}}/pix_get_keys"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 19 Sep 2025 13:24:20 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"205"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"keys\": [\n {\n \"key\": \"00020126330014BR.GOV.BCB.PIX0111688202190265204000053039865802BR5912FULANO DE TAL6011TRES PASSOS61089860000062280524SubAccDep3fc34db557824696304DA3F\",\n \"type\": \"STATIC\",\n \"image\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAAAAklEQVR4AewaftIAAAutSURBVO3BUY4cyZIEQdNA3f/KuvzfdgIdSCbK35gI/pGqqgVOqqqWOKmqWuKkqmqJk6qqJU6qqpY4qapa4pO/ALKdmgmQG2puAPlfpmYCZKLmTUAmam4Amah5E5Dt1PzkpKpqiZOqqiVOqqqWOKmqWuKkqmqJk6qqJT65pOZbAHmamgmQiZo3qXkakBtAJmpuAJmoeROQpwG5oeaGmm8B5LdOqqqWOKmqWuKkqmqJk6qqJU6qqpY4qapa4pN/AMjT1DxNzZvUTIDcADJRMwEyUTMB8iY1EyBvUjMBMgEyUfMtgDxNzZNOqqqWOKmqWuKkqmqJk6qqJU6qqpY4qapa4pP/MCBvAvI0NTfUvAnIRM0EyNPUTIDcUFP/3klV1RInVVVLnFRVLXFSVbXESVXVEidVVUt88h+m5luomQC5AWSi5oaapwF5mpoJkBtqJkAmauoZJ1VVS5xUVS1xUlW1xElV1RInVVVLnFRVLfHJP6BmOyATNTfU3FBzQ80NIE9T8zQ1EyATNTeATNRMgDxNzdPUfLuTqqolTqqqljipqlripKpqiZOqqiVOqqqW+OQSkO2ATNRMgEzUTIBM1EyATNRMgEzU3FAzAfI0NRMgEzUTIBM1b1IzAfI0IJudVFUtcVJVtcRJVdUSJ1VVS5xUVS1xUlW1xCd/oea/CsjT1EyA3AAyUfM0IBM1TwPyNDU31EyAfAs1/6tOqqqWOKmqWuKkqmqJk6qqJU6qqpY4qapa4pO/ADJRMwFyQ80EyNPUTIC8Sc0EyJvUTIC8Sc0EyNOATNQ8DchEzQ0gEzU3gEzUTIDcUPOTk6qqJU6qqpY4qapa4qSqaomTqqolTqqqlsA/MgByQ80EyA01N4BM1NwA8iY1N4BM1EyAPE3N04B8CzVvAjJRMwFyQ80NIDfU/OSkqmqJk6qqJU6qqpY4qapa4qSqaomTqqolPvkLNTeA3FAzAfImIBM1EyATNRMgEyATNU9TcwPIDSA31EyA3FAzATIBMlHzJiA31NwAckPNb51UVS1xUlW1xElV1RInVVVLnFRVLXFSVbXEJ/+AmjepmQB5GpBvAWSi5gaQG2omQCZqJkBuqLkB5IaaCZAbaiZqJkAmam4Amai5AWSi5icnVVVLnFRVLXFSVbXESVXVEidVVUucVFUtgX9kASBvUnMDyETNBMhEzbcA8jQ1N4DcUHMDyETNDSA31NwAckPN04BM1PzkpKpqiZOqqiVOqqqWOKmqWuKkqmqJk6qqJT65BGSi5k1qbgCZAJmomaiZAJmomQC5oeZpaiZAngbkhpoJkImaiZoJkImab6FmAuQGkImaiZrfOqmqWuKkqmqJk6qqJU6qqpY4qapa4qSqaolP/gLIRM2b1EyATNS8CcgNIBM1EyATIN9CzQTIDTUTIBM1N4DcADJRMwHyLYBM1EyA3FDzk5OqqiVOqqqWOKmqWuKkqmqJk6qqJU6qqpb45BKQG2omQG6oeZqaCZAbaiZAJkAmap4GZKLmBpCJmgmQNwGZqLkB5E1Abqh5mpoJkN86qapa4qSqaomTqqolTqqqljipqlripKpqiU9eBuRpQJ4G5E1qJkAmQJ6m5gaQp6m5oWYCZKLmBpCJmjepmQB5GpCJmiedVFUtcVJVtcRJVdUSJ1VVS5xUVS1xUlW1xCd/oeZpQCZqvgWQiZqnAZmomQC5oeYGkImaCZAJkBtqbqiZALmh5gaQiZobQDZQ81snVVVLnFRVLXFSVbXESVXVEidVVUucVFUt8cklIDfUTIC8Sc0NIDfU3AAyUTMBcgPI09RMgNwAMlGzHZCJmomaCZA3AZmo+a2TqqolTqqqljipqlripKpqiZOqqiVOqqqWwD/yIiATNW8C8jQ1N4A8Tc0EyA01EyA31NwAckPNBMhEzQTIm9S8CchEzQTIDTU/OamqWuKkqmqJk6qqJU6qqpY4qapa4qSqaolP/gEgTwNyQ80NNU8D8iYgEzVvUnMDyETNBMjTgDxNzQZqJkAmaiZAfuukqmqJk6qqJU6qqpY4qapa4qSqaomTqqolPvkLIBM1EzUTIE9TMwEyUfM0IDfU3ADyLdRMgEzUfAs1bwIyUTMBMlHzNCATNRMgEzW/dVJVtcRJVdUSJ1VVS5xUVS1xUlW1xElV1RL4RwZAnqZmAmSiZgJkouZpQG6omQCZqNkAyETNm4BM1EyA3FAzATJRMwEyUXMDyETNm4BM1PzkpKpqiZOqqiVOqqqWOKmqWuKkqmqJk6qqJfCPXADyJjU3gLxJzQTIRM0EyETN04DcUPM0IBM1EyBPU3MDyHZqbgCZqPmtk6qqJU6qqpY4qapa4qSqaomTqqolTqqqlvjkL4BM1NwA8jQgN9RMgDxNzQTIt1AzAfI0IBM1EyBvAvI0NRMgEzU3gEzU3ADylpOqqiVOqqqWOKmqWuKkqmqJk6qqJU6qqpb45BKQiZobaiZAJmomQL4FkG8B5FuoeZqapwG5oWYC5E1q3qTmSSdVVUucVFUtcVJVtcRJVdUSJ1VVS5xUVS3xyf8AIDeATNRMgLxJzQTIDTUTINsBmaiZAJmomQB5mpobQCZq3gRkoua3TqqqljipqlripKpqiZOqqiVOqqqWOKmqWuKTLwLkhpqnAbkBZKJmAuRpam6omQCZAJmomQCZqLmhZgJkomYC5GlqbgC5AeSGmomaCZAnnVRVLXFSVbXESVXVEidVVUucVFUtcVJVtcQnf6HmBpAbaiZAJkAmat6kZgJkouZpQCZqbqiZAHmTmgmQG0BuqHkakImapwF5E5CJmp+cVFUtcVJVtcRJVdUSJ1VVS5xUVS1xUlW1xCdLqLkB5IaaG0BuAJmomaiZAHkakBtANlAzAfI0IE8D8jQgEzVvOamqWuKkqmqJk6qqJU6qqpY4qapa4qSqaolP/gLIRM0NNU8D8iYgN9RMgEyATNRM1EyATNTcUDMB8jQgN9RMgEzU3AAyUfM0NRMgN9RMgLzlpKpqiZOqqiVOqqqWOKmqWuKkqmqJk6qqJT75CzVPAzJRc0PN04B8CzUTIBM130LNDSATNTeATNTcADJRMwEyUTMBckPN09RMgEzU/NZJVdUSJ1VVS5xUVS1xUlW1xElV1RInVVVL4B+5AGSiZgLkTWomQG6o+RZA3qTmBpCJmqcBmaiZAJmoeRqQ+v/U/OSkqmqJk6qqJU6qqpY4qapa4qSqaomTqqolPrmk5oaaDdRMgEzU3AAyUXNDzQTIDSBvAjJR8zQ1TwMyUTMBMlHzNCA31EyATNT81klV1RInVVVLnFRVLXFSVbXESVXVEidVVUt88hdAtlPzLYDcAHIDyETNBMhEzQTIRM2b1EyAvEnNm4BM1DwNyFtOqqqWOKmqWuKkqmqJk6qqJU6qqpY4qapa4pNLar4FkKcBmai5oeZpQCZqJkAmaiZANgByQ80EyNOAPE3Nm9TcADJR85OTqqolTqqqljipqlripKpqiZOqqiVOqqqW+OQfAPI0NU9TMwEyATJR8zQgEzU31LwJyETNDSDfQs0EyNOAvEnNDSATNb91UlW1xElV1RInVVVLnFRVLXFSVbXESVXVEp/8hwF5GpCJmgmQiZoJkImaCZCJmqepmQCZqLkB5GlqvoWaG0AmaiZAbqh50klV1RInVVVLnFRVLXFSVbXESVXVEidVVUt8Ur+mZgLkhpoJkBtAJmomQG6ouaHmBpCJmqcBmaiZqJkAuQHkhppvAWSi5icnVVVLnFRVLXFSVbXESVXVEidVVUucVFUt8ck/oGYDNTeATNS8Sc0NIBM1N4BsAOSGmgmQG2puALkB5IaaCZAban7rpKpqiZOqqiVOqqqWOKmqWuKkqmqJk6qqJT65BGQ7IBM1N4BM1EyAPA3IDSATNTfUTIDcUDMBMlEzAXJDzQ0gN9T8F51UVS1xUlW1xElV1RInVVVLnFRVLXFSVbUE/pGqqgVOqqqWOKmqWuKkqmqJk6qqJU6qqpb4P1yNsblWrOpeAAAAAElFTkSuQm\",\n \"qrcode_identifier\": \"4a59b8b4-8daa-434f-ad3e-5c9551fac5b2\"\n }\n ]\n}"},{"id":"7860a095-ea0d-4689-96c1-efbc8ad1a8ed","name":"Success - Get Pix Keys","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text"}]},"url":"{{generalApiAddress}}/pix_get_keys"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.17.8"},{"key":"Date","value":"Tue, 18 Nov 2025 18:22:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"keys\": [\n {\n \"key\": \"90eb407b-dea1-41df-a071-e135321b51e7\",\n \"type\": \"EVP\",\n \"image\": \"\"\n }\n ]\n}"},{"id":"e0ed00ec-5ba3-492a-b165-5494051d1f8b","name":"Error - Get Pix Keys - ERROR PIX GET KEYS","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"MjMyNDUzNDIxOQFnDTKn3dBdUYVcHJad3NVQmE0SUMvVGcvajJRNzBUMzJLeFpXUDBydnpPbG41NW1TU1lOST","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text"}]},"url":"{{generalApiAddress}}/pix_get_keys"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 03 Dec 2025 01:18:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"47"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message_cod\": \"ERROR_PIX_GET_KEYS\"\n}"}],"_postman_id":"8532abc8-cd57-4c6d-8c19-a60a3fc32b5e"},{"name":"Create Pix Key","id":"44492712-4a88-4cc2-ad28-2b2358a3242d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.
\n","type":"text"}]},"url":"{{generalApiAddress}}/pix_create_key","description":"Create a new static PIX key for the authenticated account, enabling the user to receive payments through a unique identifier.
\nThis endpoint registers a new PIX key under the authenticated account. The created key can be used as a payment destination in future transactions, ensuring compliance with the Brazilian instant payment ecosystem (PIX).
\nThe OnRamp API enables partners to manage and query wallet funding operations, acting as the entry point for bringing funds into the ecosystem.
\nIt is responsible for account deposits and settlement of internal credits, ensuring that accounts remain properly funded and up to date.
\nThe OnRamp module provides endpoints for funding accounts, settling internal balances, and managing PIX receiving methods. It includes:
\nSettlement QRCode (get_settlement): Generates a QR Code to settle internal account debts.
Deposit QRCode (deposit_qrcode): Generates a QR Code for direct external deposits into the account.
Get Pix Keys (pix_get_keys): Retrieves all PIX keys registered under the authenticated account.
Create Pix Key (pix_create_key): Creates a new static PIX key to receive payments.
Differences between Settlement QRCode and Deposit QRCode:
\nNote: More endpoints will be added over time to expand subaccount functionality.
\n","_postman_id":"c8207e67-191d-43dc-a381-016e2ab99978"},{"name":"OffRamp","item":[{"name":"Offramp Create Beneficiary","event":[{"listen":"test","script":{"id":"7dcde66e-95a1-459f-8f7e-065e0da716e0","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"6b1d37a8-7c77-4216-8e13-5bbc72fd5eba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"account_name","value":"{account_name}","description":"(string, required): Reference name to identify the beneficiary within the account (alias/label).
\nExample: \"Main USD Account\"
\n","type":"text","uuid":"202d3fe5-3db9-4760-9a63-7308873e5b32"},{"key":"bank_name","value":"{bank_name}","description":"(string, required): Name of the bank where the account is registered.
\nExample: \"Bank of America\"
\n","type":"text","uuid":"39f8058c-c63c-46c2-9ab4-7571a6550aa6"},{"key":"account_holder_name","value":"{account_holder_name}","description":"(string, required): Full name or legal entity name of the account holder.
\nExample: \"John Doe\"
\n","type":"text","uuid":"b04d6b29-e175-43ea-a9e6-a92c5b05c790"},{"key":"currency","value":"{currency}","description":"(string, required): Currency code (ISO 4217), e.g., USD, EUR, BRL.\nExample: \"USD\"
\n","type":"text","uuid":"acbd04b5-66ed-445b-ab73-9b789deea06b"},{"key":"beneficiary_address","value":"{beneficiary_address}","description":"(object, required): Beneficiary’s address, used for KYC/KYB purposes.
\nExample: {\n \"city\": \"New York\",\n \"postal_code\": \"10001\",\n \"state\": \"NY\",\n \"country\": \"US\"\n}
\n","type":"text","uuid":"0d765152-6679-4602-8829-1d9df5a1653d"},{"key":"account_details","description":"(object, required): Bank account details
\nExample: {\n \"account_number\": \"123456789\",\n \"account_type\": \"checking\",\n \"routing_number\": \"021000021\"\n}
\n","type":"text","uuid":"7fdd7659-a259-4dbb-8af6-ff739ff63428","value":"{account_details}"}]},"url":"{{generalApiAddress}}/offramp_create_beneficiary","description":"Register a beneficiary (the recipient of funds) so that compliance and KYB (Know Your Business) checks can be performed before enabling transactions.
\nThis endpoint is required to onboard a new beneficiary into the system. By creating a beneficiary, partners ensure that transfers are linked to verified and approved recipients, complying with regulatory standards. Once registered, the beneficiary can be used in future payment operations within the OffRamp workflow.
\nNote: This endpoint is still under development and may be subject to changes.
\n","urlObject":{"path":["offramp_create_beneficiary"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b1d37a8-7c77-4216-8e13-5bbc72fd5eba"},{"name":"Offramp Get Beneficiary","id":"8c4e1db0-5288-435c-9372-bf665a24bd7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.
\n","type":"text","uuid":"cea16dca-0fac-48e6-9acc-eed3c03903b9"},{"key":"beneficiary_id","value":"{beneficiary_id}","description":"(string, required): System-generated beneficiary identifier.\nExample: \"4003\"
\n","type":"text","uuid":"0d331bce-452e-456d-a56a-a083f67dcf30"},{"key":"account_id","value":"{account_id}","description":"(string, required): Unique identifier of the account from which the beneficiary is being queried.
\nExample: \"4004\"
\n","type":"text","uuid":"4bdd8d88-7dd9-4b4a-8110-998e4b6ea7f8"}]},"url":"{{generalApiAddress}}/offramp_get_beneficiary","description":"Retrieve the details of a previously registered beneficiary.
\nThis endpoint provides access to compliance and identification data for an existing beneficiary. The lookup can be done using either the system-generated beneficiary_id as a unique identifier. It ensures that the beneficiary’s information is available and validated before executing payments, maintaining security and regulatory compliance across operations.
Note: This endpoint is still under development and may be subject to changes.
\n","urlObject":{"path":["offramp_get_beneficiary"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"49bef5b3-1234-4083-96dd-4406c4545ff8","name":"Success- Offramp Get Beneficiary","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"cea16dca-0fac-48e6-9acc-eed3c03903b9"},{"key":"beneficiary_id","value":"308d5c0f-a2fd-43ec-8492-8d6c140ee9b2","description":"(string, required): System-generated beneficiary identifier.\nExample: \"4003\"","type":"text","uuid":"0d331bce-452e-456d-a56a-a083f67dcf30"},{"key":"account_id","value":"819","description":"(string, required): Unique identifier of the account from which the beneficiary is being queried.\n\nExample: \"4004\"","type":"text","uuid":"4bdd8d88-7dd9-4b4a-8110-998e4b6ea7f8"}]},"url":"{{generalApiAddress}}/offramp_get_beneficiary"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"308d5c0f-a2fd-43ec-8492-8d6c140ee9b2\",\n \"type\": \"business\",\n \"taxid_type\": \"rfc\",\n \"taxid\": \"ABC123456XYZ\",\n \"name\": \"Tech Solutions S.A. de C.V.\",\n \"created_at\": \"2025-12-23T15:06:54.074Z\",\n \"updated_at\": \"2025-12-23T15:06:54.074Z\",\n \"providers\": [\n {\n \"id\": \"6abf41e2-7422-4900-b63d-2cec1df157fd\",\n \"provider\": \"sphere\",\n \"provider_id\": \"dummy_beneficiary_80c6549a-d8af-4ba6-bd0e-4ff71bcf2c77\",\n \"created_at\": \"2025-12-26T14:56:14.907Z\",\n \"updated_at\": \"2025-12-26T14:56:14.907Z\"\n }\n ],\n \"payment_methods\": [\n {\n \"id\": \"b1aa59fa-4b14-455c-9e62-cccf4e1b73e1\",\n \"created_at\": \"2025-12-26T14:56:14.928Z\",\n \"updated_at\": \"2025-12-26T14:56:14.928Z\",\n \"type\": \"bank\",\n \"bank_routing_number\": \"1234567891\",\n \"bank_account_number\": \"1234567890\",\n \"bank_account_type\": \"checking\",\n \"bank_currency\": \"USD\",\n \"providers\": [\n {\n \"id\": \"2c686564-505c-4416-bdab-9e7c2a9989e5\",\n \"provider\": \"sphere\",\n \"provider_id\": \"bankAccount_68499d9e1e2c4820967bef9340f1472c\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"8c4e1db0-5288-435c-9372-bf665a24bd7f"},{"name":"Offramp Beneficiary List","id":"4d83ed74-280f-44cb-8d5a-a6620a126dab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","type":"text","uuid":"0e1be4e9-3c4f-4898-91fc-3b7dcefa6698","description":"(string, required): The authentication token of the account used to authorize the request.
\n"}]},"url":"{{generalApiAddress}}/offramp_beneficiary_list","description":"Retrieve the list of beneficiaries registered by a client for off-ramp payments.
\nThis endpoint allows partners to access all beneficiaries previously created by the client for off-ramp operations. It provides essential information required to initiate off-ramp payments, ensuring that funds are transferred to verified recipients in a secure and compliant manner.
\n","urlObject":{"path":["offramp_beneficiary_list"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"50a484a2-7a14-4a3e-b1ff-29cac89de447","name":"Success - Offramp Beneficiary List","originalRequest":{"method":"POST","header":[{"key":"Referer","value":"{{headReferer}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","type":"text","uuid":"0e1be4e9-3c4f-4898-91fc-3b7dcefa6698","description":"(string, required): The authentication token of the account used to authorize the request."}]},"url":"{{generalApiAddress}}/offramp_beneficiary_list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"1d2a7f50-5ae5-48c3-ab16-6d1f9a318dcf\",\n \"type\": \"business\",\n \"taxid_type\": \"tin\",\n \"taxid\": \"1214565\",\n \"name\": \"testor3\",\n \"created_at\": \"2025-10-16T20:46:56.668Z\",\n \"updated_at\": \"2025-10-16T20:46:56.668Z\",\n \"payment_methods\": [\n {\n \"id\": \"05a0fd16-53d8-429c-8799-429a950033f6\",\n \"created_at\": \"2025-10-16T21:14:30.913Z\",\n \"updated_at\": \"2025-10-16T21:14:30.913Z\",\n \"type\": \"bank\",\n \"bank_routing_number\": \"1234567891\",\n \"bank_account_number\": \"1234567891\",\n \"bank_account_type\": \"checking\",\n \"bank_currency\": \"USD\"\n },\n {\n \"id\": \"20906e1c-6767-452b-9a00-28e44bbc8086\",\n \"created_at\": \"2025-10-16T20:47:36.947Z\",\n \"updated_at\": \"2025-10-16T20:47:36.947Z\",\n \"type\": \"bank\",\n \"bank_routing_number\": \"1234567891\",\n \"bank_account_number\": \"1234567891\",\n \"bank_account_type\": \"checking\",\n \"bank_currency\": \"USD\"\n }\n ]\n }\n ]\n}\n"}],"_postman_id":"4d83ed74-280f-44cb-8d5a-a6620a126dab"},{"name":"Offramp Payment","id":"62349679-0240-40e4-a230-0d6e9489abdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.
\n","type":"text","uuid":"f9d5074e-c33a-4374-8655-e9259de469d9"},{"key":"data","value":"{\"quote_id\": \"{{offramp_quote_id}}\",\"document_ids\": [\"3ab7ade9-e88f-4ab8-8a6d-9ead6607a8d8\"],\"reference\": \"INV-2025-001\",\"purpose\":\"PaymentsForGoodsOrServices\"}\n","description":"(object, required): Data object containing all required details to create an off-ramp payment, iquote ID, associated documents, reference and purpose of the transaction\nExample: \n{\n \"quote_id\": \"op_1234567890\",\n \"document_ids\": [\"doc_001\"],\n \"reference\": \"INV-2025-001\",\n \"purpose\": \"PaymentsForGoodsOrServices\"\n}
\n","type":"text","uuid":"66a9975c-d15c-4dd3-98a9-dea9c00fd8ed"}]},"url":"{{generalApiAddress}}/offramp_payment","description":"Initiate an off-ramp payment that converts funds from BRL or cryptocurrency into fiat currency (e.g., USD, EUR) and transfers them to a registered beneficiary.
\nThis endpoint facilitates off-ramp operations by creating a payment transaction that settles as fiat currency. It supports sources such as BRL in account or supported cryptocurrencies, leveraging previously generated quotes when necessary. The system ensures secure, compliant, and auditable settlements with international payment networks. Off-ramp payments may involve multiple sub-transactions, including crypto transfers and optional RFQ-based crypto purchases, depending on the client’s chosen flow.
\ndata :Note: This endpoint is under active development. Behavior and parameters may evolve as additional source types and integrations are implemented.
\n","urlObject":{"path":["offramp_payment"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"be0a4c60-68d4-4966-8cb1-668f9ab34822","name":"Success - Offramp Payment","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"f9d5074e-c33a-4374-8655-e9259de469d9"},{"key":"data","value":"{\"quote_id\": \"op_1234567890\",\"document_ids\": [\"doc_001\"],\"reference\": \"INV-2025-001\",\"purpose\":\"PaymentsForGoodsOrServices\"}","description":"(object, required): Data object containing all required details to create an off-ramp payment, iquote ID, associated documents, reference and purpose of the transaction.\nExample: \n{\n \"quote_id\": \"op_1234567890\",\n \"document_ids\": [\"doc_001\"],\n \"reference\": \"INV-2025-001\",\n \"purpose\": \"PaymentsForGoodsOrServices\",\n}\n","type":"text","uuid":"f6f231c1-3d11-4a30-b81f-a5fac8659129"}]},"url":"{{generalApiAddress}}/offramp_payment"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"op_1234567890\",\n \"status\": \"PROCESSING\",\n \"amount\": 1500.75,\n \"fee\": 15.25,\n \"provider_transaction_id\": \"tx_9876543210\",\n \"reference\": \"INV-2025-001\",\n \"purpose\": \"PaymentsForGoodsOrServices\",\n \"created_at\": \"2025-10-27T11:15:00Z\"\n}"}],"_postman_id":"62349679-0240-40e4-a230-0d6e9489abdd"},{"name":"Offramp Quote","id":"d992b465-84a1-4921-a96b-6c903b1dfdf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","type":"text","uuid":"0e1be4e9-3c4f-4898-91fc-3b7dcefa6698","description":"(string, required): The authentication token of the account used to authorize the request.
\n"},{"key":"data","value":"{\"source_amount\":10000,\"target\":\"USD\",\"network\":\"WIRE\",\"source\":\"USDC\",\"beneficiary_id\":\"d94b5cc4-ea63-48e4-b717-93132e8e3dd5\"}","type":"text","uuid":"d61ae4a7-49d9-40f6-b709-45776f8d69de","description":"(object, required): Contains the parameters required to calculate the off-ramp quote, source, asset, network, and transaction amount.
\nNote: When the currency is a fiat currency, specific decimal precision rules apply:
\nExample: 150.75 → represents R$150.75
\nExample: 20.00 → represents R$20.00
\nExample: 15.1234 → represents US$15.1234
\nExample: 0.5000 → represents US$0.5000
\nData Example:\n{\n \"source_amount\": 10000,\n \"target\": \"USD\",\n \"network\": \"WIRE\",\n \"source\":\"USDT\",\n \"beneficiary_id\":\"d01bf4ef-2724-4226-9af8-fb284a9eb567\"\n}\nS
\n"}]},"url":"{{generalApiAddress}}/offramp_quote","description":"Generate an off-ramp quote that combines RFQ purchase costs with off-ramp fees.
\nThis endpoint analyzes the total off-ramp costs a client will incur, including both the fees associated with off-ramping and any additional purchase costs from RFQ when the source asset is not a stablecoin already available in the user’s account. It returns a unique quote ID representing the combined operation, which must be used to execute the offramp_payment endpoint. This process ensures accurate cost estimation and a unified quotation for clients converting their assets into fiat through the Bity ecosystem.
data :(string, required): The authentication token of the account used to authorize the request.
\n"},{"key":"data","value":"{\"scope\":\"transaction\",\"type\":\"invoice\",\"purpose\":\"Invoice for service payment\",\"label\":\"Payment_Invoice_Oct2025\"}","type":"text","uuid":"38ba6991-81ad-4186-9707-e0e7e9061848","description":"(object, required): Contains metadata about the document being uploaded, including its scope, type, and purpose.\nExample:
\n{\n \"scope\": \"transaction\",\n \"type\": \"invoice\",\n \"purpose\": \"Invoice for service payment\",\n \"label\":\"Payment_Invoice_Oct2025\"\n}
\n"},{"key":"file","type":"text","uuid":"4d82a5b9-226a-4b7e-9d26-7e906f9cee93","value":"JVBERi0xLjMKJ.....dX2drYkel1Q2zq+vB9WFhZjEzMjQ5OGY2NTBlN2JkZTZjZGMyZj4gXSA+PgpzdGFydHhyZWYKMTgxMzIKJSVFT0YK","description":"(base64, required): The document file encoded in Base64 to be uploaded, such as a PDF, JPG, or PNG, representing the proof or invoice related to the off-ramp transaction.
\n"}]},"url":"{{generalApiAddress}}/offramp_document","description":"Upload a document required for compliance validation in an off-ramp payment.
\nThis endpoint allows attaching or referencing a document (typically an invoice) related to an off-ramp transaction. The document serves as proof of the payment’s purpose and is required to comply with regulatory and operational requirements before releasing funds to the beneficiary.
\ndata:Note: This endpoint is currently under development and may be subject to changes.
\n","urlObject":{"path":["offramp_document"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[{"id":"b748dd5c-87f4-4b7f-a520-ffc0e13f9bea","name":"Success - Offramp Document","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","type":"text","uuid":"06608319-fb2a-419c-9a74-2a8855c324ff","description":"(string, required): The authentication token of the account used to authorize the request."},{"key":"data","value":"{\"scope\":\"transaction\",\"type\":\"invoice\",\"purpose\":\"Invoice for service payment\",\"label\":\"Payment_Invoice_Oct2025\"}","type":"text","uuid":"38ba6991-81ad-4186-9707-e0e7e9061848","description":"(object, required): Contains metadata about the document being uploaded, including its scope, type, and purpose.\nExample:\n\n{\n \"scope\": \"transaction\",\n \"type\": \"invoice\",\n \"purpose\": \"Invoice for service payment\",\n \"label\":\"Payment_Invoice_Oct2025\"\n}"},{"key":"file","type":"text","uuid":"4d82a5b9-226a-4b7e-9d26-7e906f9cee93","value":"JVBERi0xLjMKJ.....dX2drYkel1Q2zq+vB9WFhZjEzMjQ5OGY2NTBlN2JkZTZjZGMyZj4gXSA+PgpzdGFydHhyZWYKMTgxMzIKJSVFT0YK","description":"(base64, required): The document file encoded in Base64 to be uploaded, such as a PDF, JPG, or PNG, representing the proof or invoice related to the off-ramp transaction."}]},"url":"{{generalApiAddress}}/offramp_document"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 27 Oct 2025 16:00:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"89"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"provider\": \"sphere\",\n \"id\": \"e13fcab7-c99c-480e-a48a-12f972001c7c\"\n }\n}"}],"_postman_id":"b23c4f38-7cee-413a-b16e-6d6f1b2efe05"},{"name":"Get IN1888 Report","id":"80137ca0-9479-4477-81dd-93a081113d8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.
\n","type":"text","uuid":"5db7cfa8-0983-4be5-b8c4-dd1276b9ec7e"},{"key":"month","value":"{month}","description":"(integer, required): The month for which the report should be generated (1–12).
\n","type":"text","uuid":"dd568b43-a05d-4210-84bc-0584ea15990c"},{"key":"year","value":"{year}","description":"(integer, required): The year for which the report should be generated (e.g., 2025).
\n","type":"text","uuid":"0b137a67-c7df-45ae-9327-6cd898477834"}]},"url":"{{generalApiAddress}}/get_offramp_in1888","description":"Generate the IN1888 report for off-ramp payments executed in a specific month and year, providing compliance and reporting capabilities.
\nThe get_offramp_in1888 endpoint allows partners to retrieve a detailed report of all off-ramp payments (fiat withdrawals) for a given period. This report is designed to support regulatory compliance and internal accounting processes.
Note: This endpoint is still under development and may be subject to changes.
\n","urlObject":{"path":["get_offramp_in1888"],"host":["{{generalApiAddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"80137ca0-9479-4477-81dd-93a081113d8d"}],"id":"9f3f01bb-b084-4de5-9532-ed25be203065","description":"The OffRamp module provides endpoints to manage payments that convert funds from BRL or cryptocurrency into fiat currencies (USD, EUR, etc.) and to handle associated compliance reporting.
\nIt allows partners to create and manage beneficiaries, initiate off-ramp payments, and generate regulatory reports efficiently and securely.
\nOfframp Create Beneficiary– Registers a new beneficiary (recipient) for off-ramp payments.
\nOfframp Get Beneficiary – Retrieves information about an existing beneficiary.
\nOfframp Beneficiary List – Retrieve all beneficiaries registered by the client for off-ramp payments.
\nOfframp Payment – Creates a payment converting BRL or cryptocurrency into fiat, transferring funds to a registered beneficiary while ensuring compliance with regulatory and operational requirements.
\nOfframp Quote – Estimates the total off-ramp costs, including RFQ purchase fees when needed, and returns a unique quote ID to be used for initiating an off-ramp payment.
\nOfframp Document – Attaches or references a document (usually an invoice) for an off-ramp transaction, serving as proof for compliance and operational approval before releasing funds.
\nGet IN1888 Report – Generates an IN1888 report for off-ramp payments for a specific month and year.
\nNote: More endpoints will be added over time to expand subaccount functionality.
\n","_postman_id":"9f3f01bb-b084-4de5-9532-ed25be203065"},{"name":"Webhooks","item":[{"name":"Set Webhook","id":"001908f8-5349-415b-97a1-4016aa317639","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.
\n","type":"text","uuid":"75d400b8-2c6d-4412-a77d-ca9f600ac7d0"},{"key":"url","value":"https://hooker-w5yok3yz.bp-staging.biscoint.io/wb-test","description":"(string, required): The fully qualified URL that will receive webhook notifications for wallet events
\n","type":"text","uuid":"1c704adb-2314-449c-bcac-2b07af003b73"},{"key":"new_signature","value":"false","description":"(boolean, optional): If true, generates a new signature for the webhook. If false (default), keeps the current signature.
\n","type":"text","uuid":"f3c6516f-096c-4174-9039-bc80e1a51f16"},{"key":"enabled","value":"true","description":"(boolean, optional): If true, enables the webhook service. If false, disables it.
\n","type":"text","uuid":"24661733-4e9e-4d51-a585-6d3ce8c71c9a"}]},"url":"{{publicTradingApi}}/set_webhook","description":"Configure a callback URL to receive real-time notifications for wallet events, enabling partners to automate workflows and monitor wallet activity efficiently.
\nThe set_webhook endpoint allows partners to define a URL that will be triggered whenever specific wallet events occur. This ensures timely notifications and facilitates automation of operational processes.
Note: This endpoint is still under development and may be subject to changes.
\n","urlObject":{"path":["set_webhook"],"host":["{{publicTradingApi}}"],"query":[],"variable":[]}},"response":[{"id":"10dc7342-eba2-41ba-b627-b3797c1d270f","name":"Success - Set Webhook","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"75d400b8-2c6d-4412-a77d-ca9f600ac7d0"},{"key":"url","value":"https://hooker-w5yok3yz.bp-staging.biscoint.io/wb-test","description":"(string, required): The fully qualified URL that will receive webhook notifications for wallet events","type":"text","uuid":"1c704adb-2314-449c-bcac-2b07af003b73"},{"key":"new_signature","value":"false","description":"(boolean, optional): If true, generates a new signature for the webhook. If false (default), keeps the current signature.","type":"text","uuid":"f3c6516f-096c-4174-9039-bc80e1a51f16"},{"key":"enabled","value":"true","description":"(boolean, optional): If true, enables the webhook service. If false, disables it.","type":"text","uuid":"8ee93da6-8ad0-468c-81d0-6f381fdb574a"}]},"url":"{{publicTradingApi}}/set_webhook"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Mon, 08 Sep 2025 15:13:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"216"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"},{"key":"Set-Cookie","value":"__goc_session__=htocnmrsqubjqjuaygwcmmlahmjtqyug; expires=Mon, 15-Sep-25 15:13:58 GMT; SameSite=Lax; path=/; secure; HttpOnly"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-GoCache-CacheStatus","value":"BYPASS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"gocache"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"0343b504-b9c2-4b26-9b73-bdae014d29fb\",\n \"url\": \"https://hooker-w5yok3yz.bp-staging.biscoint.io/wb-test\",\n \"signing_key\": \"{signing_key}\",\n \"enabled\": true\n }\n}"}],"_postman_id":"001908f8-5349-415b-97a1-4016aa317639"},{"name":"Get Webook Config","id":"79db93f0-9124-43fd-bc77-a98f64a26119","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.
\n","type":"text","uuid":"75d400b8-2c6d-4412-a77d-ca9f600ac7d0"}]},"url":"{{publicTradingApi}}/get_webhook_config","description":"Retrieve the current webhook configuration to verify the callback URL, obtain the signing key, and review metadata for your account's webhook setup.
\nThe get_webhook_config endpoint allows partners to fetch their existing webhook configuration, including the callback URL, signing key for signature validation, and timestamps. This enables partners to verify their webhook setup, securely store the signing key for validating incoming notifications, and audit configuration changes.
Note: This endpoint is still under development and may be subject to changes
\n","urlObject":{"path":["get_webhook_config"],"host":["{{publicTradingApi}}"],"query":[],"variable":[]}},"response":[{"id":"70c5671f-ac06-43e6-a769-a1b390f9b537","name":"Success - Get Webook Config","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"auth_token","value":"{{auth_token}}","description":"(string, required): The authentication token of the account used to authorize the request.","type":"text","uuid":"75d400b8-2c6d-4412-a77d-ca9f600ac7d0"}]},"url":"{{publicTradingApi}}/get_webhook_config"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"9dbdbbe7-5cef-46b9-8261-23890392aae3\",\n \"signing_key\": {signing_key},\n \"url\": {url},\n \"user_id\": {user_id},\n \"created_at\": \"2025-09-08T14:58:09.000Z\",\n \"updated_at\": \"2025-09-08T14:58:09.000Z\",\n \"enabled\": true\n }\n}"}],"_postman_id":"79db93f0-9124-43fd-bc77-a98f64a26119"}],"id":"1876d0cf-cc4c-4dc0-a7f2-ed6bfb45d660","description":"The purpose of the Webhooks section within Wallet is to enable real-time notifications for wallet events.
\nCurrently available endpoints:
\nSet Webhook: configure a callback URL that will be triggered when specific wallet events occur. This endpoint allows partners to automate workflows and receive immediate updates about wallet activities and enhancing operational efficiency.
\nGet Webhook Configuration: retrieve the current webhook configuration including the callback URL, signing key, and metadata for your account. This endpoint allows partners to verify their webhook setup and obtain the signing key needed for validating incoming webhook notifications.
\nAll webhook notifications follow the same minimal JSON structure. This makes it easier for partners to process events and map each notification to its corresponding data schema.
\nEvery webhook delivered to your callback URL has the following format:
\njson
\n{\n \"code\": \"ANY_EVENT_CODE\",\n \"data\": {\n // Variable structure depending on the event.\n }\n}\n\nThe following webhook events are currently available:
\nACCOUNT_STATUS_CHANGE – Triggered when a user’s account status updates.
DEPOSIT_STATUS_CHANGE – Triggered when a deposit status changes.
DEPOSIT_AUTO_SWEEP – Triggered when a internal sweep deposit event occurs.
WITHDRAWAL_STATUS_CHANGE – Triggered when a withdrawal status changes.
ORDER_STATUS_CHANGE – Triggered when an order is partially or fully executed.
PIXMED_STATUS_CHANGE - Triggered when a PIX MED dispute is requested, updated, or resolved.
Event Trigger: Triggered when a user's account status changes (e.g., from pending to verified).
\nData Fields: user_id, old_status, new_status
{\n \"code\": \"ACCOUNT_STATUS_CHANGE\",\n \"data\": {\n \"user_id\": \"87463\",\n \"old_status\": \"ACTIVE\",\n \"new_status\": \"BLOCKED\"\n }\n}\n\nEvent Trigger: Triggered when a deposit status changes.
\nData Fields: user_id, transaction_data, qrcode_identifier
Observation:
\nThe user_id field always refers to the user account that effectively received the deposit (main account or subaccount).
The transaction_data field follows the exact same response structure returned by the Get Transaction endpoint.
The qrcode_identifier field is only present for subaccounts, and identifies the QR Code associated with that specific subaccount deposit status change.
{\n \"code\": \"DEPOSIT_STATUS_CHANGE\",\n \"data\": {\n \"user_id\": \"87463\",\n \"qrcode_identifier\": \"4a59b8b4-8daa-434f-ad3e-5c9551fac5b2\",\n \"transaction_data\": {\n // Full Get Transaction response structure...\n \"extra_data\": {\n \"description\": \"Withdrawal via Pix\"\n // Remaining extra_data fields... \n }\n }\n }\n}\n\nEvent Trigger: Triggered when a internal sweep deposit event occurs.
\nData Fields:
\nfrom_user_id – User ID where the sweep originated;
to_user_id – User ID receiving the sweep;
qrcode_identifier – field is only present for deposits made to subaccounts, and identifies the QR Code associated with that specific subaccount deposit.
transaction_data– Data of the deposit to which the sweep refers. Use the id inside transaction_data to query the deposit using the Get Transaction endpoint.
Observation:
\nThe DEPOSIT_AUTO_SWEEP event is triggered only after this internal transfer is completed. The only possible status is COMPLETE — there are no intermediary states.
The DEPOSIT_AUTO_SWEEP event is triggered only if the original deposit is credited to a subaccount and an internal transfer to the main account occurs.
The transaction_data field follows the exact same response structure returned by the Get Transaction endpoint when querying a deposit.
{\n \"code\": \"DEPOSIT_AUTO_SWEEP\",\n \"data\": {\n \"from_user_id\": \"1234\",\n \"to_user_id\": \"5678\",\n \"qrcode_identifier\": \"4a59b8b4-8daa-434f-ad3e-5c9551fac5b2\"\n \"transaction_data\": { \n \"id\": \"53860640\", \n \"created\": \"2025-12-15 12:21:40\",\n \"concluded\": \"2025-12-15 12:21:41\",\n \"currency\": \"BRL\",\n \"type\": \"DEPOSIT\",\n \"amount\": 10,\n \"fee\": 0.02,\n \"balance\": 74.2,\n \"address\": \"001|1234|12345\",\n \"tx_id\": \"E33938907654401413xwBoxcNVDsFCfe\",\n \"external_id\": \"a3f5b21e-98c2-4c6f-9d4b-2a5e1f5e8d90\",\n \"blockchain\": \"\",\n \"confirmations\": \"\",\n \"status\": \"COMPLETE\",\n \"transaction_id\": \"53860641\",\n \"extra_data\": {\n \"provider\": \"CELCOIN\",\n \"description\": \"Withdrawal via Pix\",\n \"from\": {\n \"name\": \"Gustavo Peixoto\",\n \"tax_id\": \"13086457082\",\n \"bank\": {\n \"code\": \"237\",\n \"branch\": \"0740\",\n \"account\": \"61501\",\n \"account_type\": \"CHECKING\"\n }\n }\n }\n }\n }\n}\n\nEvent Trigger: Triggered when a withdrawal status changes, passing the transaction data and the new status.
\nData Fields: user_id, transaction_data
Observation: The transaction_data field follows the exact same response structure returned by the Get Transaction endpoint.
{\n \"code\": \"WITHDRAWAL_STATUS_CHANGE\",\n \"data\": {\n \"user_id\": \"87463\",\n \"transaction_data\": {\n \"address\": \"001|0000|******|CHECKING|pix:test@example.com\",\n // Full Get Transaction response structure...\n \"extra_data\": {\n \"provider\": \"CELCOIN\",\n \"description\": \"Withdrawal via Pix\",\n // Remaining extra_data fields... \n }\n }\n }\n }\n}\n\nEvent Trigger: Triggered when an order status change.
\nData Fields: user_id, order_data
Observation: The order_data field mirrors the response schema of the Order Status endpoint.
{\n \"code\": \"ORDER_STATUS_CHANGED\",\n \"data\": {\n \"user_id\": \"87463\",\n \"order_data\": {\n // Full Get Transaction response structure...\n }\n }\n}\n\nEvent Trigger: Triggered when the recipient of a deposit requests PIX MED — claiming that the transaction is fraudulent or stolen.
\nData Fields: user_id, transaction_data
Observation:
\nThe transaction_data field mirrors the exact structure returned by the Get Transaction endpoint.
PIX MED field behavior: The pixmed field is returned only when a PIX MED request exists. If PIX MED is not requested, this field is omitted entirely
{\n \"code\": \"PIXMED_STATUS_CHANGE\",\n \"data\": {\n \"user_id\": \"87463\",\n \"transaction_data\": {\n // Full Get Transaction response structure...\n ...\n \"extra_data\": {\n \"provider\": \"CELCOIN\",\n \"from\": {\n \"name\": \"Gustavo Peixoto\",\n \"tax_id\": \"13086457082\",\n \"bank\": {\n \"code\": \"237\",\n \"branch\": \"0740\",\n \"account\": \"61501\",\n \"account_type\": \"CHECKING\"\n }\n },\n \"pixmed\": {\n \"status\": \"<PIX MED Status Code>\"\n }\n }\n }\n }\n}\n\nThis section shows how to validate a webhook signature using HMAC SHA-256 with the secret provided when integrating external service callbacks.
\nRead the RAW request body, without altering it
\n⚠️ Do not parse it to JSON first
\n⚠️ Do not use middleware that changes the body (such as bodyParser.json()) before computing the hash
Generate the HMAC SHA-256 hash using your secret
\nConvert the result to hexadecimal
\nCompare it with the signature header
If they differ → reject the request
\nIf the body is modified or converted to JSON before calculation,
\nthe signature will not match.
\nEach example below shows how to correctly capture the raw body.
\nimport crypto from \"crypto\";\n// Body must be RAW, not JSON.parse\nconst rawBody = req.rawBody; // e.g., express.raw() middleware\nconst secret = webhook.secret;\nconst signature = crypto\n .createHmac(\"sha256\", Buffer.from(secret))\n .update(rawBody)\n .digest(\"hex\");\nif (signature !== req.headers[\"signature\"]) {\n console.log(\"Invalid signature\");\n}\n\nNote (Express):
\nUse app.use(express.raw({ type: 'application/json' })) to capture the raw body.
$secret = $webhook['secret'];\n// Raw request body\n$body = file_get_contents('php://input');\n$signatureHeader = $_SERVER['HTTP_SIGNATURE'];\n$signature = hash_hmac('sha256', $body, $secret);\nif ($signature !== $signatureHeader) {\n echo \"Invalid signature\";\n}\n\n✔ php://input ensures the body remains unaltered.
import javax.crypto.Mac;\nimport javax.crypto.spec.SecretKeySpec;\nimport java.nio.charset.StandardCharsets;\n// Read raw body\nString body = request.getReader().lines().reduce(\"\", (acc, line) -> acc + line);\nString secret = webhook.getSecret();\nString expectedSignature = request.getHeader(\"signature\");\nMac hmac = Mac.getInstance(\"HmacSHA256\");\nhmac.init(new SecretKeySpec(secret.getBytes(StandardCharsets.UTF_8), \"HmacSHA256\"));\nString signature = bytesToHex(hmac.doFinal(body.getBytes(StandardCharsets.UTF_8)));\nif(!signature.equals(expectedSignature)) {\n System.out.println(\"Invalid signature\");\n}\n// Helper\nprivate static String bytesToHex(byte[] bytes) {\n StringBuilder sb = new StringBuilder();\n for (byte b : bytes)\n sb.append(String.format(\"\u0002x\", b));\n return sb.toString();\n}\n\nusing System.Security.Cryptography;\nusing System.Text;\n// Raw body\nstring body;\nusing (var reader = new StreamReader(Request.Body))\n body = await reader.ReadToEndAsync();\nstring secret = webhook.Secret;\nstring expectedSignature = Request.Headers[\"signature\"];\nusing var hmac = new HMACSHA256(Encoding.UTF8.GetBytes(secret));\nstring signature = BitConverter\n .ToString(hmac.ComputeHash(Encoding.UTF8.GetBytes(body)))\n .Replace(\"-\", \"\")\n .ToLower();\nif (signature != expectedSignature) {\n Console.WriteLine(\"Invalid signature\");\n}\n\n✔ Request.Body gives you access to the original content.
package main\nimport (\n \"crypto/hmac\"\n \"crypto/sha256\"\n \"encoding/hex\"\n \"fmt\"\n \"io/ioutil\"\n \"net/http\"\n)\nfunc handler(w http.ResponseWriter, r *http.Request) {\n secret := []byte(webhook.Secret)\n // Raw body\n body, _ := ioutil.ReadAll(r.Body)\n receivedSig := r.Header.Get(\"signature\")\n mac := hmac.New(sha256.New, secret)\n mac.Write(body)\n expectedSig := hex.EncodeToString(mac.Sum(nil))\n if expectedSig != receivedSig {\n fmt.Println(\"Invalid signature\")\n }\n}\n\n✔ ioutil.ReadAll(r.Body) retrieves the original bytes.
import hmac\nimport hashlib\nfrom flask import request\nsecret = webhook[\"secret\"]\n# Raw body in bytes\nbody = request.data\nreceived_sig = request.headers.get(\"signature\")\nsignature = hmac.new(\n key=secret.encode(\"utf-8\"),\n msg=body,\n digestmod=hashlib.sha256\n).hexdigest()\nif signature != received_sig:\n print(\"Invalid signature\")\n\n✔ request.data returns the exact payload received.
If the RAW body is modified, the signature will never match.
\n","_postman_id":"1876d0cf-cc4c-4dc0-a7f2-ed6bfb45d660"}]}