CONTEÚDO
01. VISÃO GERAL
...
Método | URL |
---|
POST | https://api-barramento.meuelevestage.com/order/payment |
...
03. EXEMPLO DE UTILIZAÇÃO
01. Corpo da requisição de envio do processamento de um pagamento:
Bloco de código |
---|
title | Corpo da requisição no JSON |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "efdd6093-5539-4ac4-ad84-7423a8078dde",
"orderKeyType": "TABLE",
"orderKey": "2",
"paymentObject": {
"printOrderAtPos": true,
"generateInvoice": true,
"printInvoiceAtPos": true,
"sendInvoiceEmail": false,
"summaryExtract": false,
"customerDocument": null,
"documentInReceipt": false,
"numberPersons": 1,
"removeServiceFee": false,
"methods": [
{
"value": 67.10,
"currency": "BRL",
"type": "OFFLINE",
"method": "CREDIT",
"methodInfo": "VISA"
}
],
"orderAmount": 61.0,
"discounts": 0.00,
"fees": 6.10,
"total": 67.10
}
} |
Nota |
---|
title | Nota: HTTP Status Code = 202 Accepted |
---|
|
O seu pedido foi aceite, mas ainda não foi processado, aguarde alguns instantes e contacte o mesmo endereço para obter o resultado do pagamento da encomenda solicitada. |
...
02. Retorno da requisição do processamento do pagamento:
Âncora |
---|
| pgto_processamento |
---|
| pgto_processamento |
---|
|
Bloco de código |
---|
title | JSON Para retornar o status de um pedido específico |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType_orderKey",
"message": "Order Payment request already exists: TABLE-2"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 208 Already Reported |
---|
|
Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status. |
...
03. Retorno da requisição após realização do processamento do pagamento e emissão da NFCe:
Bloco de código |
---|
title | JSON da resposta do processamento |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "4bac08db-2c6e-4663-a285-d7acfdce579c",
"success": true,
"orderKeyType": "TABLE",
"orderKey": "50",
"paymentObject": {
"printOrderAtPos": true,
"generateInvoice": true,
"printInvoiceAtPos": true,
"sendInvoiceEmail": false,
"summaryExtract": false,
"customerDocument": null,
"documentInReceipt": false,
"numberPersons": 1,
"removeServiceFee": false,
"methods": [
{
"value": 67.1,
"currency": "BRL",
"type": "ONLINE",
"method": "CREDIT",
"methodInfo": "VISA"
}
],
"orderAmount": 61,
"discounts": 0,
"fees": 6.1,
"total": 67.1
},
"invoiceDetails": {
"orderXML": "
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<nfeProc versao=\"4.00\"
xmlns=\"http://www.portalfiscal.inf.br/nfe\" >
<NFe>
<infNFe versao=\"4.00\" Id=\"NFe35240882373077000171650010004112441194594623\">
<ide>
<cUF>35</cUF>
<cNF>19459462</cNF>
<natOp>VENDA</natOp>
<mod>65</mod>
<serie>1</serie>
<nNF>411244</nNF>
<dhEmi>2024-08-16T15:17:35-03:00</dhEmi>
<tpNF>1</tpNF>
<idDest>1</idDest>
<cMunFG>3539806</cMunFG>
<tpImp>4</tpImp>
<tpEmis>1</tpEmis>
<cDV>3</cDV>
<tpAmb>2</tpAmb>
<finNFe>1</finNFe>
<indFinal>1</indFinal>
<indPres>1</indPres>
<procEmi>0</procEmi>
<verProc>03.2408.</verProc>
</ide>
<emit>
<CNPJ>82373077000171</CNPJ>
<xNome>ALBINO LTDA</xNome>
<xFant>BOTECO DO ALBINO</xFant>
<enderEmit>
<xLgr>AMELIA LATURRE</xLgr>
<nro>100</nro>
<xBairro>CENTRO</xBairro>
<cMun>3539806</cMun>
<xMun>POA</xMun>
<UF>SP</UF>
<CEP>13211815</CEP>
<cPais>1058</cPais>
<xPais>BRASIL</xPais>
<fone>4145838800</fone>
</enderEmit>
<IE>128571670117</IE>
<IM>65656565</IM>
<CRT>3</CRT>
</emit>
<det nItem=\"1\">
<prod>
<cProd>058</cProd>
<cEAN>SEM GTIN</cEAN>
<xProd>NOTA FISCAL EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xProd>
<NCM>22021000</NCM>
<cBenef>PR810000</cBenef>
<CFOP>5101</CFOP>
<uCom>UN</uCom>
<qCom>1.0000</qCom>
<vUnCom>61.0000</vUnCom>
<vProd>61.00</vProd>
<cEANTrib>SEM GTIN</cEANTrib>
<uTrib>UN</uTrib>
<qTrib>1.0000</qTrib>
<vUnTrib>61.0000</vUnTrib>
<indTot>1</indTot>
</prod>
<imposto>
<vTotTrib>19.45</vTotTrib>
<ICMS>
<ICMS20>
<orig>0</orig>
<CST>20</CST>
<modBC>3</modBC>
<pRedBC>12.0000</pRedBC>
<vBC>53.68</vBC>
<pICMS>18.0000</pICMS>
<vICMS>9.66</vICMS>
</ICMS20>
</ICMS>
<PIS>
<PISNT>
<CST>07</CST>
</PISNT>
</PIS>
<COFINS>
<COFINSNT>
<CST>07</CST>
</COFINSNT>
</COFINS>
</imposto>
</det>
<det nItem=\"2\">
<prod>
<cProd>999</cProd>
<cEAN>SEM GTIN</cEAN>
<xProd>TAXA SERVICO</xProd>
<NCM>22021000</NCM>
<CFOP>5102</CFOP>
<uCom>UN</uCom>
<qCom>6.1000</qCom>
<vUnCom>1.0000</vUnCom>
<vProd>6.10</vProd>
<cEANTrib>SEM GTIN</cEANTrib>
<uTrib>UN</uTrib>
<qTrib>6.1000</qTrib>
<vUnTrib>1.0000</vUnTrib>
<indTot>1</indTot>
</prod>
<imposto>
<vTotTrib>1.95</vTotTrib>
<ICMS>
<ICMS00>
<orig>0</orig>
<CST>00</CST>
<modBC>3</modBC>
<vBC>6.10</vBC>
<pICMS>3.0000</pICMS>
<vICMS>0.18</vICMS>
</ICMS00>
</ICMS>
<PIS>
<PISNT>
<CST>07</CST>
</PISNT>
</PIS>
<COFINS>
<COFINSNT>
<CST>07</CST>
</COFINSNT>
</COFINS>
</imposto>
</det>
<total>
<ICMSTot>
<vBC>59.78</vBC>
<vICMS>9.84</vICMS>
<vICMSDeson>0.00</vICMSDeson>
<vFCP>0.00</vFCP>
<vBCST>0.00</vBCST>
<vST>0.00</vST>
<vFCPST>0.00</vFCPST>
<vFCPSTRet>0.00</vFCPSTRet>
<vProd>67.10</vProd>
<vFrete>0.00</vFrete>
<vSeg>0.00</vSeg>
<vDesc>0.00</vDesc>
<vII>0.00</vII>
<vIPI>0.00</vIPI>
<vIPIDevol>0.00</vIPIDevol>
<vPIS>0.00</vPIS>
<vCOFINS>0.00</vCOFINS>
<vOutro>0.00</vOutro>
<vNF>67.10</vNF>
<vTotTrib>21.40</vTotTrib>
</ICMSTot>
</total>
<transp>
<modFrete>9</modFrete>
</transp>
<pag>
<detPag>
<indPag>0</indPag>
<tPag>03</tPag>
<vPag>67.10</vPag>
<card>
<tpIntegra>2</tpIntegra>
</card>
</detPag>
<vTroco>0.00</vTroco>
</pag>
<infAdic>
<infCpl>Mesa: 50 Pedido:48 TOTVS CHEF Aplicativo: TOTVS Chef 03.2408. Serie: 96736041 Valor aproximado dos tributos deste cupom: Federal: R$ 9.32 Estadual: R$ 12.08 Municipal: R$ 0.00 Fonte IBPT/empresometro.com.br SP B047CD</infCpl>
<obsCont xCampo=\"Series\">
<xTexto>MDAxMDAwNDExMjQ0MDAxMDAwNDExMjQ0</xTexto>
</obsCont>
</infAdic>
<infRespTec>
<CNPJ>82373077000171</CNPJ>
<xContato>Renato Alves</xContato>
<email>[email protected]</email>
<fone>1120997271</fone>
</infRespTec>
</infNFe>
<infNFeSupl>
<qrCode>
<![CDATA[https://www.homologacao.nfce.fazenda.sp.gov.br/qrcode?p=35240882373077000171650010004112441194594623|2|2|3|8D40911388AD28F90084AE3719A34693E143BFC3]]>
</qrCode>
<urlChave>https://www.homologacao.nfce.fazenda.sp.gov.br/consulta</urlChave>
</infNFeSupl>
<Signature
xmlns=\"http://www.w3.org/2000/09/xmldsig#\">
<SignedInfo>
<CanonicalizationMethod Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"/>
<SignatureMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"/>
<Reference URI=\"#NFe35240882373077000171650010004112441194594623\">
<Transforms>
<Transform Algorithm=\"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"/>
<Transform Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"/>
</Transforms>
<DigestMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/>
<DigestValue>MXavema7a33mkklhtGM9J06sZG0=</DigestValue>
</Reference>
</SignedInfo>
<SignatureValue>E231EM9ovdpJzgrXNoM0cNxnmrJ11uvRJqlWHtIEZPqYFoCE89vQ/H9ZI2+XjBsaqFzjBzM/Q0MaeACVb8/6pboktVvUc51dFlsc43ZE29btX7USJveK17XOUvZB/vQ3ig7nEnPbiQUI/fJHwUaTyhZx4IUNyOKBp9mHoMIyKcrsMkVcsOBRvz1TW3w5deoLVpcYk3hiqeNzax00wGZqhJqE0kGEyayCmN6By5WkzBvOuJd388R6ZX28a2ABekUVOwv7XlkVon7QhqXm47umON7sR5ksvQ2Op+OKxL8NlzKeTjb4AG6SwRitAJ6XHCMuN9pl3ZTOTmGHdF8e7jB77Q==</SignatureValue>
<KeyInfo>
<X509Data>
<X509Certificate>MIIH5DCCBcygAwIBAgIUEU0TcJfzT1nRO/DUHjQaoGrv4vQwDQYJKoZIhvcNAQELBQAwejELMAkGA1UEBhMCQlIxEzARBgNVBAoTCklDUC1CcmFzaWwxNjA0BgNVBAsTLVNlY3JldGFyaWEgZGEgUmVjZWl0YSBGZWRlcmFsIGRvIEJyYXNpbCAtIFJGQjEeMBwGA1UEAxMVQUMgRElHSVRBTFNJR04gUkZCIEczMB4XDTIzMDkxMTE2NTY0NVoXDTI0MDkxMTE2NTY0NFowggEAMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDELMAkGA1UECAwCU1AxEjAQBgNVBAcMCVNhbyBQYXVsbzE2MDQGA1UECwwtU2VjcmV0YXJpYSBkYSBSZWNlaXRhIEZlZGVyYWwgZG8gQnJhc2lsIC0gUkZCMRYwFAYDVQQLDA1SRkIgZS1DTlBKIEExMRcwFQYDVQQLDA4yNDE4MTI1MzAwMDE3NzETMBEGA1UECwwKcHJlc2VuY2lhbDE9MDsGA1UEAww0VE9UVlMgTEFSR0UgRU5URVJQUklTRSBURUNOT0xPR0lBIFMgQTo4MjM3MzA3NzAwMDE3MTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKpuos2YqOPC3XUCl1CiFuCYT9wgEc9Et2om5idQt2/NCZPNaLQrbHC9yGTZrRZbYi28J52pXoWMlAl8nqindCUaxKbnBrdt6tQ/6wMj3bDYBg5eStD9gCAIATMERo/8RrD6G5RkUrrGLKvSoSwKkoF80tRhSbjYNkKpHwy8tmG0mTm1TTZzbs3OPR1nQXtMDxv0BED2Lydi2bIYCkKK45IGHHpsnE3VxP+XymnYK0y7D1s5pY2SxWT9lNsrNrfclP9UpYUt7wyB4yoh80lEb0o9GnoBf6zba0jXrxUtzo25SCVe/2rKyiSDyEprvUGgh0X36KCg03plBo/fIGp4Ck0CAwEAAaOCAtgwggLUMAkGA1UdEwQCMAAwHwYDVR0jBBgwFoAU3bi13QLcuFDKfgZUQ8F+/K70rXswgagGCCsGAQUFBwEBBIGbMIGYMF0GCCsGAQUFBzAChlFodHRwOi8vd3d3LmRpZ2l0YWxzaWduY2VydGlmaWNhZG9yYS5jb20uYnIvcmVwb3NpdG9yaW8vcmZiL0FDRElHSVRBTFNJR05SRkJHMy5wN2IwNwYIKwYBBQUHMAGGK2h0dHA6Ly9vY3NwLmRpZ2l0YWxzaWduY2VydGlmaWNhZG9yYS5jb20uYnIwXQYDVR0gBFYwVDBSBgZgTAECASwwSDBGBggrBgEFBQcCARY6aHR0cDovL3d3dy5kaWdpdGFsc2lnbmNlcnRpZmljYWRvcmEuY29tLmJyL3JlcG9zaXRvcmlvL3JmYjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgbEGA1UdHwSBqTCBpjBXoFWgU4ZRaHR0cDovL3d3dy5kaWdpdGFsc2lnbmNlcnRpZmljYWRvcmEuY29tLmJyL3JlcG9zaXRvcmlvL3JmYi9BQ0RJR0lUQUxTSUdOUkZCRzMuY3JsMEugSaBHhkVodHRwOi8vd3d3LmRpZ2l0YWx0cnVzdC5jb20uYnIvcmVwb3NpdG9yaW8vcmZiL0FDRElHSVRBTFNJR05SRkJHMy5jcmwwDgYDVR0PAQH/BAQDAgXgMIG4BgNVHREEgbAwga2BGW5ld3Rvbi5jZXNhckB0b3R2cy5jb20uYnKgOAYFYEwBAwSgLwQtMDYxMjE5NzUxNzQxODkyODgwNzAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCIGBWBMAQMCoBkEF0dJTFNPTUFSIE1BSUEgU0VCQVNUSUFPoBkGBWBMAQMDoBAEDjgyMzczMDc3MDAwMTcxoBcGBWBMAQMHoA4EDDAwMDAwMDAwMDAwMDANBgkqhkiG9w0BAQsFAAOCAgEAOcL9EqIH7BChrULLpdyC9XynpllmCt30JNcccHWXNBac1X5XEtNKhPGJowtqBx/hWoo3bh/kJfFPH9vTXVhBaH3llduBU+xQwaBD1wuURPtZqDaKIIOmxBZUqfFlGt1U6JptB+zBiNRUe16cMmEJ86rlgVqlCgLe7161HDBEX+JyjfQyuolfObimjP9IilQWAFUkqJDvnBVfXYEwz69gg0JM8tYL3O18ldrkpDQ68KiZAiMoImkbr6oL48js+MQEfhMA0Q33LAXYj1enqlsimw4w/zZMZGvdE5PBbrv9spL0mg8AQIxy+GTx/QMwoC8XHgUrq+mAv9Eflp/w+LP2D0eP/ELilfwBDzPE2FECU+F8Bz5AQcbD8VHGAn0f5FtdqEssPlJyjOhGN26aYnoZ++2wLHPUq60qsZAM+9xEo2anwCwERJpwN64PsJItk2qQfGJeKYXGJrmMrGtxGRuONO1bW506Sdn4i/UdBt1XZhnaT2U4R/nytcuQ2E7DnBcLLdHD/MCP5UavJ4+1cQbCwD6xe6+GpkJTnk0Ei76HRSRdHRZR2xU6ebMV4x+Dcc7jR4pH0mMoXFkAn+IMd2M3JGKMjOikh49PguWRUYDtQo37Hs/cYTBc/3h452dV9qV6GI9c3Eg4vZPX3LebnsjYYkSdRdvqXYW+8xibmxa1vF8=</X509Certificate>
</X509Data>
</KeyInfo>
</Signature>
</NFe>
<protNFe versao=\"4.00\">
<infProt>
<tpAmb>2</tpAmb>
<verAplic>SP_NFCE_PL_009_V400</verAplic>
<chNFe>35240882373077000171650010004112441194594623</chNFe>
<dhRecbto>2024-08-16T15:17:38-03:00</dhRecbto>
<nProt>135240002154737</nProt>
<digVal>MXavema7a33mkklhtGM9J06sZG0=</digVal>
<cStat>100</cStat>
<xMotivo>Autorizado o uso da NF-e</xMotivo>
</infProt>
</protNFe>
</nfeProc>",
"invoiceKey": "35240882373077000171650010004112441194594623",
"qrCode": "https://www.homologacao.nfce.fazenda.sp.gov.br/qrcode?p=35240882373077000171650010004112441194594623|2|2|3|8D40911388AD28F90084AE3719A34693E143BFC3"
},
"error": null
} |
Informações |
---|
|
JSON de Pagamento de PedidoEste JSON é utilizado para enviar informações de pagamento relacionadas a um pedido por meio de um serviço de integração. Ele inclui informações sobre a chave de identificação da integração, tipo e chave do pedido, além de um objeto de pagamento detalhado. Campos:integrationHubServiceId (string, obrigatório) - Descrição: Chave de identificação da integração. Este campo é essencial para identificar de forma única a integração em questão.
- Exemplo:
"string"
orderKeyType (string, obrigatório) - Descrição: Tipo de chave do pedido. Define como o pedido é identificado e pode assumir os valores
"TABLE" , "CARD" ou "ORDER_ID" . - Valores possíveis:
"TABLE" , "CARD" , "ORDER_ID" - Exemplo:
"TABLE"
orderKey (string, obrigatório) - Descrição: Chave específica do pedido. Este campo deve conter o identificador do pedido de acordo com o tipo especificado em
orderKeyType . - Exemplo:
"string"
paymentObject (object, obrigatório)
|
Informações |
---|
|
integrationHubServiceId: é um código da integração da loja com o Integration Hub orderKey: é o código do pedido |
...
04. ERROS
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
- HTTP Status Code - 400 - Bad Request
Âncora |
---|
| status_code_400 |
---|
| status_code_400 |
---|
|
O código de status HTTP 400, conhecido como "Bad Request" (Requisição Inválida), indica que o servidor não pôde processar a requisição do cliente devido a uma sintaxe inválida, estrutura malformada ou dados inválidos presentes na requisição.
01. Formando inválido do JSON esperado.
Bloco de código |
---|
title | JSON Inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "02990348-9d85-416d-a573-6dc83eee52e7",
"orderKeyType": "TABLE",
"orderKey": 2,
"paymentObject": {
"printOrderAtPos": true,
"generateInvoice": true,
"printInvoiceAtPos": true,
"sendInvoiceEmail": false,
"summaryExtract": false,
"customerDocument": null,
"documentInReceipt": false,
"numberPersons": 1,
"removeServiceFee": false,
"methods": [
{
"value": 67.10,
"currency": "BRL",
"type": "OFFLINE",
"method": "CREDIT",
"methodInfo": "VISA"
}
],
"orderAmount": 61.0,
"discounts": 0.00,
"fees": 6.10,
"total": 67.10
}
} |
Bloco de código |
---|
title | JSON Resposta |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKey",
"message": "body.orderKey must be a string"
}
]
} |
...
02. JSON enviando faltando um ou mais campos.
Bloco de código |
---|
title | JSON Inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "02990348-9d85-416d-a573-6dc83eee52e7",
"orderKey": 2,
"paymentObject": {
"printOrderAtPos": true,
"generateInvoice": true,
"printInvoiceAtPos": true,
"sendInvoiceEmail": false,
"summaryExtract": false,
"customerDocument": null,
"documentInReceipt": false,
"numberPersons": 1,
"removeServiceFee": false,
"methods": [
{
"value": 67.10,
"currency": "BRL",
"type": "OFFLINE",
"method": "CREDIT",
"methodInfo": "VISA"
}
],
"orderAmount": 61.0,
"discounts": 0.00,
"fees": 6.10,
"total": 67.10
}
} |
Bloco de código |
---|
title | JSON Resposta |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType is required"
}
]
} |
...
03. GUID incorreto
Bloco de código |
---|
title | JSON com o GUID inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "02990348-9d85-416d-a573-6dc83eee52eA",
"orderKey": 2,
"paymentObject": {
"printOrderAtPos": true,
"generateInvoice": true,
"printInvoiceAtPos": true,
"sendInvoiceEmail": false,
"summaryExtract": false,
"customerDocument": null,
"documentInReceipt": false,
"numberPersons": 1,
"removeServiceFee": false,
"methods": [
{
"value": 67.10,
"currency": "BRL",
"type": "OFFLINE",
"method": "CREDIT",
"methodInfo": "VISA"
}
],
"orderAmount": 61.0,
"discounts": 0.00,
"fees": 6.10,
"total": 67.10
}
} |
Bloco de código |
---|
title | JSON Inválido GUID incorreto |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "body.integrationHubServiceId must be a valid GUID"
}
]
} |
...
04. Enviando uma requisição sem informar o código da orderKey corretamente
Bloco de código |
---|
title | JSON com sem informar o código da orderKey |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "02990348-9d85-416d-a573-6dc83eee52e7",
"orderKey": 2,
"paymentObject": {
"printOrderAtPos": true,
"generateInvoice": true,
"printInvoiceAtPos": true,
"sendInvoiceEmail": false,
"summaryExtract": false,
"customerDocument": null,
"documentInReceipt": false,
"numberPersons": 1,
"removeServiceFee": false,
"methods": [],
"orderAmount": 61.0,
"discounts": 0.00,
"fees": 6.10,
"total": 67.10
}
} |
Bloco de código |
---|
title | JSON Response |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "methods",
"message": "body.paymentObject.methods must contain at least 1 items"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 400 Bad Request |
---|
|
A solicitação é inválida e não pôde ser processada devido a erros na entrada fornecida. Verifique os dados enviados e tente novamente. |
...
- HTTP Status Code 401 - Unauthorized
Âncora |
---|
| status_code_401 |
---|
| status_code_401 |
---|
|
O código de status HTTP 401, conhecido como "Unauthorized" (Não Autorizado), indica que a requisição não foi aplicada porque carece de credenciais de autenticação válidas para o recurso alvo. Diferente do código 403 (Forbidden), que significa que o servidor entendeu a requisição, mas se recusa a autorizá-la, o 401 é usado especificamente quando a autenticação é necessária e falhou ou ainda não foi fornecida.
Nota |
---|
title | Nota: HTTP Status Code = 401 Unauthorized |
---|
|
A solicitação não pôde ser processada porque o usuário não possui as permissões necessárias. Verifique suas credenciais e tente novamente. |
...
- HTTP Status Code 403 - Forbidden
Âncora |
---|
| status_code_403 |
---|
| status_code_403 |
---|
|
O código de status HTTP 403, conhecido como "Forbidden" (Proibido), indica que o servidor não entendeu a requisição do cliente por está tentando acessar uma URL
incorreta
Bloco de código |
---|
title | URL enviada incorreda |
---|
|
https://api-barramento.meuelevestage.com/order/paymentS |
Bloco de código |
---|
title | JSON Response para URL incorreta |
---|
linenumbers | true |
---|
|
{
"message": "Missing Authentication Token"
} |
Nota |
---|
title | Nota: HTTP Status Code = 403 - Forbidden |
---|
|
O cliente não enviou uma requisição para a URL incorreta. |
...
- HTTP Status Code 404 - Not Found
Âncora |
---|
| status_code_404 |
---|
| status_code_404 |
---|
|
O código de status HTTP 404, conhecido como "Not Found" (Não Encontrado), indica que o servidor não encontrou o recurso solicitado. Isso pode ocorrer quando o integrationHubId
está incorreto ou inválido.
Bloco de código |
---|
title | Integration Hub Code Inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "02990348-9d85-416d-a573-6dc83eee52e7",
"orderKeyType": "TABLE",
"orderKey": "2",
"paymentObject": {
"printOrderAtPos": true,
"generateInvoice": true,
"printInvoiceAtPos": true,
"sendInvoiceEmail": false,
"summaryExtract": false,
"customerDocument": null,
"documentInReceipt": false,
"numberPersons": 1,
"removeServiceFee": false,
"methods": [
{
"value": 67.10,
"currency": "BRL",
"type": "OFFLINE",
"method": "CREDIT",
"methodInfo": "VISA"
}
],
"orderAmount": 61.0,
"discounts": 0.00,
"fees": 6.10,
"total": 67.10
}
} |
Bloco de código |
---|
title | JSON Response |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "Provider Merchant for integrationHubServiceId \"02990348-9d85-416d-a573-6dc83eee52e7\" not found or disabled"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 404 - Not Found |
---|
|
IntegrationHubId incorreto ou inválido |
...
- HTTP Status Code 412 - Precondition Failed
Âncora |
---|
| status_code_412 |
---|
| status_code_412 |
---|
|
O código de status HTTP 412, conhecido como "Precondition Failed" (Pré-condição Falhou), alguma regra para atendimento de sua solicitação não foi atendida, analise o corpo da declaração para saber os motivos.
Bloco de código |
---|
title | JSON |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "efdd6093-5539-4ac4-ad84-7423a8078dde",
"orderKeyType": "TABLE",
"orderKey": "2",
"paymentObject": {
"printOrderAtPos": true,
"generateInvoice": true,
"printInvoiceAtPos": true,
"sendInvoiceEmail": false,
"summaryExtract": false,
"customerDocument": null,
"documentInReceipt": false,
"numberPersons": 1,
"removeServiceFee": false,
"methods": [
{
"value": 67.10,
"currency": "BRL",
"type": "OFFLINE",
"method": "CREDIT",
"methodInfo": "VISA"
}
],
"orderAmount": 61.0,
"discounts": 0.00,
"fees": 6.10,
"total": 67.10
}
} |
Bloco de código |
---|
title | HTTP Status Code 412 = Precpndition Failed |
---|
linenumbers | true |
---|
|
{
"message": "Mesa não possui itens sem vinculo com cadeiras para recebimento completo.;Total dos produtos informado é diferente do total dos produtos das Cadeiras informadas.;Total da Conta informada é diferente do total da conta no sistema.",
"code": 412
} |
Nota |
---|
title | Nota: HTTP Status Code = 412 Precondition Failed |
---|
|
Alguma regra necessária para a execução da solicitação não foi atendida. É necessário analisar o conteúdo da resposta retornada para identificar os motivos. |
...
- HTTP Status Code 429 - Too Many Requests
Âncora |
---|
| status_code_429 |
---|
| status_code_429 |
---|
|
O código de status HTTP 429, conhecido como "Too Many Requests" (Muitas Requisições), indica que o cliente excedeu o limite de requisições permitido para um determinado período de tempo. Esse limite é definido pelo servidor e pode variar de acordo com a política de limitação de taxa implementada.
Bloco de código |
---|
title | JSON da requisição |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
"orderKeyType": "TABLE",
"orderKey": ["5"]
} |
Bloco de código |
---|
title | Resposta da última execução |
---|
linenumbers | true |
---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
"orderKeyType": "TABLE",
"orderKey": [
"5"
],
"lastestUpdatedStatus": "2024-07-02 18:54:28",
"items": [
{
"id": "de9fd388-c223-4325-a64d-08889250f839",
"status": {
"code": 504,
"description": "OPEN_TABLE"
},
"deliveryAgent": null,
"deliveryDateTime": null,
"cancellationReason": null,
"tableCardNumber": "5"
}
]
} |
Nota |
---|
title | Nota: HTTP Status Code = 429 - Too Many Requests |
---|
|
Alguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões. |
...
05. LINKS