Consultar crédito

GET

api

pessoa

credito

Consultar crédito

curl --request GET \
  --url https://sandboxapi.mycredit.com.br/api/pessoa/credito \
  --header 'Authorization: Bearer <token>'

{
  "sucesso": true,
  "data": {
    "empresaDocumento": "99999999999999",
    "pessoaDocumento": "99999999999",
    "limite": 1000,
    "disponivel": 211.41,
    "validade": "2026-08-20T09:24:35.1383046"
  },
  "errors": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

empresa

string

required

CNPJ da empresa para qual deseja consultar o crédito. Formato: apenas números (ex: 99999999999999)

pessoa

string

required

CPF da pessoa para qual deseja consultar o crédito. Formato: apenas números (ex: 99999999999)

Response

Crédito consultado com sucesso

sucesso

boolean

Indica se a operação foi executada com sucesso. true para sucesso, false para erro

Example:

true

data

object

Objeto contendo os dados do crédito consultado. Presente apenas quando sucesso = true

Show child attributes

data.empresaDocumento

string

CNPJ da empresa consultada, retornado no mesmo formato enviado na requisição

Example:

"99999999999999"

data.pessoaDocumento

string

CPF da pessoa consultada, retornado no mesmo formato enviado na requisição

Example:

"99999999999"

data.limite

number

Limite total de crédito disponível para a pessoa na empresa, em reais

Example:

1000

data.disponivel

number

Valor de crédito disponível para uso, em reais.

Example:

211.41

data.validade

string<date-time>

Data e hora de validade do crédito em formato ISO 8601. Após esta data, o crédito pode expirar

Example:

"2026-08-20T09:24:35.1383046"

errors

string

Descrição detalhada do erro. Presente apenas quando sucesso = false

Criar ou atualizar créditoAtualiza o limite total de crédito disponível para uma pessoa em uma empresa específica.

⌘I

Consultar crédito

curl --request GET \
  --url https://sandboxapi.mycredit.com.br/api/pessoa/credito \
  --header 'Authorization: Bearer <token>'

{
  "sucesso": true,
  "data": {
    "empresaDocumento": "99999999999999",
    "pessoaDocumento": "99999999999",
    "limite": 1000,
    "disponivel": 211.41,
    "validade": "2026-08-20T09:24:35.1383046"
  },
  "errors": "<string>"
}

Para desenvolvedores

PIX

Crédito de clientes

Webhooks

Consultar crédito

Authorizations

Query Parameters

Response