Incluir Solicitação de Devolução MED

Importante:

Para usar esta API, é necessário estar autenticado e incluir seu token de autenticação no cabeçalho da requisição. Consulte a documentação de Autenticação na plataforma para mais informações.

Autenticação.

O Sistema Cliente deve integrar esta API para registrar uma Solicitação de Devolução. Antes de fazer isso, é crucial garantir que a transação a ser relatada na Solicitação de Devolução tenha ocorrido nos últimos 90 dias corridos.

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. Abaixo, você encontrará exemplos de como realizar o processo .

Requisição de exemplo

Solicitar devolução via MED

post

Incluir solicitação de devolução através do MED.

Authorizations

Header parameters

Chave-IdempotenciastringRequired

Identificador único em formato uuidV4. para garantir que a requisição seja idêntica em múltiplas tentativas.

Example: 123e4567-e89b-12d3-a456-426614174000

Body

endToEndstringRequired

ID da transação

ispbinteger · int32Optional

ISPB

reasonstring · enumOptional

Motivo da solicitação de devolução.

Possible values:

detailsstringOptional

Detalhes que possam ajudar o participante recebedor a analisar a solicitação de devolução.

amountnumber · floatRequired

Valor da devolução

Responses

201

Solicitação de devolução incluida com sucesso.

application/json

401

Falha de autorização

422

Falha de validação

500

Erro desconhecido do servidor

post

HTTPcURLJavaScriptPython

POST /internal/api/v1/devolution/med HTTP/1.1
Host: sandbox.globalscm.app.br
Authorization: Bearer YOUR_SECRET_TOKEN
Chave-Idempotencia: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "endToEnd": "E1116575620241104181133791593625",
  "ispb": 11165756,
  "reason": "FALHA_OPERACIONAL_PSP_PAGADOR",
  "details": "Falha operacional interna.",
  "amount": 10.35
}

{
  "endToEnd": "E1116575620241104181133791593625",
  "idSolDevolucao": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
  "idRelatoInfracao": "92d75e90-73c2-5b9f-b561-86625da2f4fc",
  "status": "ABERTA"
}

JSON Retorno Sucesso