v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Débito Direto Autorizado

Consultar DDAs de um emissor específico

get/direct-debit/debits

Query parameters

pageNumberinteger

Example:1

Número da página a ser retornada

pageSizeinteger

Número de itens por página

Example:10

payeeDocumentstring

Example:37297902000141

Documento do emissor

payeeBankCodestring

Example:208

Código do banco do emissor

statusstring

Example:CREATED

Status do débito

minAmountnumber

Valor

Example:10.23

Valor mínimo do débito

maxAmountnumber

Valor

Example:10.23

Valor máximo do débito

minDueDatestring

Data

Example:2024-06-18T00:00:00.000Z

Data mínima de vencimento

maxDueDatestring

Data

Example:2024-06-18T00:00:00.000Z

Data máxima de vencimento

hiddenboolean

Indica se o débito está oculto

Response

Example response

{
  "data": [
    {
      "id": "d2627834-dd84-4094-9dcf-ca784460b352",
      "amount": 10.23,
      "dueDate": "2024-06-18T00:00:00.000Z",
      "expirationDate": "2024-06-18T00:00:00.000Z",
      "digitableLine": "20890050091784560129710038868500996680000100000",
      "payee": {
        "document": "00000000000125",
        "fantasyName": "VECHI CONSULTORIA E PROJETOS LTDA",
        "socialName": "VECHI CONSULTORIA E PROJETOS LTDA",
        "bankCode": "208",
        "bankName": "VECHI CONSULTORIA E PROJETOS LTDA"
      },
      "_links": {
        "hide": {
          "rel": "self",
          "href": "/direct-debits/d2627834-dd84-4094-9dcf-ca784460b352",
          "method": "DELETE",
          "type": "application/json"
        }
      }
    }
  ],
  "_links": {
    "next": {
      "rel": "self",
      "href": "/direct-debits/d2627834-dd84-4094-9dcf-ca784460b352",
      "method": "DELETE",
      "type": "application/json"
    },
    "previous": {
      "rel": "self",
      "href": "/direct-debits/d2627834-dd84-4094-9dcf-ca784460b352",
      "method": "DELETE",
      "type": "application/json"
    }
  }
}