Sumário
Descrição #
Método para buscar status da cobrança PIX, a consulta da cobrança deverá ser pelo Id.
Endpoints #
- Produção: https://api2.bancosemear.com.br/paas-management-api/v1/public/payments/correlationId/<ID>
- Homologação: https://hmlapi2.bancosemear.com.br/paas-management-api/v1/public/payments/correlationId/<ID>
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
- id: Id referente a transação solicitada na busca
Requisição (GET) #
curl --location 'https://hmlapi2.bancosemear.com.br/paas-management-api/v1/public/payments/correlationId/<ID>' \
--header 'token: <TOKEN>' \
--header 'access_token: <ACCESS TOKEN>' \
--header 'client_id: <CLIENT ID DO CLIENTE>'
Resposta #
{
"id": "b23d1db8-7dc3-4f21-9ad9-8f7a5037ed05",
"endToEnd": "E00795423202310041923E8gad39uyaD",
"status": "SUCESSO",
"dateProccessStart": "2023-10-04T16:23:22.957",
"dateDictRequest": "2023-10-04T16:23:23.54",
"dateSendPayment": "2023-10-04T16:23:23.713",
"dateMovement": "2023-10-04T16:23:24.253",
"dateProccessEnd": "2023-10-04T16:23:27.467",
"value": 1.74,
"payerDocument": "1111111111111",
"payerAccount": "0011000000",
"key": "c0094e8a-f6ee-4716-8aaf-ded51a0b6e86",
"descrition": "Teste com Cash-Out",
"entryChannel": "APP_WEB",
"beneficiaryIspb": "00795400",
"beneficiaryAgency": "0001",
"beneficiaryAgencyDigit": null,
"beneficiaryAccount": "0110370000",
"beneficiaryAccountType": "CACC",
"beneficiaryDocument": "99999999999",
"beneficiaryName": "TESTE NOME BENEFICIARIO",
"errorCode": null,
"errorMessage": null
"operationCode": "SMO00001"
}
Parâmetros de Resposta #
Corpo (JSON) #
Propriedade | Descrição | Tipo |
---|---|---|
id | ID da transação interna | String |
endToEnd | ID End to End usado na chamada | String |
status | Status da transação (SUCESSO, EM PROCESSAMENTO, COM ERRO) | String |
dateProccessStart | Data do inicio do processamento | DateTime |
dateDictRequest | Data da consulta dos dados da chave | DateTime |
dateSendPayment | Data do envio da ordem de pagamento | DateTime |
dateMovement | Data do pagamento | DateTime |
dateProccessEnd | Data do envio do webhook | DateTime |
value | Valor do cash out | decimal |
payerDocument | Documento do pagador | String |
payerAccount | Conta referente do pagador que esta efetuando o cash out | String |
key | Chave de recebimento do pagamento | String |
descrition | Campo livre de digitação | String |
entryChannel | Canal de entrada do pagamento | String |
beneficiaryIspb | Código bancário | String |
beneficiaryAgency | Código da agencia do beneficiário do pagamento | String |
beneficiaryAgencyDigit | Digito da agencia do beneficiário do pagamento | String |
beneficiaryAccount | Conta do beneficiário do pagamento | String |
beneficiaryAccountType | Tipo de conta do beneficiário do pagamento | String |
beneficiaryDocument | Documento do beneficiário do pagamento | String |
beneficiaryName | Nome do beneficiário do pagamento | String |
errorCode | Código do erro gerado | String |
errorMessage | Mensagem sobre o erro gerado | String |
operationCode | Identificador Único da Transação enviado pelo Cliente | String |