Aqui você vai encontrar tudo que precisa para realizar a sua integração da melhor forma possível. Venha conosco e ajudaremos a alavancar o seu negócio!
\nPara acessar os EndPoints é necessário gerar as chaves de acesso da conta do usuário. Isto é feito acessando a conta pelo portal com o nome de usuário e senha do cliente.
\nDentro da conta, basta clicar no menu lateral \"Chaves API\" e seguir as instruções na tela para Gerar as Chaves.
\nSerá exibido o Client ID (ci) e Secret ID (cs) ao final do procedimento. Estes dados devem ser armazenados em local seguro, pois não será possível visualizar as chaves novamente, apenas gerar novas chaves, revogando as chaves anteriores.
\nAs chaves devem ser enviadas juntos da requisição no cabeçalho HTTP das mesmas com os nomes ci para Client ID e cs para Secret ID
\n200 - Sucesso.
\n401 - Falha na autenticação.
\n400 - Erro na solicitação, verifique o response do retorno.
\n500 - Erro interno.
\nVocê pode validar se as chamadas para o seu webhook são válidas, caso venha dos seguintes IP's:
\n3.132.137.46
\nÉ necessário a criação de um webhook para o recebimento dos status das transações em seu sistema.
\nO webhook deve ser do tipo Rest, aceitar requisições POST e receber os seguintes dados no Request (JSON):
\n| Variável | Type | Descrição |
|---|---|---|
idTransaction | String | ID da transação. |
typeTransaction | String | Tipo da transação (PIX). |
statusTransaction | String | Status da transação (PAID_OUT, CHARGEBACK) |
value | Number | Valor do pagamento |
payerName | String | Nome do pagador |
payerTaxId | String | Documento do pagador |
paymentDate | String | Data e hora do pagamento. (dd/MM/yyyy HH:mm:ss) |
paymentCode | String | Código de pagamento |
requestNumber | String | requestNumber enviado na requisição |
statusTransaction:
\nPAID_OUT - Transação paga
CHARGEBACK - Estorno
Client ID
\n","type":"text"},{"key":"cs","value":"{{SecredID}}","description":"Client Secret
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"requestNumber\": \"12345\",\r\n \"dueDate\": \"2022-10-30\",\r\n \"amount\": 300.00,\r\n \"shippingAmount\": 0.0,\r\n \"discountAmount\": 0.0,\r\n \"usernameCheckout\": \"checkout\",\r\n \"callbackUrl\": \"https://webhook.com/\",\r\n \"client\": {\r\n \"name\":\"José da Silva\",\r\n \"document\":\"927.300.300-18\",\r\n \"phoneNumber\": \"62999815500\",\r\n \"email\": \"josesilva@gmail.com\",\r\n \"address\": {\r\n \"codIbge\":\"5208707\",\r\n \"street\":\"Rua Paraíba\",\r\n \"number\":\"150\",\r\n \"complement\":\"\",\r\n \"zipCode\":\"74663-520\",\r\n \"neighborhood\":\"Goiânia 2\",\r\n \"city\":\"Goiânia\",\r\n \"state\":\"GO\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://axos.com.br/pay/api/v1/gateway/request-qrcode","description":"Endpoint para geração do Código de Pagemento (QrCode) de pagamento PIX.
\nRequest
\nResponse
\n| Variável | Tipo | Descrição |
|---|---|---|
idTransaction | String | ID único da transação. |
paymentCode | String | Código de pagamento gerado (QrCode). |
response | String | Mensagem de retorno da solicitação. |
paymentCodeBase64 | String | Imagem do qrCode na base64. |
Endpoint para transferência de valores através de PIX.
\nPara utilizar esse endpoint, é necessário cadastrar o IP do seu servidor de onde vai vir as requisições, pois somente será permitido PIX de saída pela API com o IP cadastrado.
\nPara cadastrar o IP, vai até o menu GATEWAY/CHECKOUT -> GERENCIAMENTO DE IPs.
\nRequest
\n| Variável | Type | Descrição |
|---|---|---|
key | String | Chave PIX. (Obrigatório) |
typeKey | String | Tipo da chave PIX, aceita os seguintes valores: document(CPF/CNPJ), phoneNumber(6299995432), email, randomKey(Chave Aleatória), paymentCode(QrCode). (Obrigatório) |
value | Number | Valor da transferência. Exemplo(156.79) (Obrigatório) |
callbackUrl | String | URL de webhook para receber as informações sobre o pagamento. (Opcional) |
documentValidation | String | Se você quiser validar que um documento (CPF ou CNPJ) seja da chave pix enviada, é só enviar esse campo preenchido. Se esse campo estiver preenchido, o PIX só será concluído se o documento informado for igual ao que pertence a chave PIX. (Opcional) |
externalId | String | ID opcional que pode ser enviado para controle de duplicidade. Quando esse ID é enviado pelo usuário, ele deve ser único, pois se for enviado um ID repetido, o PIX não será processado, retornando a seguinte mensagem: DUPLICATE_EXTERNAL_ID (External ID já foi utilizado, favor enviar outro External ID para realizar essa operação). (Opcional) |
Response
\nHTTP 400 - Verificar campo response
\nHTTP 404 - Chave Pix não encontrada
\nHTTP 500 - Erro Interno
\nHTTP 200 - Sucesso
\n| Variável | Type | Descrição |
|---|---|---|
idTransaction | String | ID da transação. |
response | String | Retorno da transação. |
Campo response
\nOK - Transação realizada com sucesso
\nACCOUNT_DOCUMENTS_NOT_VALIDATED - Conta não validada
\nNO_FUNDS - Saldo insuficiente
\nPIX_KEY_NOT_FOUND - Chave PIX não encontrada
\nUNAUTHORIZED_IP - IP não autorizado
\nDOCUMENT_VALIDATE - A chave pix não pertence ao documento informado na validação (documentValidation).
\nDUPLICATE_EXTERNAL_ID - External ID já foi utilizado, favor enviar outro External ID para realizar essa operação.
\nERROR - Erro interno
\n","urlObject":{"protocol":"https","path":["pay","api","v1","gateway","pix-payment"],"host":["axos","com","br"],"query":[],"variable":[]}},"response":[{"id":"5cba5bc6-e6ba-45d0-ae5a-91cc4e8fe352","name":"200 - OK","originalRequest":{"method":"POST","header":[{"key":"ci","value":"{{ci}}","type":"text"},{"key":"cs","value":"{{cs}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\":10.0,\r\n \"key\":\"62999819652\",\r\n \"typeKey\":\"phoneNumber\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v1/gateway/pix-payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Pragma","value":"no-cache"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Date","value":"Mon, 29 May 2023 19:32:37 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"idTransaction\": \"10dc395c-bee0-4368-a980-85a610987e30\",\n \"response\": \"OK\"\n}"},{"id":"748427f9-ae27-4448-be1c-0e0d737cd487","name":"400 - Erro","originalRequest":{"method":"POST","header":[{"key":"ci","value":"{{ci}}","type":"text"},{"key":"cs","value":"{{cs}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\":1.0,\r\n \"key\":\"62999815465\",\r\n \"typeKey\":\"phoneNumber\",\r\n \"callbackUrl\": \"https://webhook.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v1/gateway/pix-payment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Pragma","value":"no-cache"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Date","value":"Mon, 11 Sep 2023 04:06:31 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"NO_FUNDS\",\n \"message\": \"Sem saldo para executar esta operação.\",\n \"codeAntiFraud\": null\n}"},{"id":"65941659-4a0f-4915-adc1-5a22ef1b5702","name":"400 - Documento Inválido","originalRequest":{"method":"POST","header":[{"key":"ci","value":"{{ci}}","type":"text"},{"key":"cs","value":"{{cs}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\":1.0,\r\n \"key\":\"62999815465\",\r\n \"typeKey\":\"phoneNumber\",\r\n \"callbackUrl\": \"https://webhook.com\",\r\n \"documentValidation\": \"858.353.120-08\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/v1/gateway/pix-payment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Feb 2024 03:32:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Pragma","value":"no-cache"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"DOCUMENT_VALIDATE\",\n \"message\": \"A chave pix não pertence ao documento informado na validação.\",\n \"codeAntiFraud\": null\n}"}],"_postman_id":"13e08bc1-c7fd-4d2e-9b61-0efef1616831"}],"id":"a8c96fec-c68a-43d2-ae24-82b1397a1dd8","_postman_id":"a8c96fec-c68a-43d2-ae24-82b1397a1dd8","description":""}]}