Noviuz DocsAPI NexiuzTry API
Simular desfecho de saque (TEST)
POST
/api/public/v1/withdrawals/{withdrawal_id}/simulate-outcomeSimula o desfecho de um saque somente no ambiente TEST.
Required application scope: withdrawals:write.
Authorization
BearerAuth RequestSignature AuthorizationBearer <token>
In: header
X-Signature<token>
HMAC-SHA256 calculado com signing_secret sobre timestamp.nonce.METHOD.path.sha256(body). O Try API não recebe nem armazena o segredo: calcule a assinatura no seu ambiente e cole o valor aqui.
In: header
Path Parameters
withdrawal_id*Withdrawal Id
Format
uuidHeader Parameters
X-Timestamp*string
Timestamp Unix em segundos.
Match
^[0-9]{1,12}$X-Nonce*string
Nonce único por requisição (16–128 caracteres).
Match
^[A-Za-z0-9_-]{16,128}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
D28 (E20): o outcome é o enum da F2 e é obrigatório — corpo vazio não liquida.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/public/v1/withdrawals/497f6eca-6276-4993-bfeb-53cbbbba6f08/simulate-outcome" \ -H "X-Timestamp: string" \ -H "X-Nonce: string" \ -H "Content-Type: application/json" \ -d '{ "outcome": "success" }'{ "id": "string", "code": "string", "account_id": "string", "amount": "string", "net_amount": "string", "fee": "string", "status": "string", "environment": "string", "destination": { "rail": "string", "pix_key": "string", "pix_key_type": "string", "beneficiary_document": "string", "beneficiary_name": "string" }, "metadata": { "property1": "string", "property2": "string" }, "created_at": "string"}