Sumário
Descrição #
Método usado para processar as devoluções de transações de Pix Cash-In.
Endpoints #
- Produção: https://api2.bancosemear.com.br/paas-refund-api/v1/public/refunds
- Homologação: https://hmlapi2.bancosemear.com.br/paas-refund-api/v1/public/refunds
Parâmetros de Requisição #
Cabeçalho: #
- token: Payload JSON criptografado com uma chave pública codificado em base64 (Gerado no passo anterior, Consulta/Geração de token)
- client_id: ID de cliente usado para controle de acesso do gateway de APIs
- access-token: Token recebido após executar o método oAuth
Requisição (POST) #
curl --location 'https://hmlapi2.bancosemear.com.br/paas-refund-api/v1/public/refunds' \
--header 'client_id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'access_token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'token: XeW0nTHWsE3++SQR0KFPmqcpkdZxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxLNoE8+VtqqpN2Jxq22kbLIKtgYXyPNbzx7PzamPP/aQm55O/UCrBGyFVajQi20Ij/Mhk7JfI5kSrNsqfHmKsbRREAkM23dvqBJ6pTyu90LojEjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx+ia+Wk9E1kT525OdpOBIl0pCQf1qvJ+X8vY16obexpbBxR1k4Aa9FhvKFExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxb5Z1H0pOGG4sevayHkpLGXD9qQ4uGmJ/kKTqlFMlENnYvVwml7xg==' \
--header 'Content-Type: application/json' \
--data '{
"endToEnd": "E0079542320xxxx81543QZokf67UnDr",
"transactionId": "MeuId_unico_01",
"amount": 1.02,
"reason": 2,
"description": "Devolução para o fulano de tal"
}'
Resposta #
{
"correlationId": "edxxeb35-xxx-4b3b-axx3-46fxxxxx0ce",
"message": "Solicitação de devolução recebida com sucesso."
}
Parâmetros de Requisição #
Corpo (JSON) #
Propriedade | Descrição | Tipo | Obrigatório |
---|---|---|---|
endToEnd | Id da solicitação de devolução | String | Sim |
transactionId | ID único de controle do cliente | String | Não |
amount | Valor | Decimal | Sim |
reason | Possíveis valores: 0 – BE08 1 – FR01 2 – MD06 3 – SL02 – Se não for enviado, o padrão será 2 – MD06 | Integer | Não |
description | Descrição / Observação | String | Não |