tiago.inaba/reciclebem-socin-swagger
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

feat: endpoint para consulta individual de pagamentos

Browse Source
This commit is contained in:
tkinaba
2025-12-12 11:35:37 -03:00
parent 661314c557
commit 3bff507316
1 changed files with 148 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
swagger.json
+148 -9
View File
@@ -162,6 +162,24 @@
"description": "Valor do estorno"
}
}
},
"Error": {
"type": "object",
"description": "Resposta de Erro da API",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "código do erro"
},
"message": {
"type": "string",
"description": "mensagem do erro"
}
}
}
}
},
@@ -181,6 +199,64 @@
}
],
"paths": {
"/rest/api/integration/tokenauth/rb_socin_autorizacao_consulta": {
"get": {
"summary": "Consulta o status da autorização.\n",
"description": "Aceita o ID da transação e retorna seu status.",
"parameters": [
{
"name": "transaction_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Pagamento encontrado",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentStatus"
}
}
}
},
"400": {
"description": "transaction_id não encontrado nos query parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Pagamento não encontrado",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Erro interno",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/rest/api/integration/tokenauth/rb_socin_autorizacao": {
"get": {
"summary": "Consulta o status das autorizações para determinado pagamento.\n",
@@ -210,13 +286,34 @@
}
},
"400": {
"description": "ID não encontrado nos query parameters"
"description": "ID não encontrado nos query parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Pagamento não encontrado"
"description": "Pagamento não encontrado",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Erro interno"
"description": "Erro interno",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
@@ -245,10 +342,24 @@
}
},
"400": {
"description": "Corpo da requisição inválido"
"description": "Corpo da requisição inválido",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Erro interno"
"description": "Erro interno",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
@@ -282,10 +393,24 @@
}
},
"400": {
"description": "Corpo da requisição inválido"
"description": "Corpo da requisição inválido",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Erro interno"
"description": "Erro interno",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
@@ -319,7 +444,14 @@
}
},
"400": {
"description": "Corpo da requisição inválido"
"description": "Corpo da requisição inválido",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Tentativa de finalização não sucedida.",
@@ -335,7 +467,14 @@
}
},
"500": {
"description": "Erro interno"
"description": "Erro interno",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}