Descrição #
Método usado para consultar as devoluções de transações de Pix Cash-In.
Essa consulta deverá ser realizada pelo mesmo EndToEnd utilizado para realizar a devolução, ou seja, utilizar o EndToEnd de origem (EndToEnd do pagamento) para realizar a consulta e não o EndToEnd gerado da devolução.
Endpoints #
- Produção: https://api2.bancosemear.com.br/paas-management-api/v1/public/returns/<EndToEnd>
- Homologação: https://hmlapi2.bancosemear.com.br/paas-management-api/v1/public/returns/<EndToEnd>
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 (GET) #
curl --location --request GET 'https://hmlapi2.bancosemear.com.br/paas-management-api/v1/public/returns/<EndToEnd>' \
--header 'token: <TOKEN>' \
--header 'access_token: <ACCESS TOKEN>' \
--header 'client_id: <CLIENT ID DO CLIENTE>'
Resposta (JSON) #
Exemplo de resposta
OBSERVAÇÃO: no exemplo abaixo a transação original é de R$25,00. e essa devolução pode ser realizada total ou parcial, sendo sempre o valor devolvido até o valor pago, por isso a consulta é feita pelo EndToEnd “pai”, para constar toda(s) a(s) devolução(ões) nessa consulta.
[
{
“status”: “EFETIVADA”,
“ispbCode”: “00795423”,
“agencyCode”: “0001”,
“agencyDigit”: “9”,
“accountNumber”: “0011004967”,
“accountType”: “CACC”,
“document”: “24806924000148”,
“name”: “SPEED RACER AUTO MECANICA LTDA 02”,
“institutionName”: “Banco Semear”,
“counterpartyIspbCode”: “68900810”,
“counterpartyAgency”: “0001”,
“counterpartyAccountNumber”: “0460982009”,
“counterpartyDocument”: “17354911000110”,
“counterpartyName”: “COTACAO D.T.V.M. S/A PIX PAYMENTS”,
“endToEnd”: “D00795423200987654321o3JQqTYgADb”,
“value”: 10.00,
“movementDate”: “11/21/2023 12:02:39”,
“requestDateTime”: “11/21/2023 11:59:55”,
“originalEndToEnd”: “E31872495201234567890dqVDnzswk1X”,
“key”: null,
“movementNumber”: null,
“movementSource”: “DEVOLUCAO”,
“nature”: “D”,
“isReturn”: true,
“operationCode”: “01033”,
“entryChannel”: “APP-PAAS”,
“externalInd”: true,
“medReason”: null,
“extraField”: null,
“freeField”: null
},
{
“status”: “EFETIVADA”,
“ispbCode”: “00795423”,
“agencyCode”: “0001”,
“agencyDigit”: “9”,
“accountNumber”: “0011004967”,
“accountType”: “CACC”,
“document”: “24806924000148”,
“name”: “SPEED RACER AUTO MECANICA LTDA 02”,
“institutionName”: “Banco Semear”,
“counterpartyIspbCode”: “68900810”,
“counterpartyAgency”: “0001”,
“counterpartyAccountNumber”: “0460982009”,
“counterpartyDocument”: “17354911000110”,
“counterpartyName”: “COTACAO D.T.V.M. S/A PIX PAYMENTS”,
“endToEnd”: “D00795345000987654321o3JQqTYgARz”,
“value”: 7.00,
“movementDate”: “11/21/2023 12:02:39”,
“requestDateTime”: “11/21/2023 11:59:55”,
“originalEndToEnd”: “E31872495201234567890dqVDnzswk1X”,
“key”: null,
“movementNumber”: null,
“movementSource”: “DEVOLUCAO”,
“nature”: “D”,
“isReturn”: true,
“operationCode”: “01033”,
“entryChannel”: “APP-PAAS”,
“externalInd”: true,
“medReason”: null,
“extraField”: null,
“freeField”: null
},
{
“status”: “EFETIVADA”,
“ispbCode”: “00795423”,
“agencyCode”: “0001”,
“agencyDigit”: “9”,
“accountNumber”: “0011004967”,
“accountType”: “CACC”,
“document”: “24806924000148”,
“name”: “SPEED RACER AUTO MECANICA LTDA 02”,
“institutionName”: “Banco Semear”,
“counterpartyIspbCode”: “68900810”,
“counterpartyAgency”: “0001”,
“counterpartyAccountNumber”: “0460982009”,
“counterpartyDocument”: “17354911000110”,
“counterpartyName”: “COTACAO D.T.V.M. S/A PIX PAYMENTS”,
“endToEnd”: “D00123456200987654321o3JQqTYgADb”,
“value”: 8.00,
“movementDate”: “11/21/2023 12:02:39”,
“requestDateTime”: “11/21/2023 11:59:55”,
“originalEndToEnd”: “E31872495201234567890dqVDnzswk1X”,
“key”: null,
“movementNumber”: null,
“movementSource”: “DEVOLUCAO”,
“nature”: “D”,
“isReturn”: true,
“operationCode”: “01033”,
“entryChannel”: “APP-PAAS”,
“externalInd”: true,
“medReason”: null,
“extraField”: null,
“freeField”: null
}
]