📝 Changelog
How to read this page
2026-09-17
MISSING_PARAMETER, INVALID_PARAMETER, CONFLICTING_PARAMETERS, IDENTIFICATION_REQUIRED, NO_BANKING_NODE_AVAILABLE, DEPOSIT_NOT_FOUND and WITHDRAW_NOT_FOUND. They are not new: the API already sends them, and this entry only adds them to the documentation. IDENTIFICATION_REQUIRED is missing from some of the refusals it names, as its row explains: do not rely on that code alone. The table now also lists GET /user-info among the endpoints that send END_USER_NOT_FOUND.2026-09-15
invalid_pix_key in refund.reason, where it previously reported payout_failure. Returns recorded before this change keep the old value, and payout_failure is no longer sent for new ones. The fee is unchanged: both withhold 1 DePix.2026-09-14
refund on GET /api/withdraw-status and on the withdraw webhook. Once the return of a withdrawal's DePix is recorded as sent, it carries the Liquid transaction id of the return (txId), the reason, who started it, the fee withheld and the amount returned.euid that refer to different people now read The tax-number and EUID you provided refer to different people. instead of please provide tax number or EUID, not both, and a blocked end user reads The end user with tax-number … is blocked and cannot deposit (or withdraw) instead of this user is blocked (or This user is blocked and cannot withdraw.). A refusal coded INTERNAL_ERROR no longer quotes a numbered internal error. The messageCode of all three is unchanged: branch on it, never on the message text.2026-09-09
POST /deposit. depixAddress and depixSplitAddress now accept a Spark address (spark1…) as well as a Liquid or an Arkade one. The network is still read from the address itself: there is no parameter naming a network. Your configured default address is classified the same way. Withdrawals are unchanged and still receive DePix on Liquid only. Spark is in beta: please do not use it in production yet, and do not test it with substantial amounts. We will post here when it is ready for production use.is not a Liquid or Arkade address to is not a Liquid, Arkade or Spark address. The messageCode is unchanged: it is still DEPOSIT_ADDRESS_NETWORK_UNKNOWN. Branch on the code, never on the message text.2026-09-07
POST /deposit. depixAddress and depixSplitAddress now accept an Arkade address (ark1…) as well as a Liquid one, and the network the DePix is paid out on is read from the address itself: there is no parameter naming a network. Your configured default address is classified the same way. Withdrawals are unchanged and still receive DePix on Liquid only. Arkade is in beta: please do not use it in production yet, and do not test it with substantial amounts. We will post here when it is ready for production use.POST /deposit, each with its own messageCode, all raised when the QR is created and before any Pix can be paid into it: an address that is neither Liquid nor Arkade (DEPOSIT_ADDRESS_NETWORK_UNKNOWN), a split address on a different network from the payout (SPLIT_ADDRESS_NETWORK_MISMATCH), and a network whose wallet is not payable at that moment (NETWORK_WALLET_UNAVAILABLE, transient: retry later). See Message codes.2026-09-05
messageCode on business refusals from the operation endpoints. A stable, append-only string naming the condition, sent next to errorMessage whenever the condition has a stable name; branch on it instead of on the text. Where a denialCode also exists the two carry the same value. See Errors & the response envelope.2026-08-21
refundAddress now withholds a fee of 1 DePix when the payout could not be completed because of the request itself: the Pix key does not belong to the informed taxNumber, or the Pix key is invalid or was rejected at payout. The fee comes out of the amount returned. No fee is withheld when the failure was not on the request: our side or the banking processor broke, or the DePix that arrived did not match what the withdrawal expected. See Withdraw.2026-08-07
refundAddress on POST /withdraw. An optional Liquid address where your DePix is returned if the withdrawal cannot be completed. It has to be sent on the request and cannot be supplied afterwards: without it, a failed withdrawal waits until our team can reach you to ask where to send the funds. The recorded value comes back on GET /api/withdraw-status. See Withdraw./addclientcredentials <label> [<scope>] on Telegram issues a client_id / client_secret pair, which you exchange at POST /api/v2/auth/login for a short-lived access token plus a rotating refresh token; renew at POST /api/v2/auth/refresh and end a session at POST /api/v2/auth/logout. Manage the pairs with /listclientcredentials and /removeclientcredentials <label>. See Authentication./apitoken and existing long-lived tokens are unaffected and there is no migration deadline.Why the change
2026-06-12
X-Async: true is rejected with 400 ("X-Async: true is no longer supported"), and there is no more 202 Accepted / urlResponse polling. A slow request now surfaces as a 503 timeout. See Synchronous requests & safe retries.2026-06-11
Documentation cleanup
2026-05-26
merchantId (the Merchant ID / EMID) is now accepted as an optional field on POST /deposit.2026-05-01
POST /withdraw now requires beneficiary identification. Send at least one of taxNumber (CPF/CNPJ of the Pix key owner) or euid. If you send both, they must match — the request is rejected outright when they disagree.Action required
POST /withdraw before this date, update your calls to include taxNumber and/or euid. Requests without beneficiary identification are rejected.2026-01-13
POST /deposit. Set delayDepixInHours (integer, 1–720) to hold a deposit until a later time instead of processing it immediately. When set, GET /deposit-status returns delayUntil (ISO 8601) indicating when the deposit will be processed, and the deposit reports the delayed status until then.Modified at 2026-09-17 12:11:56