Scope: transfers:write (chave aprovada pela OriPay). Passa pelo antifraude: pode responder 403 { "error": "risk_score_exceeded" } ou, com o antifraude fora do ar e valor acima de R$ 1.000,00, 401 { "code": "step_up_required_risk_unavailable" }.
Uma chave por intenção. Repita a mesma chave em retry. Fica presa ao external_id do recurso. Replay responde com o header Idempotency-Replayed igual a true.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OriPay API","colors":{"primary":"#0891B2","light":"#22D3EE","dark":"#0E7490"},"favicon":"/images/favicon.png","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python","php"]}},"footer":{"socials":{}},"seo":{"metatags":{"og:image":"https://docs.oripaysolutions.com.br/images/og.png","og:image:width":"1200","og:image:height":"630","twitter:image":"https://docs.oripaysolutions.com.br/images/og.png"}},"fonts":{"heading":{"family":"Bricolage Grotesque"}},"integrations":{"telemetry":{"enabled":false}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"hasAudioNarration":false,"customDomains":[],"gitSource":{"type":"github","owner":"local","repo":"local","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"local","isBase":true},"buildId":"local","clientVersion":"0.0.4044"},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":true,"isLoggedInCli":false,"mintExport":{}},"customCss":[],"page":{"pagePath":"api-reference/transferências/enviar-pix","slug":"/api-reference/transferências/enviar-pix","pageMetadata":{"openapi":"/api-reference/openapi.yaml post /pix/transfers","description":"Scope: `transfers:write` (chave aprovada pela OriPay). Passa pelo antifraude: pode responder `403 { \"error\": \"risk_score_exceeded\" }` ou, com o antifraude fora do ar e valor acima de R$ 1.000,00, `401 { \"code\": \"step_up_required_risk_unavailable\" }`.","href":"/api-reference/transferências/enviar-pix","title":"Enviar PIX"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Scope: \", _jsx(_components.code, {\n children: \"transfers:write\"\n }), \" (chave aprovada pela OriPay). Passa pelo antifraude: pode responder \", _jsx(_components.code, {\n children: \"403 { \\\"error\\\": \\\"risk_score_exceeded\\\" }\"\n }), \" ou, com o antifraude fora do ar e valor acima de R$ 1.000,00, \", _jsx(_components.code, {\n children: \"401 { \\\"code\\\": \\\"step_up_required_risk_unavailable\\\" }\"\n }), \".\"]\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{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"/api-reference/openapi.yaml post /pix/transfers","description":"Scope: `transfers:write` (chave aprovada pela OriPay). Passa pelo antifraude: pode responder `403 { \"error\": \"risk_score_exceeded\" }` ou, com o antifraude fora do ar e valor acima de R$ 1.000,00, `401 { \"code\": \"step_up_required_risk_unavailable\" }`.","href":"/api-reference/transferências/enviar-pix","title":"Enviar PIX"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Transferências"],"summary":"Enviar PIX","operationId":"createTransfer","description":"Scope: `transfers:write` (chave aprovada pela OriPay). Passa pelo antifraude: pode responder `403 { \"error\": \"risk_score_exceeded\" }` ou, com o antifraude fora do ar e valor acima de R$ 1.000,00, `401 { \"code\": \"step_up_required_risk_unavailable\" }`.","parameters":["05ef40ef-558c-4c1c-a22f-f764805ad94c"],"requestBody":"d9e45831-dc72-4fb6-902b-ae6a1308926a","responses":{"202":"6b90bfac-0f9d-45e3-964a-4e59aeb697e7","400":"898ab992-3ceb-43ea-b894-92c643a58b12","401":"6f02fada-1316-4ac4-8c88-3490d90b77c9","403":"8cd916f1-8553-4a32-8ad9-5431d1eb8230","409":"470bcbe3-3880-43eb-8591-22adbe429b6e","422":"4b4932e5-5378-4be4-bdc8-5080f9556a16","503":"85913170-ee86-4d36-9fd2-127294cd930d"},"method":"post","type":"path","servers":["9f7080f5-8536-4fd6-8c72-65772debb1b8"],"security":["8e46bd55-1fcc-4684-9fe9-4b81cba9eb0e"],"path":"/pix/transfers","baseUrlOptions":["https://api.oripaysolutions.com.br/v1"],"title":"Enviar PIX","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","php"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"05ef40ef-558c-4c1c-a22f-f764805ad94c":{"name":"Idempotency-Key","in":"header","required":true,"description":"Uma chave por intenção. Repita a mesma chave em retry. Fica presa ao `external_id` do recurso. Replay responde com o header `Idempotency-Replayed` igual a `true`.","schema":{"type":"string","pattern":"^[\\x21-\\x7e]{8,128}$","minLength":8,"maxLength":128,"isRequired":true,"description":"Uma chave por intenção. Repita a mesma chave em retry. Fica presa ao `external_id` do recurso. Replay responde com o header `Idempotency-Replayed` igual a `true`.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["amount","pix_key","external_id"],"properties":{"amount":{"type":"integer","minimum":1,"maximum":100000000,"description":"Centavos","example":15000,"isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"pix_key":{"type":"string","minLength":1,"maxLength":77,"isRequired":true,"uniqueKey":"pix_key","typeLabel":"string"},"external_id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$","description":"Seu ID. Único por conta e tipo de recurso.","example":"pedido-8812","isRequired":true,"uniqueKey":"external_id","typeLabel":"string"},"description":{"type":"string","maxLength":140,"uniqueKey":"description","typeLabel":"string"},"metadata":{"type":"object","maxProperties":20,"propertyNames":{"pattern":"^[A-Za-z0-9_.-]{1,40}$"},"additionalProperties":{"type":"string","maxLength":500,"uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Sem dados pessoais.","example":{"customer_id":"cli_4471"},"uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":15000,"pix_key":"\u003cstring>","external_id":"pedido-8812","description":"\u003cstring>","metadata":{"customer_id":"cli_4471"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6b90bfac-0f9d-45e3-964a-4e59aeb697e7":{"description":"Transferência aceita (status pending)","content":{"application/json":{"schema":{"type":"object","required":["id","external_id","status","amount","pix_key_masked","created_at","updated_at"],"description":"Sem campo de tarifa. Tarifas são linhas pix_fee/monthly_fee no extrato.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"external_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"external_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"external_id","typeLabel":"string | null"},"status":{"type":"string","enum":["pending","completed","failed","returned"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"pix_key_masked":{"oneOf":[{"type":"string","description":"Chave de destino mascarada","isRequired":true,"uniqueKey":"pix_key_masked.oneOf.0","typeLabel":"string"},{"type":"null","description":"Chave de destino mascarada","isRequired":true,"uniqueKey":"pix_key_masked.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"pix_key_masked","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"recipient":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"Nome do titular da conta de origem/destino","uniqueKey":"recipient.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome do titular da conta de origem/destino","uniqueKey":"recipient.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient.oneOf.0.name","typeLabel":"string | null"},"document":{"oneOf":[{"type":"string","description":"Mascarado","example":"***.456.789-**","uniqueKey":"recipient.oneOf.0.document.oneOf.0","typeLabel":"string"},{"type":"null","description":"Mascarado","example":"***.456.789-**","uniqueKey":"recipient.oneOf.0.document.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient.oneOf.0.document","typeLabel":"string | null"},"bank":{"oneOf":[{"type":"string","description":"Nome do banco","example":"Banco Exemplo S.A.","uniqueKey":"recipient.oneOf.0.bank.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome do banco","example":"Banco Exemplo S.A.","uniqueKey":"recipient.oneOf.0.bank.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient.oneOf.0.bank","typeLabel":"string | null"}},"uniqueKey":"recipient.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"recipient.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient","typeLabel":"object | null"},"end_to_end_id":{"oneOf":[{"type":"string","uniqueKey":"end_to_end_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"end_to_end_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_to_end_id","typeLabel":"string | null"},"failure_reason":{"oneOf":[{"type":"string","uniqueKey":"failure_reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"failure_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure_reason","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","external_id":"\u003cstring>","status":"pending","amount":123,"pix_key_masked":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","recipient":{"name":"\u003cstring>","document":"***.456.789-**","bank":"Banco Exemplo S.A."},"end_to_end_id":"\u003cstring>","failure_reason":"\u003cstring>","metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"898ab992-3ceb-43ea-b894-92c643a58b12":{"description":"Erro","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","example":"insufficient_balance","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"existing_id":{"oneOf":[{"type":"string","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"error.existing_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"error.existing_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.existing_id","typeLabel":"string\u003cuuid> | null"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"insufficient_balance","message":"\u003cstring>","request_id":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}],"existing_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6f02fada-1316-4ac4-8c88-3490d90b77c9":{"description":"Antifraude fora do ar e valor acima de R$ 1.000,00. Repita depois com a mesma Idempotency-Key.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","example":"insufficient_balance","isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"oneOf.0.error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"oneOf.0.error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.error.request_id","typeLabel":"string | null"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"oneOf.0.error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","uniqueKey":"oneOf.0.error.details.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"oneOf.0.error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.error.details","typeLabel":"object[]"},"existing_id":{"oneOf":[{"type":"string","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"oneOf.0.error.existing_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"oneOf.0.error.existing_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.error.existing_id","typeLabel":"string\u003cuuid> | null"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["code"],"properties":{"code":{"type":"string","const":"step_up_required_risk_unavailable","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"insufficient_balance","message":"\u003cstring>","request_id":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}],"existing_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}}},"exampleType":"generated"}},"exampleType":"generated"},"8cd916f1-8553-4a32-8ad9-5431d1eb8230":{"description":"Erro da API ou bloqueio do antifraude","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","example":"insufficient_balance","isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"oneOf.0.error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"oneOf.0.error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.error.request_id","typeLabel":"string | null"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"oneOf.0.error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","uniqueKey":"oneOf.0.error.details.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"oneOf.0.error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.error.details","typeLabel":"object[]"},"existing_id":{"oneOf":[{"type":"string","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"oneOf.0.error.existing_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"oneOf.0.error.existing_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.error.existing_id","typeLabel":"string\u003cuuid> | null"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Bloqueio do antifraude em transferências e devoluções. Formato próprio, sem error.code.","required":["error"],"properties":{"error":{"type":"string","const":"risk_score_exceeded","isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"insufficient_balance","message":"\u003cstring>","request_id":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}],"existing_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}}},"exampleType":"generated"}},"exampleType":"generated"},"470bcbe3-3880-43eb-8591-22adbe429b6e":{"description":"Erro","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","example":"insufficient_balance","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"existing_id":{"oneOf":[{"type":"string","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"error.existing_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"error.existing_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.existing_id","typeLabel":"string\u003cuuid> | null"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"insufficient_balance","message":"\u003cstring>","request_id":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}],"existing_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}}},"exampleType":"generated"}},"exampleType":"generated"},"4b4932e5-5378-4be4-bdc8-5080f9556a16":{"description":"Erro","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","example":"insufficient_balance","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"existing_id":{"oneOf":[{"type":"string","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"error.existing_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"error.existing_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.existing_id","typeLabel":"string\u003cuuid> | null"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"insufficient_balance","message":"\u003cstring>","request_id":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}],"existing_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}}},"exampleType":"generated"}},"exampleType":"generated"},"85913170-ee86-4d36-9fd2-127294cd930d":{"description":"Erro","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","example":"insufficient_balance","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Igual ao header X-Request-ID","isRequired":true,"uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string | null"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"existing_id":{"oneOf":[{"type":"string","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"error.existing_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Só em external_id_conflict","uniqueKey":"error.existing_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.existing_id","typeLabel":"string\u003cuuid> | null"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"insufficient_balance","message":"\u003cstring>","request_id":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}],"existing_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8e46bd55-1fcc-4684-9fe9-4b81cba9eb0e":{"apiKey":{"type":"http","scheme":"bearer","description":"Chave `oripay_live_...`. Só funciona dos IPs cadastrados para ela.","scopes":[],"schemeName":"apiKey"}}},"servers":{"9f7080f5-8536-4fd6-8c72-65772debb1b8":{"url":"https://api.oripaysolutions.com.br/v1","description":"Produção (chave oripay_live_). Sandbox em breve."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Chave `oripay_live_...`. Só funciona dos IPs cadastrados para ela.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Chave `oripay_live_...`. Só funciona dos IPs cadastrados para ela.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"localhost","siteName":"OriPay API","title":"Enviar PIX - OriPay API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/transferências/enviar-pix.mdx"},"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=\"Scope: transfers:write (chave aprovada pela OriPay). Passa pelo antifraude: pode responder 403 { \u0026quot;error\u0026quot;: \u0026quot;risk_score_exceeded\u0026quot; } ou, com o antifraude fora do ar e valor acima de R$ 1.000,00, 401 { \u0026quot;code\u0026quot;: \u0026quot;step_up_required_risk_unavailable\u0026quot; }.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OriPay API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/favicons/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/favicons/favicon-32x32.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/favicons/favicon-16x16.png\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/favicons/favicon.ico\">\u003cmeta data-mint-head property=\"og:title\" content=\"Enviar PIX - OriPay API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Scope: transfers:write (chave aprovada pela OriPay). Passa pelo antifraude: pode responder 403 { \u0026quot;error\u0026quot;: \u0026quot;risk_score_exceeded\u0026quot; } ou, com o antifraude fora do ar e valor acima de R$ 1.000,00, 401 { \u0026quot;code\u0026quot;: \u0026quot;step_up_required_risk_unavailable\u0026quot; }.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OriPay API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.oripaysolutions.com.br/api-reference/transferências/enviar-pix\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.oripaysolutions.com.br/images/og.png\">\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=\"Enviar PIX - OriPay API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Scope: transfers:write (chave aprovada pela OriPay). Passa pelo antifraude: pode responder 403 { \u0026quot;error\u0026quot;: \u0026quot;risk_score_exceeded\u0026quot; } ou, com o antifraude fora do ar e valor acima de R$ 1.000,00, 401 { \u0026quot;code\u0026quot;: \u0026quot;step_up_required_risk_unavailable\u0026quot; }.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.oripaysolutions.com.br/images/og.png\">\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=\"/favicons/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OriPay API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0891B2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.oripaysolutions.com.br/api-reference/transferências/enviar-pix\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/transfer%C3%AAncias/enviar-pix.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OriPay API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OriPay API","nav":{"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":""}]},{"tab":"Referência da API","groups":[{"group":"Endpoints","pages":[{"group":"Saldo e extrato","pages":[{"title":"Consultar saldo","openapi":"/api-reference/openapi.yaml get /balance","href":"/api-reference/saldo-e-extrato/consultar-saldo"},{"title":"Consultar limites PIX","openapi":"/api-reference/openapi.yaml get /limits","href":"/api-reference/saldo-e-extrato/consultar-limites-pix"},{"title":"Listar extrato","openapi":"/api-reference/openapi.yaml get /statement","href":"/api-reference/saldo-e-extrato/listar-extrato"}]},{"group":"Cobranças","pages":[{"title":"Listar cobranças","openapi":"/api-reference/openapi.yaml get /pix/charges","href":"/api-reference/cobranças/listar-cobranças"},{"title":"Criar cobrança (QR dinâmico)","openapi":"/api-reference/openapi.yaml post /pix/charges","href":"/api-reference/cobranças/criar-cobrança-qr-dinâmico"},{"title":"Consultar cobrança","openapi":"/api-reference/openapi.yaml get /pix/charges/{id}","href":"/api-reference/cobranças/consultar-cobrança"}]},{"group":"PIX recebidos","pages":[{"title":"Listar PIX recebidos","openapi":"/api-reference/openapi.yaml get /pix/received","href":"/api-reference/pix-recebidos/listar-pix-recebidos"},{"title":"Consultar PIX recebido","openapi":"/api-reference/openapi.yaml get /pix/received/{id}","href":"/api-reference/pix-recebidos/consultar-pix-recebido"}]},{"group":"Devoluções","pages":[{"title":"Devolver PIX recebido","openapi":"/api-reference/openapi.yaml post /pix/received/{id}/refunds","href":"/api-reference/devoluções/devolver-pix-recebido"}]},{"group":"Transferências","pages":[{"title":"Listar transferências","description":"Scope: `transfers:read`.","openapi":"/api-reference/openapi.yaml get /pix/transfers","href":"/api-reference/transferências/listar-transferências"},{"title":"Enviar PIX","openapi":"/api-reference/openapi.yaml post /pix/transfers","href":"/api-reference/transferências/enviar-pix"},{"title":"Consultar transferência","description":"Scope: `transfers:read`.","openapi":"/api-reference/openapi.yaml get /pix/transfers/{id}","href":"/api-reference/transferências/consultar-transferência"}]},{"group":"Webhooks","pages":[{"title":"Consultar webhook","openapi":"/api-reference/openapi.yaml get /webhook-endpoint","href":"/api-reference/webhooks/consultar-webhook"},{"title":"Enviar evento de teste","openapi":"/api-reference/openapi.yaml post /webhook-endpoint/test","href":"/api-reference/webhooks/enviar-evento-de-teste"},{"title":"Consultar IPs liberados da chave","openapi":"/api-reference/openapi.yaml get /ip-allowlist","href":"/api-reference/webhooks/consultar-ips-liberados-da-chave"},{"title":"Listar eventos (últimos 30 dias)","openapi":"/api-reference/openapi.yaml get /events","href":"/api-reference/webhooks/listar-eventos-últimos-30-dias"},{"title":"Consultar evento","openapi":"/api-reference/openapi.yaml get /events/{id}","href":"/api-reference/webhooks/consultar-evento"},{"title":"Listar tentativas de entrega","openapi":"/api-reference/openapi.yaml get /events/{id}/deliveries","href":"/api-reference/webhooks/listar-tentativas-de-entrega"},{"title":"Reenviar evento","openapi":"/api-reference/openapi.yaml post /events/{id}/resend","href":"/api-reference/webhooks/reenviar-evento"}]},{"group":"API Reference","pages":[{"title":"Evento enviado ao seu endpoint","openapi":"/api-reference/openapi.yaml webhook event","href":"/api-reference/evento-enviado-ao-seu-endpoint"}]}]}]}]},"basePath":"","title":"Enviar PIX - OriPay API","buildId":"b48c568d22cf","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D7wo336Y.js","utils-Dm9zyzuk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DyQG-9DG.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Cb7Xp6KS.js","snippetPresets-D1jos7Rh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BoPLBqmY.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BAJtKqGy.js","shallow-Dq5-SwG1.js","getApiPlaygroundDisplay-wDIhhqfD.js","CodeSnippet-BxA48oHQ.js","CodeSnippets-DuYLY3sy.js","Page-CPu2vF-C.js","getPastedJson-D7mVG7tB.js","icon-HMNWawTa.js","MethodPill-DvQvTgHx.js","DuplicateIcon-DK5o2DOi.js","createIcon-BhUMOhLi.js","DynamicMarkdown-CSW5mrBH.js","SectionHeading-ht66QKGt.js","axios-vUo_bRtp.js","Markdown-CNAGgX2X.js","clsx-DfU2JnNK.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-uP80LYvr.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-R-TmXqAj.js"]}