Consultar Deposito

GET /api/deposit/:paymentLinkId

Consulta o status de um deposito criado anteriormente. O paymentLinkId e retornado na resposta do POST /api/deposit.

Se o deposito ainda estiver pendente, o Pix2bit verifica automaticamente o status junto ao provedor de pagamento antes de retornar a resposta.

Parametros de URL

Parametro	Tipo	Obrigatorio	Descricao
paymentLinkId	String	Sim	ID retornado ao criar o deposito

Resposta de sucesso

{
  "success": true,
  "charge": {
    "id": "67a1b2c3d4e5f67890abcdef",
    "emv": "00020126580014br.gov.bcb.pix...",
    "qrCodeLink": "https://api.eulen.com.br/qr/abc123.png",
    "paymentLinkId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "paymentLinkUrl": "https://app.pix2bit.net/payment-link/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "value": 5000,
    "originalValue": 5000,
    "fee": 50,
    "status": "COMPLETED",
    "createdAt": "2026-02-16T12:00:00.000Z"
  }
}

Campos da resposta

Campo	Tipo	Descricao
success	Boolean	true se a consulta foi bem sucedida
charge.id	String	ID unico da cobranca
charge.emv	String	Codigo PIX copia-e-cola
charge.qrCodeLink	String	URL da imagem do QR Code
charge.paymentLinkId	String	ID da cobranca
charge.paymentLinkUrl	String	URL da pagina de pagamento
charge.value	Integer	Valor da cobranca em centavos
charge.originalValue	Integer	Valor original solicitado em centavos
charge.fee	Integer	Taxa cobrada em centavos
charge.status	String	Status da cobranca
charge.createdAt	String	Data de criacao (ISO 8601)

Resposta de erro

{
  "success": false,
  "error": "Charge not found"
}

Exemplos

cURL

curl https://api.pix2bit.net/api/deposit/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer SUA_API_KEY"

JavaScript

const getDeposit = async (paymentLinkId) => {
  const response = await fetch(
    `https://api.pix2bit.net/api/deposit/${paymentLinkId}`,
    {
      headers: {
        'Authorization': 'Bearer SUA_API_KEY',
      },
    },
  );

  const data = await response.json();

  if (!data.success) {
    throw new Error(data.error);
  }

  return data.charge;
};

const charge = await getDeposit('a1b2c3d4-e5f6-7890-abcd-ef1234567890');

console.log('Status:', charge.status);

Python

import requests

def get_deposit(payment_link_id, api_key):
    url = f"https://api.pix2bit.net/api/deposit/{payment_link_id}"

    response = requests.get(url, headers={
        "Authorization": f"Bearer {api_key}",
    })

    data = response.json()

    if not data["success"]:
        raise Exception(data["error"])

    return data["charge"]


charge = get_deposit("a1b2c3d4-e5f6-7890-abcd-ef1234567890", "SUA_API_KEY")

print(f"Status: {charge['status']}")

Status possiveis

Status	Descricao
PENDING	Aguardando pagamento
COMPLETED	Pagamento confirmado
EXPIRED	QR Code expirado
CANCELED	Cobranca cancelada