v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Detalhes da Captura

Este recurso retorna informações sobre uma captura / cessão de títulos.

get/concessions/{concession_id}

Path parameters

concession_idstring required

Id da concessão

Query parameters

p[page]string

Página que será carregada.

p[per_page]string

Quantidade de itens que serão retornados por página.

Response

200

Example response

{
  "data": {
    "id": "d8d74d12-88db-4b51-a6ca-6ac7bdd6cc23",
    "type": "concession",
    "attributes": {
      "createdAt": "2021-01-01T00:00:00.000-03:00",
      "updatedAt": "2021-01-01T00:00:00.000-03:00",
      "status": "pending",
      "type": "offering",
      "fromAccount": {
        "data": {
          "id": 5000,
          "type": "account",
          "attributes": {
            "agency": "0001",
            "accountNumber": "00001111-4",
            "documentNumber": "26146719000129"
          }
        }
      },
      "toAccount": {
        "data": {
          "id": 5000,
          "type": "account",
          "attributes": {
            "agency": "0001",
            "accountNumber": "00001112-2",
            "documentNumber": "27214814000185"
          }
        }
      },
      "access": {
        "data": {
          "id": "d8d74d12-88db-4b51-a6ca-6ac7bdd6cc23",
          "type": "access",
          "attributes": {
            "createdAt": "2021-01-01T00:00:00.000-03:00",
            "updatedAt": "2021-01-01T00:00:00.000-03:00",
            "expiresAt": "2021-01-01T00:00:00.000-03:00",
            "status": "active",
            "agreeType": "manual"
          }
        }
      },
      "charges": {
        "data": [
          {
            "id": "d8d74d12-88db-4b51-a6ca-6ac7bdd6cc23",
            "type": "charge",
            "attributes": {
              "clientControlNumber": "001-2",
              "receiptNumber": "51080701212344000127550010000000981364117781",
              "status": "pending",
              "value": "20.0",
              "dueDate": "2021-01-01T00:00:00.000-03:00",
              "transferState": "transferred",
              "payer": {
                "data": {
                  "type": "payer",
                  "attributes": {
                    "name": "Grafeno Digital",
                    "documentNumber": "05944596991300",
                    "email": "your_email@grafeno.digital"
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}