Skip to main content
code<spar>
DocsGuidesServersSandbox
REST client

Boletos you owe (DDA)

The 4 operations under dda, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Boletos you owe (DDA)

Available from @codespar/sdk 0.12.0; the version on npm is 0.12.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check fails the build.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import {  } from "@codespar/sdk";

const  = new ({ : .. });

GET /v1/consumers/{consumerId}/dda/boletos

GET/v1/consumers/{consumerId}/dda/boletos

The boletos DDA has mirrored for this consumer

const  = await ..("/v1/consumers/{consumerId}/dda/boletos", {
  : {
    : "csm_0000000000000000"
  },
  : {
    : "string",
    : "string"
  }
});

Parameters, body and every documented response: GET /v1/consumers/{consumerId}/dda/boletos in the HTTP reference.

POST /v1/consumers/{consumerId}/dda/subscriptions

POST/v1/consumers/{consumerId}/dda/subscriptions

Register the consumer's CPF/CNPJ with DDA

const  = await ..("post", "/v1/consumers/{consumerId}/dda/subscriptions", {
  : {
    : "csm_0000000000000000"
  },
  : {
    : "string",
    : "Example",
    : "string"
  }
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
  .(.);
}

Parameters, body and every documented response: POST /v1/consumers/{consumerId}/dda/subscriptions in the HTTP reference.

GET /v1/consumers/{consumerId}/dda/subscriptions/{document}

GET/v1/consumers/{consumerId}/dda/subscriptions/{document}

Read a DDA registration

const  = await ..("/v1/consumers/{consumerId}/dda/subscriptions/{document}", {
  : {
    : "csm_0000000000000000",
    : "string"
  }
});

Parameters, body and every documented response: GET /v1/consumers/{consumerId}/dda/subscriptions/{document} in the HTTP reference.

DELETE /v1/consumers/{consumerId}/dda/subscriptions/{document}

DELETE/v1/consumers/{consumerId}/dda/subscriptions/{document}

End a DDA registration

const  = await ..("/v1/consumers/{consumerId}/dda/subscriptions/{document}", {
  : {
    : "csm_0000000000000000",
    : "string"
  }
});

Parameters, body and every documented response: DELETE /v1/consumers/{consumerId}/dda/subscriptions/{document} in the HTTP reference.

Edit on GitHub

Pix out

The 1 operation under pix-devolutions, as typed calls on the generated REST client.

Mandates

The 5 operations under mandates, as typed calls on the generated REST client.

On this page

Boletos you owe (DDA)GET /v1/consumers/{consumerId}/dda/boletosPOST /v1/consumers/{consumerId}/dda/subscriptionsGET /v1/consumers/{consumerId}/dda/subscriptions/{document}DELETE /v1/consumers/{consumerId}/dda/subscriptions/{document}
Boletos you owe (DDA) | CodeSpar