Autenticação

GET

api

token

{chave}

Autenticação

curl --request GET \
  --url https://sandboxapi.mycredit.com.br/api/token/{chave}

const options = {method: 'GET'};

fetch('https://sandboxapi.mycredit.com.br/api/token/{chave}', 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/token/{chave}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/token/{chave}"

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

	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/token/{chave}")

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

request = Net::HTTP::Get.new(url)

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

{
  "sucesso": true,
  "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

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

Toda chamada da API, exceto esta, exige o cabeçalho Authorization: Bearer {token}. O valor que volta em data é o JWT. A CHAVE_INTEGRADOR não entra nesse cabeçalho. Ela só serve para montar o segredo desta chamada.

O que você precisa

A CHAVE_INTEGRADOR, entregue pelo MyCredit para a revenda. Sem essa chave a autenticação não acontece.
O CNPJ da empresa que autentica e emite o PIX, somente números. Esse CNPJ é quem recebe o JWT e, nas chamadas seguintes, é quem cria o PIX.

O CNPJ precisa existir no MyCredit. Empresa sem revenda autentica com uma chave válida e não passa pela verificação de vínculo. Empresa ligada a uma revenda só autentica se a chave for dela ou da revenda à qual está associada. A revenda autentica o próprio CNPJ com a própria chave, mesmo sem um vínculo da revenda com ela mesma.

Passo a passo

Monte o segredo

Junte o CNPJ e a chave com uma barra vertical (|):

CNPJ_DA_EMPRESA_EMISSORA|CHAVE_INTEGRADOR

Exemplo, com dados fictícios:

99999999999999|CHAVE123456789

Codifique em Base64

Converta a string inteira para Base64. A codificação evita que a barra vertical se perca na URL. Ela não substitui o HTTPS.O exemplo acima vira:

OTk5OTk5OTk5OTk5OTl8Q0hBVkUxMjM0NTY3ODk=

Troque o segredo pelo JWT

Faça um GET. Não envie corpo nem cabeçalho Authorization nesta chamada.

curl -X GET "https://sandboxapi.mycredit.com.br/api/token/OTk5OTk5OTk5OTk5OTl8Q0hBVkUxMjM0NTY3ODk="

Resposta de sucesso:

{
  "sucesso": true,
  "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

O campo data é o JWT. Ele vale 2 dias. Quando expirar, repita este passo.Se o segredo estiver errado ou a empresa não existir, a API responde HTTP 400:

{
  "sucesso": false,
  "errors": "Não foi possível autenticar"
}

Quando a empresa existe, mas não está ligada a esta revenda, a mensagem é Empresa não associada a esta revenda.

Use o JWT nas outras chamadas

curl -X POST "https://sandboxapi.mycredit.com.br/api/pix" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json" \
  -d "{\"formaPagamento\":{\"tpTransacao\":11,\"idFaturaPag\":\"9b041599-eacc-4a0f-9a16-e0191c9a66aa\",\"modPagamento\":18,\"valorPagamento\":1.29}}"

Erros comuns

A API responde 401 nas cobranças

O cabeçalho está sem Bearer, o JWT expirou ou você enviou o segredo Base64 no lugar do JWT. Gere o token de novo e envie Authorization: Bearer {data}.

A API responde que não foi possível autenticar

A chave não existe, está inativa, ou o CNPJ não está cadastrado. Confira se a carteira PIX dessa empresa já foi ativada e se o CNPJ é o da empresa emissora.

Empresa não associada a esta revenda

O CNPJ pertence a uma empresa ligada a uma revenda, mas não à revenda dona desta chave. Empresa sem revenda não cai neste erro. A revenda autentica o próprio CNPJ sem vínculo consigo mesma.

O PIX é gerado na empresa errada

O CNPJ à esquerda da barra vertical define quem autentica e emite a cobrança. Em uma revenda, trocar esse CNPJ muda a empresa emissora, desde que ela esteja associada a essa revenda.

Ambientes

Ambiente	Base da API
Sandbox	`https://sandboxapi.mycredit.com.br`
Produção	`https://mycreditapi.azurewebsites.net`

A chave de um ambiente não vale no outro. Monte o segredo com a CHAVE_INTEGRADOR daquele ambiente.

Path Parameters

chave

string

required

Segredo em Base64. O texto original, antes de codificar, é CNPJ_DA_EMPRESA_EMISSORA|CHAVE_INTEGRADOR. O CNPJ, só números, é a empresa que autentica e emite o PIX.

Response

Token gerado. O campo data é o JWT, em texto.

sucesso

boolean

Example:

true

data

string

JWT para enviar como Authorization: Bearer {data}. Não envie o segredo Base64 neste cabeçalho.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Autenticação

curl --request GET \
  --url https://sandboxapi.mycredit.com.br/api/token/{chave}

const options = {method: 'GET'};

fetch('https://sandboxapi.mycredit.com.br/api/token/{chave}', 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/token/{chave}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/token/{chave}"

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

	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/token/{chave}")

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

request = Net::HTTP::Get.new(url)

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

{
  "sucesso": true,
  "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

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

Para desenvolvedores

PIX

Crédito de clientes

Status do pagamento

O que você precisa

Passo a passo

Erros comuns

Ambientes

Path Parameters

Response

​O que você precisa

​Passo a passo

​Erros comuns

​Ambientes

Path Parameters

Response

O que você precisa

Passo a passo

Erros comuns

Ambientes