APIs Comuns

API de status

Obtém a descrição referente ao código de status retornado pelas APIs.

GET https://openbanking.api.pagseguro.com/discovery/v1/status HTTP/1.1
Host: api.banco.com.br
Accept: application/json

Exemplo de uso

curl https://openbanking.api.pagseguro.com/discovery/v1/status

O comando acima retorna uma estrutura json como exemplificada abaixo, e no caso em que o status devolvido seja OK, o array unavailableEndpoints deve estar vazio:

{
  "data": {
    "status": [
      {
        "code": "SCHEDULED_OUTAGE",
        "explanation": "Manutenção Planejada",
        "detectionTime": "2020-01-01T01:00:00Z",
        "expectedResolutionTime": "2020-01-01T01:00:00Z",
        "updateTime": "2020-01-02T01:00:00Z",
        "unavailableEndpoints": [
          "https://openbanking.api.pagseguro.com/channels/v1/branches"
        ]
      },
      {
        "code": "PARTIAL_FAILURE",
        "explanation": "Falha na execução do serviço",
        "detectionTime": "2020-01-01T01:00:00Z",
        "expectedResolutionTime": "2020-01-01T01:00:00Z",
        "updateTime": "2020-01-02T01:00:00Z",
        "unavailableEndpoints": [
          "https://openbanking.api.pagseguro.com/channels/v1/electronic-channels"
        ]
      }
    ],
    "links": {
      "self": "https://openbanking.api.pagseguro.com/discovery/v1/status"
    },
    "meta": {
      "totalRecords": 1,
      "totalPages": 1
    }
  }
}

Ambientes

API Outages

Obtêm a lista de indisponibilidade agendada para os serviços.

GET https://api.banco.com.br/open-banking/discovery/v1/outages HTTP/1.1
Host: api.banco.com.br
Accept: application/json

Exemplo de uso

cURL  https://openbanking.api.pagseguro.com/discovery/v1/outages

Na estrutura de retorno exemplificada abaixo, no caso em que o parâmetro isPartial devolvido seja true, o array unavailableEndpoints deve conter a lista de endpoints indisponíveis:

{
  "data": {
    "status": [
      {
        "code": "SCHEDULED_OUTAGE",
        "explanation": "Manutenção Planejada",
        "detectionTime": "2020-01-01T01:00:00Z",
        "expectedResolutionTime": "2020-01-01T01:00:00Z",
        "updateTime": "2020-01-02T01:00:00Z",
        "unavailableEndpoints": [
          "https://openbanking.api.pagseguro.com/channels/v1/branches"
        ]
      },
      {
        "code": "PARTIAL_FAILURE",
        "explanation": "Falha na execução do serviço",
        "detectionTime": "2020-01-01T01:00:00Z",
        "expectedResolutionTime": "2020-01-01T01:00:00Z",
        "updateTime": "2020-01-02T01:00:00Z",
        "unavailableEndpoints": [
          "https://openbanking.api.pagseguro.com/channels/v1/electronic-channels"
        ]
      }
    ],
    "links": {
      "self": "https://openbanking.api.pagseguro.com/discovery/v1/status"
    },
    "meta": {
      "totalRecords": 1,
      "totalPages": 1
    }
  }
}

Ambientes