{"info":{"_postman_id":"9519685c-7573-41a9-a453-503a4eb16578","name":"Confrapix - Publish","description":"

Api para o sistema de ConfraPix da CONFRAPAG para gestão de transações por pix.

\n

Qualquer dúvida realizar abertura de chamado pelo portal, ou diretamente com o Licenciado Autorizado.

\n

Para utilizar a API, basta passar a token no header como BEARER TOKEN.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"34932884","collectionId":"9519685c-7573-41a9-a453-503a4eb16578","publishedId":"2sAXqwXeJN","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-11-07T12:57:54.000Z"},"item":[{"name":"Transaction","item":[{"name":"Store transaction","id":"3eb54d78-5c15-4117-958f-090bef3879b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": 10,\r\n \"customer_name\": \"Customer name example\",\r\n \"customer_document\": \"12312312300\",\r\n \"description\": \"Descrição test\",\r\n \"expiration_date\": \"2025-12-31 23:59:59\",\r\n \"callback_url\": \"https://mydomain-example.com/webhook\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.confrapix.com.br/api/transaction-ec/store","description":"

Cria uma transação.

\n

Cria uma transação pix dinâmico, estas transações sempre virão com o type \"payment\" e com o payment_type \"pix\".

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CampoTipoDescriçãoObrigatório
amountdecimalValor total da cobrança.sim
customer_documentstringDocumento (CPF/CNPJ) de quem está pagando.
⚠️ Atenção: Caso informado, apenas essa pessoa poderá a realizar o pagamento. Além disso, quando informado, o envio do parâmetro customer_name torna-se obrigatório.		não
customer_namestringNome de quem está pagando.
⚠️ Atenção: Caso informado, apenas essa pessoa poderá a realizar o pagamento. Além disso, quando informado, o envio do parâmetro customer_document torna-se obrigatório.		não
descriptionstringDescrição da transação.não
expiration_datedateTimeData e hora que o pix vai expirar (Y-m-d H:i:s).não
callback_urlstringRepresenta a url do seu sistema que será chamada quando houver uma atualização na transação.não
\n
","urlObject":{"protocol":"https","path":["api","transaction-ec","store"],"host":["api","confrapix","com","br"],"query":[],"variable":[]}},"response":[{"id":"d22cc9b2-68ef-437e-b733-c9fcd179bbb7","name":"Success","originalRequest":{"method":"POST","header":[],"url":"https://api.confrapix.com.br/api/transaction-ec/store"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.27"},{"key":"Set-Cookie","value":"XDEBUG_SESSION=PHPSTORM; path=/; SameSite=Lax"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 19 Feb 2025 19:24:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"1000"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"success\": true,\n \"message\": \"Success storing transaction\",\n \"transaction\": {\n \"id\": 64,\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"customer_name\": \"customer_name\",\n \"customer_document\": \"12345678900\",\n \"description\": \"description\",\n \"status\": \"processing\",\n \"confirmed\": false,\n \"type\": \"payment\",\n \"payment_type\": \"pix\",\n \"amount\": 10,\n \"net_amount\": 0,\n \"discount\": 0,\n \"tax_applied_type\": null,\n \"tax_applied\": null,\n \"tax_acquire_type\": null,\n \"tax_acquire\": null,\n \"tax_network\": null,\n \"captured_in\": \"2025-03-10 09:38:08\",\n \"expired_in\": \"2025-12-31 23:59:59\",\n \"payed_in\": null,\n \"pix\": {\n \"url\": \"https://qr.code.example\",\n \"txid\": \"6k3k2e2xg5l60d7a9e1e4dkk432657513\",\n \"code\": \"codigo_copia_e_cola\",\n \"payer_data\": null\n }\n }\n}"},{"id":"9087ce62-e774-48f8-8e0b-f9019ac9144c","name":"Error","originalRequest":{"method":"POST","header":[],"url":"{{base_url}}transaction-ec/store"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.27"},{"key":"Set-Cookie","value":"XDEBUG_SESSION=PHPSTORM; path=/; SameSite=Lax"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 19 Feb 2025 19:27:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"1000"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"success\": false,\n \"message\": \"Error creating transaction in Acquire: CPF Inválido!\",\n \"error\": \"Error creating transaction in Acquire: CPF Inválido!\"\n}"}],"_postman_id":"3eb54d78-5c15-4117-958f-090bef3879b4"},{"name":"Store transaction Static","id":"57325e1e-0fe2-4757-b7b9-681d5ba55dd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"callback_url\": \"https://mydomain-example.com/webhook\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.confrapix.com.br/api/transaction-ec/store-static","description":"

Cria uma transação.

\n

Cria uma transação pix estático, esta transação sempre terá o type \"static\";

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CampoTipoDescriçãoObrigatório
callback_urlstringRepresenta a url do seu sistema que será chamada quando houver uma atualização na transação.não
\n
","urlObject":{"protocol":"https","path":["api","transaction-ec","store-static"],"host":["api","confrapix","com","br"],"query":[],"variable":[]}},"response":[{"id":"03cbb97e-d627-432c-877c-e89a0fed1b05","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"seller_document\": \"12345678900\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}transaction/store-static"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Thu, 27 Feb 2025 12:59:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"983"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Ratelimit-Limit","value":"1000"},{"key":"X-Ratelimit-Remaining","value":"1000"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"br"},{"key":"X-Served-By","value":"api.confrapix.com.br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"success\": true,\n \"message\": \"Success storing transaction static\",\n \"transaction\": {\n \"id\": 1,\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"status\": \"succeeded\",\n \"confirmed\": true,\n \"payment_type\": \"pix\",\n \"type\": \"static\",\n \"captured_in\": \"2025-02-20 10:00:00\",\n \"pix\": {\n \"url\": \"https://qr.code.example\",\n \"txid\": \"6k3k2e2xg5l60d7a9e1e4dkk432657513\",\n \"code\": \"codigo_copia_e_cola\",\n \"payer_data\": null\n }\n }\n}"},{"id":"81dca701-34e9-4ebc-8a80-ece28ceee3f1","name":"Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"seller_document\": \"12345678900\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}transaction/store-static"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Thu, 27 Feb 2025 13:03:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"108"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Ratelimit-Limit","value":"1000"},{"key":"X-Ratelimit-Remaining","value":"999"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"success\": false,\n \"message\": \"Seller with this document not found.\",\n \"error\": \"Seller with this document not found.\"\n}"}],"_postman_id":"57325e1e-0fe2-4757-b7b9-681d5ba55dd7"},{"name":"Store transaction Bankslip","id":"a30572de-199a-48f7-9cb0-adc698698d73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": 10,\r\n \"expiration_date\": \"2025-12-20\",\r\n \"limit_date\": \"2025-12-30\",\r\n\r\n \"customer_name\": \"João da Silva\",\r\n \"customer_document\": \"98765432100\",\r\n \"customer_cep\": \"58000000\",\r\n \"customer_state\": \"PB\",\r\n \"customer_city\": \"João Pessoa\",\r\n \"customer_neighborhood\": \"Centro\",\r\n \"customer_street\": \"Rua das Flores\",\r\n \"customer_number\": \"123\",\r\n \"customer_complement\": \"Apto 202\",\r\n\r\n \"amount_interest\": 2.50,\r\n \"amount_fine\": 1.00,\r\n \"amount_discount\": 5.00,\r\n\r\n \"callback_url\": \"https://minhaapi.com/webhook\",\r\n \"description\": \"Pagamento referente ao pedido #1234\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.confrapix.com.br/api/transaction-ec/store-bankslip","description":"

Cria uma transação BolePix.

\n

Cria uma transação BolePix, estas transações sempre virão com o type \"payment\" e com o payment_type \"bankslip\".

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CampoTipoDescriçãoObrigatório
amountdecimalValor total da transação.sim
expiration_datedateData e hora que o pix vai expirar (Y-m-d).sim
limit_datedateData e hora que o pix vai expirar (Y-m-d).sim
customer_namestringNome do cliente.sim
customer_documentstringDocumento (CPF/CNPJ) do cliente que vai pagar o boleto.sim
customer_cepstringCEP do cliente que vai pagar o boleto.sim
customer_statestringUF (2 CARACTERES SOMENTE) do cliente que vai pagar o boleto.sim
customer_citystringCidade do cliente que vai pagar o boleto.sim
customer_neighborhoodstringBairro do cliente que vai pagar o boleto.sim
customer_streetstringRua do endereço do cliente que vai pagar o boleto.sim
customer_numberstringNúmero da endenreço do cliente que vai pagar o boleto.sim
customer_complementstringComplemento do endereço do cliente que vai pagar o boleto.não
amount_interestdecimalPercentual do juros que será cobrado após o vencimento do boleto.não
amount_finedecimalPercentual da multa que será cobrado após o vencimento do boleto.não
amount_discountdecimalPercentual do desconto que será aplicado até o vencimento do boleto.não
descriptionstringDescrição da transação.não
callback_urlstringRepresenta a url do seu sistema que será chamada quando houver uma atualização na transação.não
\n
","urlObject":{"protocol":"https","path":["api","transaction-ec","store-bankslip"],"host":["api","confrapix","com","br"],"query":[],"variable":[]}},"response":[{"id":"6f4b1394-7afd-4c30-9675-ea5984ed6a31","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": 10,\r\n \"seller_document\": \"12345678900\",\r\n \"expiration_date\": \"2025-12-20\",\r\n \"limit_date\": \"2025-12-30\",\r\n\r\n \"customer_name\": \"João da Silva\",\r\n \"customer_document\": \"98765432100\",\r\n \"customer_cep\": \"58000000\",\r\n \"customer_state\": \"PB\",\r\n \"customer_city\": \"João Pessoa\",\r\n \"customer_neighborhood\": \"Centro\",\r\n \"customer_street\": \"Rua das Flores\",\r\n \"customer_number\": \"123\",\r\n \"customer_complement\": \"Apto 202\",\r\n\r\n \"amount_interest\": 2.50, // qtd juros\r\n \"amount_fine\": 1.00, // qtd multa\r\n \"amount_discount\": 5.00, // qtd descontto\r\n\r\n \"callback_url\": \"https://minhaapi.com/webhook\",\r\n \"description\": \"Pagamento referente ao pedido #1234\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}transaction-ec/store-bankslip"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Thu, 28 Aug 2025 11:15:25 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"569"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Ratelimit-Limit","value":"100"},{"key":"X-Ratelimit-Remaining","value":"100"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"br"},{"key":"X-Served-By","value":"api.confrapix.com.br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"success\": true,\n \"message\": \"Success storing transaction bankslip\",\n \"transaction\": {\n \"id\": 123719,\n \"uuid\": \"7d0919a9-9866-4411-ae8d-74aeaad7bff2\",\n \"customer_name\": \"João da Silva\",\n \"customer_document\": \"98765432100\",\n \"description\": \"Essa transação foi realizada no Estabelecimento Seller test na ás 28/08/2025 08:15. Se você não recebeu o produto ou serviço, não realize o pagamento. Pagamento referente ao pedido #1234\",\n \"status\": \"processing\",\n \"confirmed\": false,\n \"type\": null,\n \"payment_type\": \"bankslip\",\n \"amount\": 10,\n \"net_amount\": 9.71,\n \"discount\": 0.29,\n \"tax_applied\": 2.9,\n \"tax_acquire\": 2.9,\n \"tax_network\": 0,\n \"callback_url\": \"https://minhaapi.com/webhook\",\n \"captured_in\": \"2025-08-28 08:15:17\",\n \"expired_in\": \"2025-12-20\",\n \"payed_in\": null,\n \"bankslip\": {\n \"url\": null,\n \"txid\": null,\n \"pix_code\": null,\n \"number\": null,\n \"barCodeNumber\": null,\n \"digitableLine\": null,\n \"payer_data\": null\n }\n }\n}"}],"_postman_id":"a30572de-199a-48f7-9cb0-adc698698d73"},{"name":"Index transaction","id":"3e213b70-9f76-4ff1-96dd-33b47b221464","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.confrapix.com.br/api/transaction-ec/index?page=1&per_page=10","description":"

Lista transações.

\n

Lista as transações da sua hierarquia dentro do período especificado. Por padrão, a listagem exibirá a primeira página, com 10 registros por página.

\n","urlObject":{"protocol":"https","path":["api","transaction-ec","index"],"host":["api","confrapix","com","br"],"query":[{"disabled":true,"description":{"content":"

Id da transação

\n","type":"text/plain"},"key":"id","value":"1"},{"disabled":true,"description":{"content":"

Uuid da transação

\n","type":"text/plain"},"key":"uuid","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"disabled":true,"description":{"content":"

Id da transação estática de origem

\n","type":"text/plain"},"key":"transaction_origin_id","value":"2"},{"disabled":true,"description":{"content":"

Tipo da transação (\"payment\", \"static\")

\n","type":"text/plain"},"key":"type","value":"payment"},{"disabled":true,"description":{"content":"

Status da transação (processing, failed, succeeded, canceled)

\n","type":"text/plain"},"key":"status","value":"processing"},{"disabled":true,"description":{"content":"

1 = Transação paga | 0 = Transação não paga

\n","type":"text/plain"},"key":"confirmed","value":"1"},{"disabled":true,"description":{"content":"

Nome do pagador

\n","type":"text/plain"},"key":"customer_name","value":"Nome"},{"disabled":true,"description":{"content":"

Documento do pagador

\n","type":"text/plain"},"key":"customer_document","value":"12345678900"},{"disabled":true,"description":{"content":"

Quantia mínima da transação

\n","type":"text/plain"},"key":"amount_min","value":"1"},{"disabled":true,"description":{"content":"

Quantia máxima da transação

\n","type":"text/plain"},"key":"amount_max","value":"100"},{"disabled":true,"description":{"content":"

Periódo inicial da captura da transação

\n","type":"text/plain"},"key":"captured_in_start","value":"2025-06-01 0:00:00"},{"disabled":true,"description":{"content":"

Periódo final da captura da transação

\n","type":"text/plain"},"key":"captured_in_end","value":"2025-06-30 23:59:59"},{"disabled":true,"description":{"content":"

Periódo inicial do pagamento da transação

\n","type":"text/plain"},"key":"payed_in_start","value":"2024-01-01 00:00:00"},{"disabled":true,"description":{"content":"

Periódo final do pagamento da transação

\n","type":"text/plain"},"key":"payed_in_end","value":"2024-12-31 23:59:59"},{"description":{"content":"

Página da listagem

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Quantidade de transações por página

\n","type":"text/plain"},"key":"per_page","value":"10"}],"variable":[]}},"response":[{"id":"f19b8231-99b0-46c1-a6a1-128c49855b37","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.confrapix.com.br/api/transaction/index"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.8"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 03 Jul 2024 20:32:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"message\": \"Success consulting transactions\",\n \"current_page\": 1,\n \"last_page\": 1,\n \"total\": 1,\n \"total_net_amount\": \"0\",\n \"total_amount\": \"10\",\n \"total_amount_succeeded\": \"0\",\n \"total_amount_processing\": \"10\",\n \"transaction\": [\n {\n \"id\": 1,\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"transaction_origin_id\": null,\n \"devolution_code\": null,\n \"customer_name\": \"Customer Name\",\n \"customer_document\": \"12345678900\",\n \"description\": \"Testing\",\n \"status\": \"processing\",\n \"confirmed\": false,\n \"type\": \"payment\",\n \"payment_type\": \"pix\",\n \"seller_id\": 2,\n \"seller_document\": \"11122233300\",\n \"seller_trading_name\": \"Seller name\",\n \"seller_la_trading_name\": \"Seller La name\",\n \"amount\": \"10.0000\",\n \"net_amount\": \"0.0000\",\n \"discount\": \"0.0000\",\n \"captured_in\": \"2025-02-19 16:00:00\",\n \"expired_in\": \"2025-02-20 23:59:59\",\n \"payed_in\": null\n }\n ]\n}"}],"_postman_id":"3e213b70-9f76-4ff1-96dd-33b47b221464"},{"name":"Show transaction pix","id":"943e9ba0-959c-4be6-98de-1238181534c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.confrapix.com.br/api/transaction-ec/show/:transaction_id","description":"

Busca uma transação.

\n

Busca os detalhes de uma transação pix da sua hierarquia a partir do id informado.

\n","urlObject":{"protocol":"https","path":["api","transaction-ec","show",":transaction_id"],"host":["api","confrapix","com","br"],"query":[],"variable":[{"type":"any","value":"","key":"transaction_id"}]}},"response":[{"id":"4e7e00f7-a767-4a51-97e3-edbbd84abc43","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.confrapix.com.br/api/transaction/show/{transaction_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.8"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 28 Jun 2024 18:04:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"message\": \"Success consulting transaction\",\n \"transaction\": {\n \"id\": 1,\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"devolution_code\": null,\n \"customer_name\": \"customer_name\",\n \"customer_document\": \"12345678900\",\n \"description\": \"description\",\n \"status\": \"succeeded\",\n \"confirmed\": true,\n \"type\": \"payment\",\n \"payment_type\": \"pix\",\n \"amount\": \"2.0000\",\n \"net_amount\": \"1.8240\",\n \"discount\": \"0.1760\",\n \"tax_applied_type\": \"percentage\",\n \"tax_applied\": \"1.3000\",\n \"tax_acquire_type\": \"decimal\",\n \"tax_acquire\": \"0.1500\",\n \"tax_network\": null,\n \"captured_in\": \"2025-01-17 11:11:31\",\n \"expired_in\": \"2025-01-18 23:59:59\",\n \"payed_in\": \"2025-01-17 14:12:51\",\n \"pix\": {\n \"url\": \"https://qr.code.example\",\n \"txid\": \"f7a80d3c9a6b17df4a2f8a76\",\n \"code\": \"codigo_copia_e_cola\",\n \"payer_data\": {\n \"cpf\": \"12345678900\",\n \"nome\": \"NAME EXAMPLE\"\n }\n },\n \"seller\": {\n \"id\": 2,\n \"document\": \"11122233300\",\n \"trading_name\": \"Trading name\",\n \"seller_la\": {\n \"document\": \"12345678900\",\n \"trading_name\": \"La Trading name\"\n }\n }\n }\n}"},{"id":"e62618e1-b34e-426d-b666-91f65277e21b","name":"Error","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}transaction/show/{transaction_id}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.8"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 28 Jun 2024 18:04:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 204,\n \"success\": true,\n \"message\": \"Transaction not found\"\n}"}],"_postman_id":"943e9ba0-959c-4be6-98de-1238181534c9"},{"name":"Show transaction bankslip","id":"74b850c7-c0ca-4b78-9d6b-a4c47f032f89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.confrapix.com.br/api/transaction-ec/show/:transaction_id","description":"

Busca uma transação.

\n

Busca os detalhes de uma transação bankslip da sua hierarquia a partir do id informado.

\n","urlObject":{"protocol":"https","path":["api","transaction-ec","show",":transaction_id"],"host":["api","confrapix","com","br"],"query":[],"variable":[{"type":"any","value":"","key":"transaction_id"}]}},"response":[{"id":"9b23f38d-17ae-4d67-8c34-25a343e1bd10","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.confrapix.com.br/api/transaction/show/{transaction_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.8"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 28 Jun 2024 18:04:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"message\": \"Success consulting transaction\",\n \"transaction\": {\n \"id\": 1,\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"devolution_code\": null,\n \"customer_name\": \"customer_name\",\n \"customer_document\": \"12345678900\",\n \"description\": \"description\",\n \"status\": \"succeeded\",\n \"confirmed\": true,\n \"type\": \"payment\",\n \"payment_type\": \"bankslip\",\n \"amount\": \"2.0000\",\n \"net_amount\": \"1.8240\",\n \"discount\": \"0.1760\",\n \"tax_applied_type\": \"percentage\",\n \"tax_applied\": \"1.3000\",\n \"tax_acquire_type\": \"decimal\",\n \"tax_acquire\": \"0.1500\",\n \"tax_network\": null,\n \"captured_in\": \"2025-01-17 11:11:31\",\n \"expired_in\": \"2025-01-18 23:59:59\",\n \"payed_in\": \"2025-01-17 14:12:51\",\n \"bankslip\": {\n \"url\": \"https://api.pagamentos-teste.com.br\",\n \"txid\": \"ab9k482nsl72b1cdff5aa91mn3847265910\",\n \"pix_code\": \"00020101021226880014br.gov.bcb.pix2566pix.teste.com/qrcode/v2/cobv/9f8a7b6c5d4e3f2a1b0c04000053039865802BR5920EMPRESA TESTE LTDA6014Sao Paulo62070503***6304ABCD\",\n \"number\": \"f83b12c9a7e4d65f91ab230c\",\n \"barCodeNumber\": \"34191790010104351004791020150008291070026000\",\n \"digitableLine\": \"34191010435100479102015000829107002600079000\",\n \"payer_data\": {\n \"tipoPessoa\": 2,\n \"nomeRazao\": \"PADARIA PÃO QUENTE LTDA\",\n \"nomeFantasia\": \"PADARIA PÃO QUENTE\",\n \"documentoFederal\": \"12345678000199\",\n \"logradouro\": \"Rua das Flores, 123\",\n \"cidade\": \"Recife\",\n \"uf\": \"PE\",\n \"cep\": \"50030000\"\n },\n \"receiver_data\": {\n \"name\": \"TECH SOLUTIONS BRASIL LTDA\",\n \"document\": \"98765432000155\",\n \"code\": null,\n \"branch\": null,\n \"account\": null,\n \"pix_key\": \"email@teste.com\",\n \"ispb\": \"12345678\",\n \"provider\": \"MockBank\"\n }\n },\n \"seller\": {\n \"id\": 2,\n \"document\": \"11122233300\",\n \"trading_name\": \"Trading name\",\n \"seller_la\": {\n \"document\": \"12345678900\",\n \"trading_name\": \"La Trading name\"\n }\n }\n }\n}"},{"id":"a9ae6749-b37d-4335-a34e-09b9d54ef96f","name":"Error","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}transaction/show/{transaction_id}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.8"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 28 Jun 2024 18:04:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 204,\n \"success\": true,\n \"message\": \"Transaction not found\"\n}"}],"_postman_id":"74b850c7-c0ca-4b78-9d6b-a4c47f032f89"},{"name":"Canceling Transaction","id":"ec256a17-816c-461d-b673-1b0035320b22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"url":"https://api.confrapix.com.br/api/transaction-ec/cancel/:transaction_id","description":"

Cancela uma transação.

\n

Cancela todos os tipos de transaction (pix dinamico, pix estático e bolepix) que estão processando. É possível cancelar uma transaction dentro de 24h após ela ser paga, reembolsando o valor.
Quando o request é finalizado com sucesso, o status da transação vai ser atualizado de forma assíncrona através do webhook.

\n","urlObject":{"protocol":"https","path":["api","transaction-ec","cancel",":transaction_id"],"host":["api","confrapix","com","br"],"query":[],"variable":[{"type":"any","value":"","key":"transaction_id"}]}},"response":[{"id":"c2aef031-5da8-4f7b-9507-b25318636743","name":"Success","originalRequest":{"method":"PUT","header":[],"url":"{{base_url}}transaction-ec/cancel/{transaction_id}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"message\": \"Success canceling transaction\",\n \"transaction\": {\n \"id\": 1,\n \"uuid\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"customer_name\": null,\n \"customer_document\": null,\n \"description\": null,\n \"status\": \"canceled\",\n \"confirmed\": false,\n \"type\": \"payment\",\n \"payment_type\": \"pix\",\n \"amount\": \"1.50\",\n \"net_amount\": \"0.0000\",\n \"discount\": \"0.0000\",\n \"tax_applied_type\": null,\n \"tax_applied\": null,\n \"tax_acquire_type\": null,\n \"tax_acquire\": null,\n \"tax_network\": null,\n \"captured_in\": \"2025-01-01 10:00:00\",\n \"expired_in\": \"2025-02-01 10:00:00\",\n \"payed_in\": null,\n \"pix\": {\n \"url\": \"https://qr.code.example\",\n \"txid\": \"6k3k2e2xg5l60d7a9e1e4dkk432657513\",\n \"code\": \"codigo_copia_e_cola\",\n \"payer_data\": null\n }\n }\n}"}],"_postman_id":"ec256a17-816c-461d-b673-1b0035320b22"}],"id":"0ff2bcc1-5b10-46e0-8bea-f0ab8b78d3cf","description":"

Requisições relacionadas à transferências de entrada (transações). Path: /transaction-ec.

\n

Para utilizar os endpoints de transação, não é necessário autenticar-se no sistema Confrapix. Basta incluir a token fornecida como Bearer Token no header da requisição.

\n

⚠️ Importante: A token de acesso deve ser solicitada a um desenvolvedor responsável pelo sistema Confrapix. Para a geração da token, é necessário informar o documento (CPF/CNPJ) do seller ao qual a token estará vinculada.

\n
\n

Descrição dos campos:

\n
    \n

  • id — Identificador da transação.

    \n
    • \n

  • uuid — Identificador único universal de 128 bits.

    \n
    • \n

  • endtoend — Identificador único do SPI do Banco Central, preenchido somente após uma transação ser paga.

    \n
    • \n

  • customer_name — Caso inserido, somente a pessoa com este nome pode realizar o pagamento.

    \n
    • \n

  • customer_document — Caso inserido, somente a pessoa com este documento pode realizar o pagamento.

    \n
    • \n

  • description — Descrição que aparece na transação.

    \n
    • \n

  • status — indica a situação atual da transação:

    \n
      \n

    • processing: A transação é criada e está esperando ser paga/cancelada.

      \n
      • \n

    • succeeded: A transação foi paga.

      \n
      • \n

    • canceled: A transação foi cancelada.

      \n
      • \n

    • error: Ocorreu um erro ao processar a transação.

      \n
      • \n

    • disable: Transação desabilitada.

      \n
      • \n
    \n
    • \n

  • confirmed — Indica se a transação foi paga. Para Pix estático, indica se o QR Code está ativo.

    \n
    • \n

  • type — Indica o tipo da transação:

    \n
      \n

    • payment: Transação de pix único com valor fixo.

      \n
      • \n

    • static: Transação de um pix estático. O valor é inserido no momento do pagamento.

      \n
      • \n
    \n
    • \n

  • payment_type — Indica o tipo de pagamento da transação

    \n
      \n

    • pix: Transação pix.

      \n
      • \n

    • bankslip: Transação boleto.

      \n
      • \n
    \n
    • \n

  • amount — Valor total da transação.

    \n
    • \n

  • net_amount — Valor líquido da transação.

    \n
    • \n

  • discount — Desconto da transação.

    \n
    • \n

  • tax_applied — Taxa aplicada que define o desconto da transação.

    \n
    • \n

  • callback_url — URL chamada quando ocorrer qualquer atualização com a transação. Usava para o envio do webhook.

    \n
    • \n

  • captured_in — Data da emissão/criação da transação.

    \n
    • \n

  • expired_in — Data que a transação vai expirar, caso esteja processando, ficando inválida.

    \n
    • \n

  • payed_in — Data que a transação foi paga.

    \n
    • \n

  • pix — Dados do pix, recebido diretamente do fornecedor:

    \n
      \n

    • url: URL do pix.

      \n
      • \n

    • code: Código copia e cola.

      \n
      • \n

    • payer_data: Dados de quem pagou o pix.

      \n
      • \n

    • receiver_data: Dados de quem recebeu o pix (próprio estabelecimento).

      \n
      • \n
    \n
    • \n

  • bankslip — Dados do bolepix (boleto pix), recebido diretamente do fornecedor:

    \n
      \n

    • pix_code: Código copia e cola.

      \n
      • \n

    • barCodeNumber: Código de barras.

      \n
      • \n

    • digitableLine: Linha digitável.

      \n
      • \n

    • payer_data: Dados de quem pagou o pix.

      \n
      • \n

    • receiver_data: Dados de quem recebeu o pix (próprio estabelecimento).

      \n
      • \n
    \n
    • \n

  • seller — Dados do estabelecimento que criou a transação.

    \n
    • \n
\n","_postman_id":"0ff2bcc1-5b10-46e0-8bea-f0ab8b78d3cf"},{"name":"Webhook","item":[{"name":"Callback Transaction","id":"d780c45f-3efe-487a-895f-57443a534c00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"uuid\": \"****\",\r\n \"customer_name\": null,\r\n \"customer_document\": null,\r\n \"description\": null,\r\n \"payment_type\": \"pix\",\r\n \"status\": \"processing\",\r\n \"confirmed\": false,\r\n \"amount\": \"10.0000\",\r\n \"net_amount\": \"0.0000\",\r\n \"discount\": \"0.0000\",\r\n \"callback_url\": \"https://exemplo.com\",\r\n \"expired_in\": \"2025-05-19 15:51:00\",\r\n \"captured_in\": \"2025-04-24 14:35:47\",\r\n \"payed_in\": null,\r\n \"type\": \"payment\",\r\n \"seller_document\": \"***********\",\r\n \"pix\": {\r\n \"url\": \"https://qr.example.com/pix/****\",\r\n \"txid\": \"***************\",\r\n \"code\": \"***\",\r\n \"endtoend_id\": \"***********\",\r\n \"payer_data\": {\r\n \"cpf\": \"***********\",\r\n \"nome\": \"Cliente Exemplo\",\r\n \"cnpj\": \"\"\r\n }\r\n },\r\n \"bankslip\": {\r\n \"url\": \"https://qr.example.com/pix/****\",\r\n \"txid\": \"***************\",\r\n \"pix_code\": \"***\",\r\n \"number\": \"***********\",\r\n \"barCodeNumber\": \"***********\",\r\n \"digitableLine\": \"***********\",\r\n \"payer_data\": {\r\n \"cpf\": \"***********\",\r\n \"nome\": \"Cliente Exemplo\",\r\n \"cnpj\": \"\"\r\n }\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://callback-url.com.br","description":"

Callback de transação.

\n

Payload que será enviado para a callback_url cadastrada no momento da criação da transação.

\n

Caso a transação seja um pix, vai retornar com o obj \"pix\", caso seja um bolePix, vai retornar com o obj \"bankslip\".

\n","urlObject":{"protocol":"https","host":["callback-url","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"d780c45f-3efe-487a-895f-57443a534c00"}],"id":"9584c97e-9e74-4a79-a842-13f53dbed26c","description":"

Requisições relacionadas ao callback das transações.

\n

Quando ocorrer uma atualização na transação, será chamado a callback_url para seu sistema.

\n

⚠️ Importante: Para que ocorra um callback na transação, é necessário passar o dado callback_url no payload.

\n

⚠️ Importante: A definição e utilidade de cada campo está descrito no inicio da documentação (work in progress)

\n","_postman_id":"9584c97e-9e74-4a79-a842-13f53dbed26c"},{"name":"version","id":"2f9ef274-7c37-4d68-bc0f-05244030fe45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.confrapix.com.br/api","description":"

Busca a versão do Confrapix. Possível usar este endpoint para testar a url do Confrapix.

\n","urlObject":{"protocol":"https","path":["api"],"host":["api","confrapix","com","br"],"query":[],"variable":[]}},"response":[{"id":"974cfb65-aa9a-4dc5-ba1e-6fc251e82e06","name":"Success","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"server","value":"openresty"},{"key":"date","value":"Tue, 24 Mar 2026 22:03:21 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"30"},{"key":"cache-control","value":"no-cache, private"},{"key":"x-powered-by","value":"PHP/8.5.4"},{"key":"x-ratelimit-limit","value":"100"},{"key":"x-ratelimit-remaining","value":"99"},{"key":"x-served-by","value":"api.confrapix.com.br"}],"cookie":[],"responseTime":null,"body":"\"Welcome to CONFRAPIX - 1.0.0\""}],"_postman_id":"2f9ef274-7c37-4d68-bc0f-05244030fe45"}],"event":[{"listen":"prerequest","script":{"id":"85e62571-4fda-4922-aa5d-678c23f858ac","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"bcaca2f2-e500-4fcf-b0bf-fe0a7cc43ddc","type":"text/javascript","packages":{},"exec":[""]}}]}