Pular para o conteúdo principal
POST
/
v1
/
entries
/
{entryId}
/
confirmation
Confirmar chave
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}/confirmation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "169248",
  "accountId": "019c96a0-0a98-7287-9a31-786e0809c769"
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}/confirmation"

payload = {
"token": "169248",
"accountId": "019c96a0-0a98-7287-9a31-786e0809c769"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({token: '169248', accountId: '019c96a0-0a98-7287-9a31-786e0809c769'})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}/confirmation', 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://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}/confirmation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'token' => '169248',
'accountId' => '019c96a0-0a98-7287-9a31-786e0809c769'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}/confirmation"

payload := strings.NewReader("{\n \"token\": \"169248\",\n \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}/confirmation")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"token\": \"169248\",\n \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}/confirmation")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"token\": \"169248\",\n \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}"

response = http.request(request)
puts response.read_body
{
  "key": "+5511987654321",
  "keyType": 3,
  "status": 1,
  "statusDescription": "PENDING_CONFIRMATION"
}

Autorizações

Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Parâmetros de caminho

entryId
string
obrigatório

Valor da chave PIX (telefone, email, CPF, CNPJ ou EVP).

Corpo

application/json
token
string
obrigatório

Token de validacao recebido via SMS/email.

Exemplo:

"169248"

accountId
string<uuid>
obrigatório

Identificador da conta.

Exemplo:

"019c96a0-0a98-7287-9a31-786e0809c769"

Resposta

Chave PIX confirmada com sucesso

key
string
obrigatório

Valor da chave PIX.

Exemplo:

"+5511987654321"

keyType
enum<integer>
obrigatório

Identificador do tipo de chave PIX. Codigos numericos que especificam o tipo de chave PIX sendo utilizada.

Valores validos:

  • 0 = CPF (CPF de pessoa fisica com 11 digitos, ex.: "12345678901")
  • 1 = CNPJ (CNPJ de pessoa juridica com 14 digitos, ex.: "12345678000190")
  • 2 = EMAIL (Endereco de email, ex.: "user@example.com")
  • 3 = PHONE (Numero de telefone em formato internacional, ex.: "+5511987654321")
  • 4 = EVP (Chave UUID aleatoria gerada automaticamente, ex.: "123e4567-e89b-12d3-a456-426614174000")
Opções disponíveis:
0,
1,
2,
3,
4
Exemplo:

3

status
enum<integer>
obrigatório

Codigo de status de registro da chave PIX. Indica o estado atual de uma chave PIX em seu ciclo de vida.

Valores validos:

  • -1 = CANCELLED (Registro da chave foi cancelado)
  • 0 = FINALIZED (Chave finalizada/aguardando confirmacao)
  • 1 = ACTIVE (Chave ativa e operacional)
  • 2 = WAITING_OWNERSHIP_CONFIRMATION (Aguardando confirmacao de propriedade do usuario)
  • 3 = CREATING (Chave esta sendo criada no sistema)
  • 4 = IM_CLAIMER_PENDING_CONFIRM_CLAIM_REQUEST (Sou reivindicador, aguardando confirmacao da reivindicacao)
  • 5 = IM_CLAIMER_PENDING_OWNER_GIVEWAY (Sou reivindicador, aguardando proprietario atual liberar a chave)
  • 6 = IM_OWNER_PENDING_GIVEAWAY_CONFIRM (Sou proprietario, aguardando aprovacao para transferir a chave)
  • 7 = IM_CLAIMER_AND_OWNER_GAVEAWAY_PENDING_MY_CONFIRM (Transferencia iniciada, aguardando minha confirmacao)
Opções disponíveis:
-1,
0,
1,
2,
3,
4,
5,
6,
7
Exemplo:

1

statusDescription
string
obrigatório

Descricao legivel do status correspondente ao codigo de status numerico.

Exemplo:

"PENDING_CONFIRMATION"