diff --git a/swagger.json b/swagger.json index 0a1e5f6..1480395 100644 --- a/swagger.json +++ b/swagger.json @@ -60,7 +60,7 @@ "properties": { "id": { "type": "string", - "description": "Identificador da venda gerado pelo PDV. Caso haja múltiplos pagamentos via RecicleBem na venda, utilize o mesmo ID." + "description": "Identificador da venda gerado pelo PDV. Caso haja múltiplos pagamentos via RecicleBem na venda, utilize o mesmo ID. Limitado a 40 caracteres." }, "payment_total": { "type": "number", @@ -140,6 +140,23 @@ } } }, + "PaymentCancellationRequest": { + "type": "object", + "description": "Representa uma solicitação de cancelamento/estorno de pagamento individual.", + "required": [ + "uuid" + ], + "properties": { + "uuid": { + "type": "string", + "description": "Identificador da autorização retornado pelo endpoint de registro." + }, + "reason": { + "type": "string", + "description": "Motivo do cancelamento, opcional" + } + } + }, "PaymentReversal": { "type": "object", "description": "Representa um pagamento estornado", @@ -364,6 +381,47 @@ } } }, + "/rest/api/integration/tokenauth/rb_socin_cancelar_autorizacao": { + "post": { + "summary": "Estorna a autorização especificada.", + "description": "Cancela a autorização de pagamento, e estorna seus pagamentos, se existirem.\n", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentCancellationRequest" + } + } + } + }, + "responses": { + "204": { + "description": "Pagamento estornado com sucesso" + }, + "400": { + "description": "Corpo da requisição inválido", + "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_estorno": { "post": { "summary": "Estorna o pagamento especificado.",