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>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandboxapi.mycredit.com.br/api/pessoa/credito', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandboxapi.mycredit.com.br/api/pessoa/credito",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandboxapi.mycredit.com.br/api/pessoa/credito"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.mycredit.com.br/api/pessoa/credito")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

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)

Pattern: ^[0-9]{14}$

pessoa

string

required

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

Pattern: ^[0-9]{11}$

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

errors

string

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

Consultar crédito

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandboxapi.mycredit.com.br/api/pessoa/credito', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandboxapi.mycredit.com.br/api/pessoa/credito",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandboxapi.mycredit.com.br/api/pessoa/credito"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.mycredit.com.br/api/pessoa/credito")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

Para desenvolvedores

PIX

Crédito de clientes

Webhooks

Consultar crédito

Authorizations

Query Parameters

Response