Sumário
Descrição #
Método usado para consultar as devoluções de transações de Pix Cash-In.
Essa consulta deverá ser realizada pelo mesmo correlationId utilizado para realizar a devolução, ou seja, utilizar o correlationId de origem .
Endpoints #
- Produção: https://api2.bancosemear.com.br/paas-refund-api/v1/public/refunds/endtoend/<correlationId>
- Homologação: https://hmlapi2.bancosemear.com.br/paas-refund-api/v1/public/refunds/endtoend/<correlationId>
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-refund-api/v1/public/refunds/endtoend/<correlationId>' \
--header 'token: <TOKEN>' \
--header 'access_token: <ACCESS TOKEN>' \
--header 'client_id: <CLIENT ID DO CLIENTE>'
Parâmetros de Requisição #
Corpo (JSON) #
Propriedade | Descrição | Tipo | Obrigatório |
---|---|---|---|
correlationId | Id único da devolução | String | Sim |
Resposta (JSON) #
Exemplo de resposta
{
"correlationId": "50ea5xxx-46a3-4ba2-axx-8b507aaxxa0",
"transactionId": "JamesBondQA_2024-10-04_TGWCxCcUhs",
"endToEnd": "Dxx795423xxx410041804xx7PWCUZ0",
"originalEndToEnd": "E1438xxx0241004143xxxND7N1oPa",
"status": 2,
"processingStartDate": "2024-10-04T15:04:36.55",
"movementDate": "2024-10-04T15:04:42.813",
"processingEndDate": "2024-10-04T15:04:50.73",
"amount": 1.02,
"reason": 2,
"payerDocument": "533034444000143",
"payerAccount": "011008590",
"paymentDescription": "JamesBond QA QaVengers",
"beneficiaryISPBB": "14388334",
"beneficiaryAgency": "0001",
"beneficiaryAgencyDigit": null,
"beneficiaryAccount": "140000334",
"beneficiaryAccountType": "CACC",
"beneficiaryDocument": "14388300000199",
"beneficiaryName": "INTERPOL BANCO SA",
"errorCode": null,
"errorDescription": null
}
Parâmetros de Resposta #
Corpo (JSON) #
Propriedade | Descrição | Tipo |
---|---|---|
correlationId | String | |
transactionId | String | |
endToEnd | String | |
originalEndToEnd | String | |
status | Integer | |
processingStartDate | Datetime | |
movementDate | Datetime | |
processingEndDate | Datetime | |
amount | Decimal | |
reason | Integer | |
payerDocument | String | |
payerAccount | String | |
paymentDescription | String | |
beneficiaryISPBB | String | |
beneficiaryAgency | String | |
beneficiaryAgencyDigit | String | |
beneficiaryAccount | String | |
beneficiaryAccountType | String | |
beneficiaryDocument | String | |
beneficiaryName | String | |
errorCode | Integer | |
errorDescription | String |