Gateway Crédito Direto
Entrar

API do Gateway

Chaves Pix

Registro, verificação e exclusão das chaves de recebimento da conta.

GET/pix-keysAutenticado

Listar chaves Pix

Lista as chaves da conta, excluindo chaves com status REMOVIDA.

https://gateway.credito-direto.com/api/pix-keys

cURL

cURL
curl --request GET \
  --url 'https://gateway.credito-direto.com/api/pix-keys' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Exemplo de resposta

Response JSON
{
  "items": [
    {
      "id": "key_01",
      "key_type": "EMAIL",
      "key": "recebe@credito-direto.com",
      "status": "REGISTRADA",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:05:00.000Z"
    }
  ]
}
POST/pix-keysAutenticado

Registrar chave Pix

Solicita o registro de uma chave. E-mail e telefone entram em validação e exigem código.

https://gateway.credito-direto.com/api/pix-keys

cURL

cURL
curl --request POST \
  --url 'https://gateway.credito-direto.com/api/pix-keys' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN' \
  --header 'content-type: application/json' \
  --data '{ "key": "financeiro@empresa.com", "key_type": "EMAIL" }'

Corpo da requisição

CampoTipoObrigatórioDescrição
keystringNãoValor da chave. Obrigatório, exceto para chave aleatória.
key_typeEMAIL | TELEFONE | CPF | CNPJ | CHAVE_ALEATORIANãoTipo. Para aleatória, omita `key` ou use `key_type: CHAVE_ALEATORIA`.

Exemplo de requisição

Body JSON
{
  "key": "financeiro@empresa.com",
  "key_type": "EMAIL"
}
  • E-mail e telefone exigem verificação (`PUT /pix-keys/:id/verify`).
  • Telefone deve estar no formato internacional quando aplicável.
PUT/pix-keys/:id/verifyAutenticado

Verificar chave Pix

Confirma o código enviado por e-mail ou SMS e conclui o registro.

https://gateway.credito-direto.com/api/pix-keys/:id/verify

cURL

cURL
curl --request PUT \
  --url 'https://gateway.credito-direto.com/api/pix-keys/:id/verify' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN' \
  --header 'content-type: application/json' \
  --data '{ "code": "482913" }'

Parâmetros de caminho

CampoTipoObrigatórioDescrição
idstringSimIdentificador da chave.

Corpo da requisição

CampoTipoObrigatórioDescrição
codestringSimCódigo de verificação (mín. 4 caracteres).

Exemplo de requisição

Body JSON
{ "code": "482913" }
PUT/pix-keys/:id/resendAutenticado

Reenviar verificação

Reenvia o código de verificação da chave.

https://gateway.credito-direto.com/api/pix-keys/:id/resend

cURL

cURL
curl --request PUT \
  --url 'https://gateway.credito-direto.com/api/pix-keys/:id/resend' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Parâmetros de caminho

CampoTipoObrigatórioDescrição
idstringSimIdentificador da chave.
DELETE/pix-keys/:idAutenticado

Remover chave Pix

Solicita a exclusão da chave no DICT.

https://gateway.credito-direto.com/api/pix-keys/:id

cURL

cURL
curl --request DELETE \
  --url 'https://gateway.credito-direto.com/api/pix-keys/:id' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Parâmetros de caminho

CampoTipoObrigatórioDescrição
idstringSimIdentificador da chave.