Verificar Status do Pagamento

Descrição #

Método usado para validar o status do pagamento

Endpoints #

• Produção: https://api2.bancosemear.com.br/itp/payments/<ID-PAGAMENTO>
• Homologação: https://hmlapi2.bancosemear.com.br/itp/payments/<ID-PAGAMENTO>

Parâmetros de Requisição #

Cabeçalho: #

• authorization: Token bearer de autenticação do serviço integrador recebido através do método: Gerar Token de Autenticação (Serviço Integrador)
• client_id: ID de cliente usado para controle de acesso do gateway de APIs
• access-token: Token recebido após executar o método: Gerar Token de Autenticação (Gateway API)

Parâmetros GET: #

• <ID-PAGAMENTO>: ID de pagamento recebido pelo método: Criar Pagamento

Requisição (GET) #

curl "https://hmlapi2.bancosemear.com.br/itp/payments/04595ce7-asdf-441a-9ff2-010d5a2d56e3" \
-A '' \
-H "access_token: <ACCESS_TOKEN>" \
-H "authorization: Bearer <AUTHORIZATION>" \
-H 'client_id: <CLIENT_ID>'

Resposta #

{
  "data": {
    "id": "04595ce7-asdf-441a-9ff2-010d5a2d56e3",
    "type": "NOW",
    "createDateTime": "2024-10-17T12:35:09.981Z",
    "externalId": "00000000001",
    "externalComment": "Teste",
    "lastChangedDateTime": "2024-10-17T12:35:09.981Z",
    "status": "PENDENTE",
    "tenantId": "teste-sub-HML",
    "cpfCnpj": "012345678901",
    "redirectUri": "https://redirect-demo-opal.vercel.app",
    "value": "0.01",
    "consentId": null,
    "creditor": {
      "name": "Fulano de Tal",
      "personType": "PESSOA_NATURAL",
      "cpfCnpj": "012345678901",
      "accountIspb": "00795499",
      "accountIssuer": "0001",
      "accountNumber": "0011999999",
      "accountPixKey": "naoenviar@gmail.com",
      "accountType": "CACC"
    },
    "payments": [
      {
        "id": "6734b100-asdf-4e30-b005-0d995be04190",
        "dueDate": "2024-10-17T12:35:09.995Z",
        "externalComment": "Pagamento de Teste",
        "externalId": "00000000001",
        "status": "PENDENTE",
        "externalPaymentId": null
      }
    ]
  },
  "message": "",
  "type": "success"
}

Parâmetros de Resposta #

Corpo (JSON) #