Movimentações financeiras – PIX e Boleto

Sumário

Descrição #

Serviço de notificações para os clientes do banco Semear das movimentações financeiras para PIX e Boletos descritos nessa documentação.

Essas notificações serão enviadas através de uma requisição HTTP POST para o WebHook do cliente informado para o banco Semear no momento do Onboarding.

Estrutura da Notificação #

Header (cash-in, cash-out e boleto) #

Enviamos o client_id através do HEADER pela chave Authorization da requisição para validação no webhook.

  • Content-Type: Informa ao servidor de que o corpo da requisição possui o formato JSON.
  • Authorization: ID de cliente usado para encaminhar a requisição ao gateway de APIs.

PIX – CASH-IN #

{
  "Environment": "Homolog",
  "Registration": "EnvioPix",
  "Details": {
    "Account": "0110999999",
    "Type": "PIX",
    "Status": "SUCESSO",    
    "MovementOrigin": "CHAVE"
    "Pix": {
      "TxId": "mxtno032hzodluk9pxrn8fqlpwetoh9zvxc",
      "DestinationKey": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
      "DestinationDocument": "xxxxxxxxxxx",
      "EndToEnd": "E00795423202308041830Q9V1pdN60kK",
      "Value": 1.44,
      "PaymentDate": "2023-08-04T15:31:09.018592",
      "Description": "Pagamento realizado",
      "IspbCode": "00795423",
      "RejectionReasonCode": null,
      "RejectionReasonDescription": null,
      "Payer": {
        "IspbCode": "00795423",
        "Agency": "0001",
        "DigitAgency": "9",
        "Account": "0011019999",
        "Type": "CACC",
        "Document": "xxxxxxxxxxx",
        "Name": "RAFAEL QA"
      },
      "Beneficiary": null
    }
  }
}

PIX – CASH-OUT #

SUCESSO #
{
  "Environment": "Homolog",
  "Registration": "EnvioPixCashout",
  "Details": {
    "Account": "0011019999",
    "Type": "PIXCASHOUT",
    "Status": "SUCESSO",
    "CorrelationId": "de43d844-4f25-454a-90da-4c263e4f088d",
    "Pix": {
      "TxId": "PAASCASHOUT",
      "DestinationKey": "rafael@bancosemear.com.br",
      "DestinationDocument": "xxxxxxxxxxxxx",
      "EndToEnd": "E007954232023080419029urKf7WY3Wq",
      "Value": 11.22,
      "PaymentDate": "2023-08-04T16:02:36.190651",
      "Description": null,
      "IspbCode": "00795423",
      "RejectionReasonCode": null,
      "RejectionReasonDescription": null,
      "Payer": null,
      "Beneficiary": {
        "IspbCode": "00795423",
        "Agency": "0001",
        "DigitAgency": "9",
        "Account": "0011019999",
        "Type": "CACC",
        "Document": "xxxxxxxxxxx",
        "Name": "SAMUEL QA"
      }
    }
  }
}
ERRO #
{
  "Environment": "Development",
  "Registration": "EnvioPixCashout",
  "Details": {
    "Account": "0011004967",
    "Type": "PAASCASHOUT",
    "Status": "COM ERRO",
    "Error": {
      "Code": "40008",
      "Detail": "Falha para enviar o pagamento."
    },
    "CorrelationId": "529fbd60-582e-42b7-be95-6ba010322f40",
    "Pix": {
      "TxId": null,
      "DestinationKey": null,
      "EndToEnd": null,
      "Value": 1.71,
      "PaymentDate": null,
      "Description": "Teste Cash-Out",
      "DestinationDocument": "22222222222",
      "RejectionReasonCode": null,
      "RejectionReasonDescription": null,
      "IspbCode": null,
      "Beneficiary": {
        "IspbCode": "00795423",
        "Agency": "0001",
        "DigitAgency": null,
        "Account": "33333333",
        "Type": "CACC",
        "Document": "12345678910",
        "Name": "Peter Parker"
      }
    }
  }
}

BOLETO #

  {
  "Environment": "Homolog",
  "Registration": "EnvioBoleto",
  "Details": {
    "Account": "0011019999",
    "Type": "BOLETO",
    "Billet": {
      "OurNumber": "00000003493",
      "YourNumber": "Pedido_003",
      "DueDate": "2023-08-05T00:00:00",
      "OperationDate": "2023-08-04T00:00:00",
      "Status": 4,
      "IspbCode": "00795423"
    }
  }
}

DEVOLUÇÃO TRANSAÇÃO PIX CASH-IN #

{
  "Environment": "Development",
  "Registration": "EnvioDevolucao",
  "Details": {
    "Account": "0011004967",
    "Type": "DEVOLUCAO",
    "Status": "SUCESSO",
    "CorrelationId": "62b4ee51-d69b-465f-9cf3-xxxxxxxxxxxx",
    "Pix": {
      "TxId": null,
      "DestinationKey": "",
      "DestinationDocument": "00304140082",
      "EndToEnd": "D00795423202308221625GCGVVEQyk5l",
      "OriginalEndToEnd": "E00795423202308221611CbssGoiJlrK",
      "Value": 0.03,
      "PaymentDate": "2023-08-22T13:26:05.272184",
      "Description": null,
      "IspbCode": "00795423",
      "RejectionReasonCode": null,
      "RejectionReasonDescription": null,
      "Payer": null,
      "Beneficiary": {
        "IspbCode": "00795423",
        "Agency": "0001",
        "DigitAgency": "9",
        "Account": "0011017254",
        "Type": "CACC",
        "Document": "00011122244",
        "Name": "FELIPE DAS COUVES"
      }
    }
  }
}

PIX EXPIRADO CASH-IN #

{ 
  "Environment": "Homolog", 
  "Registration": "EnvioPixCashinExpirado", 
  "Details": { 
    "Account": "0110378590", 
    "Type": "PIXCASHIN", 
    "Status": "EXPIRADO", 
    "Pix": { 
      "TxId": "c0xo0ir7dvefe9umaulioo3abmiqz65i62k", 
      "Value": 450.00, 
      "CreatedDate": "2023-12-12T12:13:50.707702", 
      "ExpiredDate": "2023-12-12T12:13:50.707702", 
      "Description": "Teste pix expirado", 
      "IspbCode": "00795423", 
      "Beneficiary": null, 
      "Payer": { 
        "Document": "14637215870", 
        "Name": "Fulano" 
      } 
    } 
  } 
}

OBS: A ativação do recebimento das notificações do pix expirado é opcional e deve ser solicitada junto ao time de produtos. (Por padrão essa funcionalidade não vem habilitada)

PropriedadeDescriçãoTipo
 Environment Production: Indica o ambiente de produção
Homolog: Indica o ambiente de homologação		 String
Registration EnvioPix: Indica envio de Cash-in
EnvioPixCashout: Indica envio de Cash-out
EnvioBoleto: Indica envio de Boleto		 String
 Details.Account Conta que gerou a transação String
 Details.Type Indica o tipo da notificação:

PIX: Notificação Pix Cash-in
PIXCASHOUT: Notificação Pix Cash-out
BOLETO: Notificação de Boleto		 String
Details.StatusIndica o status da notificação:

PIXCASHOUT: SUCESSO ou COM ERRO		String
MovementOriginIndica a origem do movimento, se o PIX realizado foi via CHAVE, MANUAL ou QRCODEString
Details.CorrelationIdPIXCASHOUT: Quando SUCESSO, retorna o correlationId usado para buscar a transação como índice interno.String
Details.Error.CodePIXCASHOUT: Código de erro retornado quando há alguma falha no processo de pagamento do cash-outString
Details.Error.DetailPIXCASHOUT: Mensagem de erro retornada quando há alguma falha no processo de pagamento do cash-outString
Pix.TxId Cash-Out: sempre virá PAASCASHOUT
Cash-In e Boleto: é uma string no formato UUID		 String
 Pix.DestinationKey Chave PIX do recebedor String
Pix.DestinationDocument CPF (mascarado) ou CNPJ do recebedor String
Pix.EndToEnd EndToEnd da transação PIX realizada String
Pix.Value Valor da transação realizada Decimal
Pix.PaymentDate Data e hora da realização da transação  DateTime
 Pix.Description Descrição do pagamento da transação String
 Pix.IspbCode ISPB do banco que realizou a transação String
 Pix.RejectionReasonCode Código do erro (quando houver) String
 Pix.RejectionReasonDescription Mensagem de erro (quando houver) String
 Payer.IspbCode Código bancário do pagador String
 Payer.Agency Agência bancária do pagador String
Payer.DigitAgency Digito da agência bancária do pagador String
Payer.Account Número da conta do pagador String
Payer.Type Tipo de conta do pagador String
Payer.Document Documento do pagador, CPF (mascarado) ou CNPJ String
Payer.Name Nome do pagador String
Beneficiary.IspbCode Código bancário do beneficiário String
Beneficiary.Agency Agência bancária do beneficiário String
Beneficiary.DigitAgency Digito da agência bancária do beneficiário String
Beneficiary.Account Número da conta do beneficiário String
Beneficiary.Type Tipo de conta do beneficiário String
Beneficiary.Document Documento do beneficiário, CPF (mascarado) ou CNPJ String
Beneficiary.Name Nome do beneficiário String
Billet.OurNumber Número de controle do banco Semear String
Billet.YourNumber Número de controle do cliente String
Billet.DueDate Data de vencimento do boleto DateTime
Billet.OperationDate Data do pagamentoDateTime
Billet.Status Status do boleto:

1 – “Em Aberto”
2 – “Em Cartório”
3 – “Pago”
4 – “Pago”
5 – “Baixado”
6 – “Protestado”
7 – “Vencido”
Billet.IspbCode Código bancário do boleto gerado

Resposta #

  • 200: Indica que foi enviado com sucesso
  • 400: Indica que há falha na requisição
  • 401: Indica que não foi autorizado
  • 500: Indica que houve erro no servidor

What are your Feelings

Distribuído porBetterDocs

Scroll to Top