Pular para o conteúdo
McpfPay
Menu ☰

Contas

Dados e capacidades da conta digital conectada.

Consultar conta digital

GET/v1/accounts/{account_id}

Dados cadastrais e o que a conta já está habilitada a fazer.

Parâmetros

account_idobrigatóriostring · caminho
—

Resposta

idobrigatóriostring
—
livemodeobrigatórioboolean
—
documentobrigatóriostring

CPF (11 dígitos) ou CNPJ (14 dígitos), só números.

legal_nameobrigatóriostring
—
trade_namestring ou nulo
—
statusobrigatóriounder_review | active | blocked | closed
—
statement_descriptorstring ou nulo

Nome que aparece na fatura do cartão do pagador.

capabilitiesobrigatórioobject

O que a conta pode fazer hoje.

capabilities.pixboolean
—
capabilities.boletoboolean
—
capabilities.payment_linkboolean
—
capabilities.cardboolean
—
capabilities.max_installmentsinteger
—
free_charges_remaininginteger

Cobranças sem tarifa restantes no mês corrente.

Códigos de resposta

  • 200 Conta.
  • 403 Sem conexão ativa com a conta, escopo insuficiente ou conta sem a capacidade exigida.
  • 404 Recurso não encontrado para esta chave.