Listar Pagamentos PIX (CASH-OUT)

Descrição #

Método para buscar lista de cobranças PIX, a consulta da cobrança deverá ser pela data da transação e status(opcional).

Endpoints #

• Produção: https://api2.bancosemear.com.br/paas-management-api/v1/public/payments
• Homologação: https://hmlapi2.bancosemear.com.br/paas-management-api/v1/public/payments

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
• date: Data a ser filtrada (somente data)
• status: Status do pagamento ( TODOS = não enviar, EM_PROCESSAMENTO = 1, SUCESSO = 2, COM_ERRO = 3)
• page: Número da pagina (default 1)

Requisição (GET) #

curl --location 'https://hmlapi2.bancosemear.com.br/paas-management-api/v1/public/payments?page=2&status=2&date=2023-10-04' \
--header 'token: <TOKEN>' \
--header 'access_token: <ACCESS TOKEN>' \
--header 'client_id: <CLIENT ID DO CLIENTE>'

Resposta #

{
    "actualPage": 2,
    "totalPages": 2,
    "totalItens": 12,
    "itensPerPage": 10,
    "pixCashOutResponses": [
   {
    "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) #