{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Javali Bridge","colors":{"primary":"#01758e","light":"#2fc7b4","dark":"#01758e"},"logo":{"light":"https://mintcdn.com/javali-gateway/u6tZ5OJFLDqJM4Zu/images/logo_claro_horizontal.png?fit=max\u0026auto=format\u0026n=u6tZ5OJFLDqJM4Zu\u0026q=85\u0026s=3ece6de2f0f2cbc827ab24f49af178ac","dark":"https://mintcdn.com/javali-gateway/u6tZ5OJFLDqJM4Zu/images/logo_escuro_horizontal.png?fit=max\u0026auto=format\u0026n=u6tZ5OJFLDqJM4Zu\u0026q=85\u0026s=cfbaee09fe23884f338241c45b3037d0"},"favicon":{"light":"https://mintcdn.com/javali-gateway/u6tZ5OJFLDqJM4Zu/images/simbolo_claro.png?fit=max\u0026auto=format\u0026n=u6tZ5OJFLDqJM4Zu\u0026q=85\u0026s=a4d3e3db13949d32b56bae7553739a7e","dark":"https://mintcdn.com/javali-gateway/u6tZ5OJFLDqJM4Zu/images/simbolo_escuro.png?fit=max\u0026auto=format\u0026n=u6tZ5OJFLDqJM4Zu\u0026q=85\u0026s=28fb8cbea6d515f1a33050b314afee28"},"api":{"openapi":"api-reference/openapi.yaml","playground":{"display":"simple"}},"fonts":{"family":"Plus Jakarta Sans"},"icons":{"library":"lucide"},"styling":{"latex":false},"contextual":{"options":["copy","view","claude","chatgpt","grok","cursor","mcp"],"display":"header"},"navigation":{"languages":[{"language":"en","default":true,"href":"en/guides/overview"},{"language":"pt-BR","href":"pt-BR/guides/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"javali-gateway","hasAudioNarration":false,"actualSubdomain":"javali-gateway","customDomains":["developers.javalibridge.com"],"gitSource":{"type":"github","owner":"javali-holding","repo":"bridge","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ae4d6eec08b8c12f5dc0c02"},"chroma":{"latestBuiltDeploymentHistoryId":"6aeca55a853e3bed8b023ef5","collectionId":"fce8fef9-19cb-4ac9-b5b5-110a39ee5343","liveDeploymentHistoryId":"6aeca55a853e3bed8b023ef5","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aeca55a853e3bed8b023ef5","clientVersion":"0.0.4071","searchFilterCounts":[{"language":"en","tag":"API reference","count":58},{"language":"pt-BR","tag":"Referência da API","count":58},{"language":"en","tag":"Webhook events","count":24},{"language":"pt-BR","tag":"Eventos de webhook","count":24},{"language":"en","tag":"Guides","count":20},{"language":"pt-BR","tag":"Guias","count":20},{"language":"en","tag":"Remittances","count":11},{"language":"pt-BR","tag":"Remessas","count":11},{"language":"en","tag":"Webhooks","count":5},{"language":"en","tag":"Settlement","count":5},{"language":"en","tag":"Get started","count":5},{"language":"pt-BR","tag":"Webhooks","count":5},{"language":"pt-BR","tag":"Liquidação","count":5},{"language":"pt-BR","tag":"Primeiros passos","count":5},{"language":"en","tag":"Beneficiaries","count":4},{"language":"en","tag":"Senders","count":4},{"language":"en","tag":"Lifecycle","count":4},{"language":"pt-BR","tag":"Beneficiários","count":4},{"language":"pt-BR","tag":"Remetentes","count":4},{"language":"pt-BR","tag":"Ciclo de vida","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"en/api-reference/webhook-events/remittance-funds-held-brl","slug":"/en/api-reference/webhook-events/remittance-funds-held-brl","pageMetadata":{"title":"remittance.funds_held_brl","description":"Final outcome: funds held in BRL after a definitive Pix failure or key holder mismatch.","openapi":"api-reference/openapi.yaml webhook remittance.funds_held_brl","href":"/en/api-reference/webhook-events/remittance-funds-held-brl"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Final outcome: funds held in BRL after a definitive Pix failure or key holder mismatch.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Card}=_components;if(!Card)_missingMdxReference(`Card`,true);return _jsx(Card,{title:`Guide: Remittance statuses`,icon:`book-open`,href:`/en/guides/statuses`,horizontal:true,children:_jsx(_components.p,{children:`Rules, statuses and what to do in each case.`})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"remittance.funds_held_brl","description":"Final outcome: funds held in BRL after a definitive Pix failure or key holder mismatch.","openapi":"api-reference/openapi.yaml webhook remittance.funds_held_brl","href":"/en/api-reference/webhook-events/remittance-funds-held-brl"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Câmbio contratado e Pix sem sucesso definitivo (inclui titular da chave divergente); valor mantido em BRL.","description":"Final outcome: funds held in BRL after a definitive Pix failure or key holder mismatch.","parameters":["9bbce524-74a9-47d4-85d0-12058c79ef0c","8a19cefb-59c1-42ba-b1b8-4fa2d06095f5","5392e08d-4054-45fe-9c5a-4b663b321f25"],"requestBody":"86ae05fa-069e-4b08-84df-d20f37b8a63d","responses":{"2XX":"0c63ae66-370b-40ad-8345-4866cb365c19"},"method":"post","type":"webhook","servers":["0a8bb87c-1bad-4b8e-b8be-01825541cc58","91d57d80-9462-4d71-90da-95e6c7fead56"],"security":["0750839c-6c6c-4db7-8417-11c4d11cc9f7"],"path":"remittance.funds_held_brl","baseUrlOptions":["https://api.javalibridge.example.com","https://sandbox.javalibridge.example.com"],"title":"Câmbio contratado e Pix sem sucesso definitivo (inclui titular da chave divergente); valor mantido em BRL.","codeSamples":[],"requiredOnlyExamples":false,"requestExamples":[{"language":"json","filename":"Example","code":"{\n \"eventId\": \"evt_01JB8Z3K5Q2W7X9V4N6M8P0R1T\",\n \"eventType\": \"remittance.funds_held_brl\",\n \"eventVersion\": \"1\",\n \"occurredAt\": \"2026-11-05T14:32:10Z\",\n \"data\": {\n \"object\": {\n \"remittanceId\": \"\u003cstring>\",\n \"type\": \"WITHDRAWAL\",\n \"externalId\": \"\u003cstring>\",\n \"quoteId\": \"\u003cstring>\",\n \"senderId\": \"\u003cstring>\",\n \"beneficiaryId\": \"\u003cstring>\",\n \"source\": {\n \"amount\": \"1000.00\"\n },\n \"destination\": {\n \"amount\": \"1000.00\"\n },\n \"fx\": {\n \"fxContractId\": \"\u003cstring>\",\n \"rate\": \"5.43210000\",\n \"contractedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"funding\": {\n \"inventoryId\": \"\u003cstring>\",\n \"confirmedAt\": \"2023-11-07T05:31:56Z\",\n \"attempts\": 1,\n \"lastFailureAt\": \"2023-11-07T05:31:56Z\"\n },\n \"payout\": {\n \"transactionId\": \"\u003cstring>\",\n \"amount\": {\n \"amount\": \"1000.00\"\n },\n \"attempts\": 1,\n \"failureCode\": \"PIX_KEY_OWNER_MISMATCH\",\n \"completedAt\": \"2023-11-07T05:31:56Z\",\n \"returnedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"settlement\": {\n \"settlementId\": \"\u003cstring>\",\n \"dueDate\": \"2023-12-25\"\n },\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"inventoryId\": \"\u003cstring>\",\n \"senderQuote\": {\n \"rate\": \"5.43210000\",\n \"source\": {\n \"amount\": \"1000.00\"\n },\n \"destination\": {\n \"amount\": \"1000.00\"\n },\n \"quotedAt\": \"2023-11-07T05:31:56Z\",\n \"reference\": \"\u003cstring>\"\n },\n \"statusReason\": \"\u003cstring>\",\n \"paymentInstructionId\": \"\u003cstring>\",\n \"metadata\": {}\n }\n },\n \"remittanceId\": \"\u003cstring>\"\n}"}],"requestExampleType":"webhook","responseExampleType":"generated"},"dependencies":{"parameters":{"9bbce524-74a9-47d4-85d0-12058c79ef0c":{"name":"JavaliBridge-Event-Id","in":"header","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"8a19cefb-59c1-42ba-b1b8-4fa2d06095f5":{"name":"JavaliBridge-Timestamp","in":"header","schema":{"type":"integer","isRequired":true,"uniqueKey":"","typeLabel":"integer"},"required":true},"5392e08d-4054-45fe-9c5a-4b663b321f25":{"name":"JavaliBridge-Signature","in":"header","schema":{"type":"string","isRequired":true,"description":"v1=\u003chex HMAC-SHA256(signingSecret, timestamp + \".\" + rawBody)>","uniqueKey":"","typeLabel":"string"},"required":true,"description":"v1=\u003chex HMAC-SHA256(signingSecret, timestamp + \".\" + rawBody)>"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["eventId","eventType","eventVersion","occurredAt","data"],"properties":{"eventId":{"type":"string","description":"Único por evento; repetido em reenvios. Use para deduplicação.","example":"evt_01JB8Z3K5Q2W7X9V4N6M8P0R1T","isRequired":true,"uniqueKey":"eventId","typeLabel":"string"},"eventType":{"type":"string","enum":["remittance.funds_held_brl"],"isRequired":true,"uniqueKey":"eventType","typeLabel":"enum\u003cstring>"},"eventVersion":{"type":"string","example":"1","description":"Versão do schema do evento. Mudanças incompatíveis geram nova versão.","isRequired":true,"uniqueKey":"eventVersion","typeLabel":"string"},"occurredAt":{"type":"string","format":"date-time","example":"2026-11-05T14:32:10Z","isRequired":true,"uniqueKey":"occurredAt","typeLabel":"string\u003cdate-time>"},"data":{"type":"object","required":["object"],"properties":{"object":{"type":"object","required":["remittanceId","type","externalId","quoteId","status","senderId","beneficiaryId","source","destination","fx","funding","payout","settlement","createdAt","updatedAt"],"description":"`status` descreve o ciclo de vida; o detalhe de cada etapa fica em `fx`, `funding`, `payout` e `settlement`.","properties":{"remittanceId":{"type":"string","isRequired":true,"uniqueKey":"data.object.remittanceId","typeLabel":"string"},"type":{"type":"string","enum":["WITHDRAWAL"],"description":"Operação que originou a remessa. WITHDRAWAL: envio do remetente para um beneficiário no Brasil via Pix. Enum extensível: ignore tipos desconhecidos.","isRequired":true,"uniqueKey":"data.object.type","typeLabel":"enum\u003cstring>"},"externalId":{"type":"string","description":"ID da MSB para a remessa. Único por cliente e imutável; chave de conciliação.","isRequired":true,"uniqueKey":"data.object.externalId","typeLabel":"string"},"quoteId":{"oneOf":[{"type":"string","description":"null somente em remessas INVENTORY.","isRequired":true,"uniqueKey":"data.object.quoteId.oneOf.0","typeLabel":"string"},{"type":"null","description":"null somente em remessas INVENTORY.","isRequired":true,"uniqueKey":"data.object.quoteId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.object.quoteId","typeLabel":"string | null"},"status":{"type":"string","enum":["PROCESSING","ON_HOLD","COMPLETED","REJECTED","FUNDS_HELD_BRL","RETURNED"],"isRequired":true,"uniqueKey":"data.object.status","typeLabel":"enum\u003cstring>"},"senderId":{"type":"string","isRequired":true,"uniqueKey":"data.object.senderId","typeLabel":"string"},"beneficiaryId":{"type":"string","isRequired":true,"uniqueKey":"data.object.beneficiaryId","typeLabel":"string"},"source":{"type":"object","required":["currency","amount"],"description":"Valor monetário (saldos, extratos, custos). Pode ser zero. Para valores de requisição use PositiveMoney.","properties":{"currency":{"type":"string","enum":["USD","BRL"],"description":"v1 suporta apenas USD e BRL.","isRequired":true,"uniqueKey":"data.object.source.currency","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]{1,2})?$","description":"Decimal como string; nunca float binário.","example":"1000.00","isRequired":true,"uniqueKey":"data.object.source.amount","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.object.source","typeLabel":"object"},"destination":{"type":"object","required":["currency","amount"],"description":"Valor monetário (saldos, extratos, custos). Pode ser zero. Para valores de requisição use PositiveMoney.","properties":{"currency":{"type":"string","enum":["USD","BRL"],"description":"v1 suporta apenas USD e BRL.","isRequired":true,"uniqueKey":"data.object.destination.currency","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]{1,2})?$","description":"Decimal como string; nunca float binário.","example":"1000.00","isRequired":true,"uniqueKey":"data.object.destination.amount","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.object.destination","typeLabel":"object"},"fx":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["PENDING","PROCESSING","CONTRACTED","FAILED","EXPIRED"],"description":"PROCESSING: aguardando confirmação; sem resposta, permanece PROCESSING. FAILED: o câmbio não foi executado. EXPIRED: sem confirmação dentro do prazo, declarado só após o Javali Bridge confirmar que o câmbio não foi executado. FAILED e EXPIRED levam a remessa a REJECTED.","isRequired":true,"uniqueKey":"data.object.fx.status","typeLabel":"enum\u003cstring>"},"fxContractId":{"oneOf":[{"type":"string","description":"Identificador Javali Bridge do contrato de câmbio.","uniqueKey":"data.object.fx.fxContractId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identificador Javali Bridge do contrato de câmbio.","uniqueKey":"data.object.fx.fxContractId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.fx.fxContractId","typeLabel":"string | null"},"rate":{"oneOf":[{"type":"string","description":"BRL por USD, até 8 casas decimais.","pattern":"^[0-9]+(\\.[0-9]{1,8})?$","example":"5.43210000","uniqueKey":"data.object.fx.rate.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.object.fx.rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.fx.rate","typeLabel":"string | null"},"contractedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.object.fx.contractedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.object.fx.contractedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.fx.contractedAt","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"data.object.fx","typeLabel":"object"},"funding":{"type":"object","required":["status","mode"],"properties":{"status":{"type":"string","enum":["PENDING","RETRYING","CONFIRMED"],"description":"RETRYING: tentativa de funding falhou e o Javali Bridge está repetindo. Não há estado de falha definitiva.","isRequired":true,"uniqueKey":"data.object.funding.status","typeLabel":"enum\u003cstring>"},"mode":{"type":"string","enum":["PREFUNDED","CREDIT","INVENTORY"],"isRequired":true,"uniqueKey":"data.object.funding.mode","typeLabel":"enum\u003cstring>"},"inventoryId":{"oneOf":[{"type":"string","description":"Somente mode = INVENTORY.","uniqueKey":"data.object.funding.inventoryId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Somente mode = INVENTORY.","uniqueKey":"data.object.funding.inventoryId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.funding.inventoryId","typeLabel":"string | null"},"confirmedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.object.funding.confirmedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.object.funding.confirmedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.funding.confirmedAt","typeLabel":"string\u003cdate-time> | null"},"attempts":{"type":"integer","minimum":0,"uniqueKey":"data.object.funding.attempts","typeLabel":"integer"},"lastFailureAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.object.funding.lastFailureAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.object.funding.lastFailureAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.funding.lastFailureAt","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"data.object.funding","typeLabel":"object"},"payout":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["PENDING","PROCESSING","COMPLETED","FAILED","EXPIRED","RETURNED"],"description":"PROCESSING: Pix enviado, aguardando confirmação; sem resposta, permanece PROCESSING e não é repetido. FAILED/EXPIRED: tentativa sem sucesso, declarada só após o Javali Bridge confirmar que o Pix não foi liquidado. Esgotadas as tentativas, a remessa vai para FUNDS_HELD_BRL.","isRequired":true,"uniqueKey":"data.object.payout.status","typeLabel":"enum\u003cstring>"},"transactionId":{"oneOf":[{"type":"string","description":"Identificador Javali Bridge da transação de pagamento ao beneficiário.","uniqueKey":"data.object.payout.transactionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identificador Javali Bridge da transação de pagamento ao beneficiário.","uniqueKey":"data.object.payout.transactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.payout.transactionId","typeLabel":"string | null"},"amount":{"oneOf":[{"type":"object","description":"Valor monetário (saldos, extratos, custos). Pode ser zero. Para valores de requisição use PositiveMoney.","required":["currency","amount"],"properties":{"currency":{"type":"string","enum":["USD","BRL"],"description":"v1 suporta apenas USD e BRL.","isRequired":true,"uniqueKey":"data.object.payout.amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]{1,2})?$","description":"Decimal como string; nunca float binário.","example":"1000.00","isRequired":true,"uniqueKey":"data.object.payout.amount.oneOf.0.amount","typeLabel":"string"}},"uniqueKey":"data.object.payout.amount.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.object.payout.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.payout.amount","typeLabel":"object | null"},"attempts":{"type":"integer","minimum":0,"uniqueKey":"data.object.payout.attempts","typeLabel":"integer"},"failureCode":{"oneOf":[{"type":"string","example":"PIX_KEY_OWNER_MISMATCH","description":"Motivo da última falha. Inclui PIX_KEY_OWNER_MISMATCH quando o titular da chave não corresponde ao beneficiário.","uniqueKey":"data.object.payout.failureCode.oneOf.0","typeLabel":"string"},{"type":"null","example":"PIX_KEY_OWNER_MISMATCH","description":"Motivo da última falha. Inclui PIX_KEY_OWNER_MISMATCH quando o titular da chave não corresponde ao beneficiário.","uniqueKey":"data.object.payout.failureCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.payout.failureCode","typeLabel":"string | null"},"completedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.object.payout.completedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.object.payout.completedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.payout.completedAt","typeLabel":"string\u003cdate-time> | null"},"returnedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.object.payout.returnedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.object.payout.returnedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.payout.returnedAt","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"data.object.payout","typeLabel":"object"},"settlement":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["NOT_APPLICABLE","OPEN","CLOSED","DUE","OVERDUE","COMPLETED"],"description":"NOT_APPLICABLE para PREFUNDED. Demais valores espelham o status do lote (Settlement.status). Para INVENTORY, NOT_APPLICABLE nesta versão.","isRequired":true,"uniqueKey":"data.object.settlement.status","typeLabel":"enum\u003cstring>"},"settlementId":{"oneOf":[{"type":"string","uniqueKey":"data.object.settlement.settlementId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.object.settlement.settlementId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.settlement.settlementId","typeLabel":"string | null"},"dueDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"data.object.settlement.dueDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"data.object.settlement.dueDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.settlement.dueDate","typeLabel":"string\u003cdate> | null"}},"isRequired":true,"uniqueKey":"data.object.settlement","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.object.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.object.updatedAt","typeLabel":"string\u003cdate-time>"},"inventoryId":{"oneOf":[{"type":"string","description":"Inventory Lot que financiou a remessa; somente funding.mode = INVENTORY.","uniqueKey":"data.object.inventoryId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Inventory Lot que financiou a remessa; somente funding.mode = INVENTORY.","uniqueKey":"data.object.inventoryId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.inventoryId","typeLabel":"string | null"},"senderQuote":{"oneOf":[{"type":"object","description":"Dados da operação de câmbio da MSB com o remetente. Obrigatório em INVENTORY.","required":["rate","source","destination"],"properties":{"rate":{"type":"string","description":"Taxa BRL por USD aplicada pela MSB ao remetente.","pattern":"^[0-9]+(\\.[0-9]{1,8})?$","example":"5.43210000","isRequired":true,"uniqueKey":"data.object.senderQuote.oneOf.0.rate","typeLabel":"string"},"source":{"type":"object","description":"Valor em USD da operação para o remetente.","required":["currency","amount"],"properties":{"currency":{"type":"string","enum":["USD","BRL"],"description":"v1 suporta apenas USD e BRL.","isRequired":true,"uniqueKey":"data.object.senderQuote.oneOf.0.source.currency","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]{1,2})?$","description":"Decimal como string; nunca float binário.","example":"1000.00","isRequired":true,"uniqueKey":"data.object.senderQuote.oneOf.0.source.amount","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.object.senderQuote.oneOf.0.source","typeLabel":"object"},"destination":{"type":"object","description":"Valor em BRL informado ao remetente.","required":["currency","amount"],"properties":{"currency":{"type":"string","enum":["USD","BRL"],"description":"v1 suporta apenas USD e BRL.","isRequired":true,"uniqueKey":"data.object.senderQuote.oneOf.0.destination.currency","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]{1,2})?$","description":"Decimal como string; nunca float binário.","example":"1000.00","isRequired":true,"uniqueKey":"data.object.senderQuote.oneOf.0.destination.amount","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.object.senderQuote.oneOf.0.destination","typeLabel":"object"},"quotedAt":{"type":"string","format":"date-time","description":"Momento em que a MSB cotou para o remetente.","uniqueKey":"data.object.senderQuote.oneOf.0.quotedAt","typeLabel":"string\u003cdate-time>"},"reference":{"type":"string","maxLength":128,"description":"Identificador da cotação no sistema da MSB.","uniqueKey":"data.object.senderQuote.oneOf.0.reference","typeLabel":"string"}},"uniqueKey":"data.object.senderQuote.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.object.senderQuote.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.senderQuote","typeLabel":"object | null"},"statusReason":{"oneOf":[{"type":"string","description":"Código genérico; motivos de compliance não são detalhados.","uniqueKey":"data.object.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Código genérico; motivos de compliance não são detalhados.","uniqueKey":"data.object.statusReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.statusReason","typeLabel":"string | null"},"paymentInstructionId":{"type":"string","uniqueKey":"data.object.paymentInstructionId","typeLabel":"string"},"purpose":{"type":"string","enum":["FAMILY_MAINTENANCE","GIFT","PERSONAL_SAVINGS","EDUCATION","MEDICAL","SERVICES_PAYMENT","GOODS_PAYMENT","SALARY","OTHER"],"description":"Finalidade declarada; mapeada internamente para a natureza da operação de câmbio. Enum extensível.","uniqueKey":"data.object.purpose","typeLabel":"enum\u003cstring>"},"senderRelationship":{"type":"string","enum":["SELF","FAMILY","FRIEND","EMPLOYER","EMPLOYEE","BUSINESS_PARTNER","OTHER"],"description":"Relação do remetente com o beneficiário.","uniqueKey":"data.object.senderRelationship","typeLabel":"enum\u003cstring>"},"spread":{"type":"object","required":["percentage","amount"],"description":"Spread de câmbio: única tarifa da remessa.","properties":{"percentage":{"type":"string","pattern":"^[0-9]+(\\.[0-9]{1,4})?$","example":"0.75","description":"Percentual sobre referenceRate (0.75 = 0,75%).","isRequired":true,"uniqueKey":"data.object.spread.percentage","typeLabel":"string"},"amount":{"type":"object","description":"Valor do spread em USD. Referência para conciliação em caso de arredondamento.","required":["currency","amount"],"example":{"currency":"USD","amount":"7.50"},"properties":{"currency":{"type":"string","enum":["USD","BRL"],"description":"v1 suporta apenas USD e BRL.","isRequired":true,"uniqueKey":"data.object.spread.amount.currency","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]{1,2})?$","description":"Decimal como string; nunca float binário.","example":"1000.00","isRequired":true,"uniqueKey":"data.object.spread.amount.amount","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.object.spread.amount","typeLabel":"object"}},"uniqueKey":"data.object.spread","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":true,"uniqueKey":"data.object.metadata","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.object","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"remittanceId":{"oneOf":[{"type":"string","description":"ID da remessa; igual a `data.object.remittanceId`.","uniqueKey":"remittanceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID da remessa; igual a `data.object.remittanceId`.","uniqueKey":"remittanceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"remittanceId","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"eventId":"evt_01JB8Z3K5Q2W7X9V4N6M8P0R1T","eventType":"remittance.funds_held_brl","eventVersion":"1","occurredAt":"2026-11-05T14:32:10Z","data":{"object":{"remittanceId":"\u003cstring>","type":"WITHDRAWAL","externalId":"\u003cstring>","quoteId":"\u003cstring>","senderId":"\u003cstring>","beneficiaryId":"\u003cstring>","source":{"amount":"1000.00"},"destination":{"amount":"1000.00"},"fx":{"fxContractId":"\u003cstring>","rate":"5.43210000","contractedAt":"2023-11-07T05:31:56Z"},"funding":{"inventoryId":"\u003cstring>","confirmedAt":"2023-11-07T05:31:56Z","attempts":1,"lastFailureAt":"2023-11-07T05:31:56Z"},"payout":{"transactionId":"\u003cstring>","amount":{"amount":"1000.00"},"attempts":1,"failureCode":"PIX_KEY_OWNER_MISMATCH","completedAt":"2023-11-07T05:31:56Z","returnedAt":"2023-11-07T05:31:56Z"},"settlement":{"settlementId":"\u003cstring>","dueDate":"2023-12-25"},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","inventoryId":"\u003cstring>","senderQuote":{"rate":"5.43210000","source":{"amount":"1000.00"},"destination":{"amount":"1000.00"},"quotedAt":"2023-11-07T05:31:56Z","reference":"\u003cstring>"},"statusReason":"\u003cstring>","paymentInstructionId":"\u003cstring>","metadata":{}}},"remittanceId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"0c63ae66-370b-40ad-8345-4866cb365c19":{"description":"Recebido. Qualquer outro status gera reenvio.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"0750839c-6c6c-4db7-8417-11c4d11cc9f7":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"0a8bb87c-1bad-4b8e-b8be-01825541cc58":{"url":"https://api.javalibridge.example.com","description":"Example production URL - replace before use"},"91d57d80-9462-4d71-90da-95e6c7fead56":{"url":"https://sandbox.javalibridge.example.com","description":"Example sandbox URL - replace before use"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"javali-gateway","siteName":"Javali Bridge","title":"remittance.funds_held_brl - Javali Bridge","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/api-reference/webhook-events/remittance-funds-held-brl","matchLevel":0},"pt-BR":{"href":"/pt-BR/api-reference/webhook-events/remittance-funds-held-brl","matchLevel":1}}},"lastModified":"2026-11-05T13:43:24.895Z","originalFileLocation":"en/api-reference/webhook-events/remittance-funds-held-brl.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Final outcome: funds held in BRL after a definitive Pix failure or key holder mismatch.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Javali Bridge\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"remittance.funds_held_brl - Javali Bridge\">\u003cmeta data-mint-head property=\"og:description\" content=\"Final outcome: funds held in BRL after a definitive Pix failure or key holder mismatch.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Javali Bridge\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://javali-gateway.mintlify.app/_mintlify/api/og/v2?division=Lifecycle\u0026amp;title=remittance.funds_held_brl\u0026amp;description=Final+outcome%3A+funds+held+in+BRL+after+a+definitive+Pix+failure+or+key+holder+mismatch.\u0026amp;theme=c4bea45393e4cc5a4a7f2c03\u0026amp;signature=d43f287f834f1d2bcff7ee4001c1853111fc1aa18a58237fe4250094a1130178\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"remittance.funds_held_brl - Javali Bridge\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Final outcome: funds held in BRL after a definitive Pix failure or key holder mismatch.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://javali-gateway.mintlify.app/_mintlify/api/og/v2?division=Lifecycle\u0026amp;title=remittance.funds_held_brl\u0026amp;description=Final+outcome%3A+funds+held+in+BRL+after+a+definitive+Pix+failure+or+key+holder+mismatch.\u0026amp;theme=c4bea45393e4cc5a4a7f2c03\u0026amp;signature=d43f287f834f1d2bcff7ee4001c1853111fc1aa18a58237fe4250094a1130178\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/javali-gateway/Rjdr5ILyetQAYt56/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Javali Bridge\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#01758e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/webhook-events/remittance-funds-held-brl.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://developers.javalibridge.com/pt-BR/api-reference/webhook-events/remittance-funds-held-brl\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.javalibridge.com/#organization\",\"name\":\"Javali Bridge\",\"url\":\"https://developers.javalibridge.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/javali-gateway/u6tZ5OJFLDqJM4Zu/images/logo_claro_horizontal.png?fit=max\u0026auto=format\u0026n=u6tZ5OJFLDqJM4Zu\u0026q=85\u0026s=3ece6de2f0f2cbc827ab24f49af178ac\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.javalibridge.com#website\",\"name\":\"Javali Bridge\",\"url\":\"https://developers.javalibridge.com\",\"publisher\":{\"@id\":\"https://developers.javalibridge.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl#webpage\",\"url\":\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl\",\"name\":\"remittance.funds_held_brl\",\"description\":\"Final outcome: funds held in BRL after a definitive Pix failure or key holder mismatch.\",\"dateModified\":\"2026-11-05T13:43:24.895Z\",\"isPartOf\":{\"@id\":\"https://developers.javalibridge.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhook events\",\"item\":\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-created\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Lifecycle\",\"item\":\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-created\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"remittance.funds_held_brl\",\"item\":\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl#apireference\",\"headline\":\"remittance.funds_held_brl\",\"name\":\"remittance.funds_held_brl\",\"description\":\"Final outcome: funds held in BRL after a definitive Pix failure or key holder mismatch.\",\"url\":\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl\",\"mainEntityOfPage\":{\"@id\":\"https://developers.javalibridge.com/en/api-reference/webhook-events/remittance-funds-held-brl#webpage\"},\"dateModified\":\"2026-11-05T13:43:24.895Z\",\"publisher\":{\"@id\":\"https://developers.javalibridge.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.javalibridge.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Javali Bridge\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Javali Bridge","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/en/guides/overview"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API conventions","href":"/en/api-reference/conventions"},{"title":"Changelog","href":"/en/api-reference/changelog"}]},{"group":"Health","pages":[{"title":"Health check","openapi":"api-reference/openapi.yaml GET /v1/health","href":"/en/api-reference/get-health"}]},{"group":"FX Quotes","pages":[{"title":"Request a quote","openapi":"api-reference/openapi.yaml POST /v1/fx/quotes","href":"/en/api-reference/create-fx-quote"},{"title":"Get a quote","openapi":"api-reference/openapi.yaml GET /v1/fx/quotes/{quoteId}","href":"/en/api-reference/get-fx-quote"}]},{"group":"Inventories","pages":[{"title":"Create an inventory lot","openapi":"api-reference/openapi.yaml POST /v1/inventories","href":"/en/api-reference/create-inventory"},{"title":"List inventory lots","openapi":"api-reference/openapi.yaml GET /v1/inventories","href":"/en/api-reference/list-inventories"},{"title":"Get an inventory lot","openapi":"api-reference/openapi.yaml GET /v1/inventories/{inventoryId}","href":"/en/api-reference/get-inventory"}]},{"group":"Remittances","pages":[{"title":"Create a withdrawal","openapi":"api-reference/openapi.yaml POST /v1/remittances/withdrawals","href":"/en/api-reference/create-withdrawal"},{"title":"List remittances","openapi":"api-reference/openapi.yaml GET /v1/remittances","href":"/en/api-reference/list-remittances"},{"title":"Get a remittance","openapi":"api-reference/openapi.yaml GET /v1/remittances/{remittanceId}","href":"/en/api-reference/get-remittance"},{"title":"Get the Pix receipt","openapi":"api-reference/openapi.yaml GET /v1/remittances/{remittanceId}/receipt","href":"/en/api-reference/get-remittance-receipt"}]},{"group":"Senders","pages":[{"title":"Create a sender","openapi":"api-reference/openapi.yaml POST /v1/senders","href":"/en/api-reference/create-sender"},{"title":"List senders","openapi":"api-reference/openapi.yaml GET /v1/senders","href":"/en/api-reference/list-senders"},{"title":"Get a sender","openapi":"api-reference/openapi.yaml GET /v1/senders/{senderId}","href":"/en/api-reference/get-sender"},{"title":"Update a sender","openapi":"api-reference/openapi.yaml PATCH /v1/senders/{senderId}","href":"/en/api-reference/update-sender"}]},{"group":"Beneficiaries","pages":[{"title":"Create a beneficiary","openapi":"api-reference/openapi.yaml POST /v1/beneficiaries","href":"/en/api-reference/create-beneficiary"},{"title":"List beneficiaries","openapi":"api-reference/openapi.yaml GET /v1/beneficiaries","href":"/en/api-reference/list-beneficiaries"},{"title":"Get a beneficiary","openapi":"api-reference/openapi.yaml GET /v1/beneficiaries/{beneficiaryId}","href":"/en/api-reference/get-beneficiary"},{"title":"Update a beneficiary","openapi":"api-reference/openapi.yaml PATCH /v1/beneficiaries/{beneficiaryId}","href":"/en/api-reference/update-beneficiary"}]},{"group":"Credit line","pages":[{"title":"Get the credit line","openapi":"api-reference/openapi.yaml GET /v1/credit-line","href":"/en/api-reference/get-credit-line"}]},{"group":"Limits","pages":[{"title":"Get account limits","openapi":"api-reference/openapi.yaml GET /v1/limits","href":"/en/api-reference/get-account-limits"},{"title":"Get sender limits","openapi":"api-reference/openapi.yaml GET /v1/limits/senders/{senderId}","href":"/en/api-reference/get-sender-limits"},{"title":"Get beneficiary limits","openapi":"api-reference/openapi.yaml GET /v1/limits/beneficiaries/{beneficiaryId}","href":"/en/api-reference/get-beneficiary-limits"}]},{"group":"Wallets","pages":[{"title":"List wallets","openapi":"api-reference/openapi.yaml GET /v1/wallets","href":"/en/api-reference/list-wallets"},{"title":"List wallet transactions","openapi":"api-reference/openapi.yaml GET /v1/wallets/transactions","href":"/en/api-reference/list-wallet-transactions"}]},{"group":"Settlements","pages":[{"title":"List settlement batches","openapi":"api-reference/openapi.yaml GET /v1/settlements","href":"/en/api-reference/list-settlements"},{"title":"Get a settlement batch","openapi":"api-reference/openapi.yaml GET /v1/settlements/{settlementId}","href":"/en/api-reference/get-settlement"},{"title":"List batch items","openapi":"api-reference/openapi.yaml GET /v1/settlements/{settlementId}/items","href":"/en/api-reference/list-settlement-items"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","openapi":"api-reference/openapi.yaml GET /v1/webhooks","href":"/en/api-reference/list-webhooks"},{"title":"Register a webhook endpoint","openapi":"api-reference/openapi.yaml POST /v1/webhooks","href":"/en/api-reference/create-webhook"},{"title":"Delete a webhook endpoint","openapi":"api-reference/openapi.yaml DELETE /v1/webhooks/{webhookId}","href":"/en/api-reference/delete-webhook"},{"title":"List webhook deliveries","openapi":"api-reference/openapi.yaml GET /v1/webhooks/{webhookId}/deliveries","href":"/en/api-reference/list-webhook-deliveries"},{"title":"Retry a webhook delivery","openapi":"api-reference/openapi.yaml POST /v1/webhooks/{webhookId}/deliveries/{deliveryId}/retry","href":"/en/api-reference/retry-webhook-delivery"}]},{"group":"Webhook events","pages":[{"group":"Lifecycle","pages":[{"title":"remittance.created","openapi":"api-reference/openapi.yaml webhook remittance.created","href":"/en/api-reference/webhook-events/remittance-created"},{"title":"remittance.on_hold","openapi":"api-reference/openapi.yaml webhook remittance.on_hold","href":"/en/api-reference/webhook-events/remittance-on-hold"},{"title":"remittance.rejected","description":"The remittance was rejected.","openapi":"api-reference/openapi.yaml webhook remittance.rejected","href":"/en/api-reference/webhook-events/remittance-rejected"},{"title":"remittance.funds_held_brl","openapi":"api-reference/openapi.yaml webhook remittance.funds_held_brl","href":"/en/api-reference/webhook-events/remittance-funds-held-brl"}]},{"group":"FX","pages":[{"title":"remittance.fx_contracted","description":"FX was contracted.","openapi":"api-reference/openapi.yaml webhook remittance.fx_contracted","href":"/en/api-reference/webhook-events/remittance-fx-contracted"},{"title":"remittance.fx_failed","openapi":"api-reference/openapi.yaml webhook remittance.fx_failed","href":"/en/api-reference/webhook-events/remittance-fx-failed"}]},{"group":"Funding","pages":[{"title":"remittance.funding_confirmed","openapi":"api-reference/openapi.yaml webhook remittance.funding_confirmed","href":"/en/api-reference/webhook-events/remittance-funding-confirmed"},{"title":"remittance.funding_failed","openapi":"api-reference/openapi.yaml webhook remittance.funding_failed","href":"/en/api-reference/webhook-events/remittance-funding-failed"}]},{"group":"Pix","pages":[{"title":"remittance.payout_processing","openapi":"api-reference/openapi.yaml webhook remittance.payout_processing","href":"/en/api-reference/webhook-events/remittance-payout-processing"},{"title":"remittance.payout_completed","openapi":"api-reference/openapi.yaml webhook remittance.payout_completed","href":"/en/api-reference/webhook-events/remittance-payout-completed"},{"title":"remittance.payout_failed","openapi":"api-reference/openapi.yaml webhook remittance.payout_failed","href":"/en/api-reference/webhook-events/remittance-payout-failed"},{"title":"remittance.payout_returned","openapi":"api-reference/openapi.yaml webhook remittance.payout_returned","href":"/en/api-reference/webhook-events/remittance-payout-returned"}]},{"group":"Settlement","pages":[{"title":"settlement.created","openapi":"api-reference/openapi.yaml webhook settlement.created","href":"/en/api-reference/webhook-events/settlement-created"},{"title":"settlement.closed","openapi":"api-reference/openapi.yaml webhook settlement.closed","href":"/en/api-reference/webhook-events/settlement-closed"},{"title":"settlement.due","openapi":"api-reference/openapi.yaml webhook settlement.due","href":"/en/api-reference/webhook-events/settlement-due"},{"title":"settlement.overdue","openapi":"api-reference/openapi.yaml webhook settlement.overdue","href":"/en/api-reference/webhook-events/settlement-overdue"},{"title":"settlement.completed","openapi":"api-reference/openapi.yaml webhook settlement.completed","href":"/en/api-reference/webhook-events/settlement-completed"}]},{"group":"Records","pages":[{"title":"sender.status_changed","openapi":"api-reference/openapi.yaml webhook sender.status_changed","href":"/en/api-reference/webhook-events/sender-status-changed"},{"title":"sender.compliance_level_changed","openapi":"api-reference/openapi.yaml webhook sender.compliance_level_changed","href":"/en/api-reference/webhook-events/sender-compliance-level-changed"},{"title":"beneficiary.status_changed","openapi":"api-reference/openapi.yaml webhook beneficiary.status_changed","href":"/en/api-reference/webhook-events/beneficiary-status-changed"}]},{"group":"Credit","pages":[{"title":"credit_line.threshold_reached","openapi":"api-reference/openapi.yaml webhook credit_line.threshold_reached","href":"/en/api-reference/webhook-events/credit-line-threshold-reached"}]},{"group":"Inventory","pages":[{"title":"inventory.created","openapi":"api-reference/openapi.yaml webhook inventory.created","href":"/en/api-reference/webhook-events/inventory-created"},{"title":"inventory.status_changed","openapi":"api-reference/openapi.yaml webhook inventory.status_changed","href":"/en/api-reference/webhook-events/inventory-status-changed"},{"title":"inventory.obligation_status_changed","openapi":"api-reference/openapi.yaml webhook inventory.obligation_status_changed","href":"/en/api-reference/webhook-events/inventory-obligation-status-changed"}]}]}]}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-BR/api-reference/webhook-events/remittance-funds-held-brl"}]}]},"basePath":"","title":"remittance.funds_held_brl - Javali Bridge","buildId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","deploymentId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B5zPa4Vr.js","utils-CVjrr8Yd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DTgURWzl.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DxTHtkdZ.js","snippetPresets-Cx47o5Vx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-4Fr6y9N_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dq2ElbEk.js","shallow-BfYl9r69.js","getApiPlaygroundDisplay-Ch3xc7i1.js","CodeSnippet-BsBxuJ1v.js","CodeSnippets-CetzeDL8.js","Page-CYZot51e.js","getPastedJson-BxPKFSJx.js","icon-o0J1Ochb.js","MethodPill-Du3usO5m.js","DuplicateIcon-DJypyMzl.js","createIcon-YMA6N8KJ.js","DynamicMarkdown-CWvhfcZc.js","SectionHeading-BdLVaXCd.js","axios-vUo_bRtp.js","Markdown-C4Ez6OeV.js","clsx-DptzKFCt.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Dt1IougW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CZ6Wt2Vb.js"]}