Skip to content

Criar Deposito

POST /api/deposit

Cria uma cobranca PIX e retorna o QR Code para pagamento. Quando o pagamento for confirmado, o valor e creditado na sua conta (descontada a taxa) e um webhook DEPOSIT_ASSET_SUCCESS e disparado.

Request

json
{
  "value": 5000
}

Campos

CampoTipoObrigatorioDescricao
valueIntegerSimValor do deposito em centavos. Ex: 5000 = R$ 50,00

Resposta de sucesso

json
{
  "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": "PENDING"
  }
}

Campos da resposta

CampoTipoDescricao
successBooleantrue se o deposito foi criado
charge.idStringID unico da cobranca
charge.emvStringCodigo PIX copia-e-cola
charge.qrCodeLinkStringURL da imagem do QR Code
charge.paymentLinkIdStringID para consultar o status da cobranca
charge.paymentLinkUrlStringURL da pagina de pagamento
charge.valueIntegerValor da cobranca em centavos
charge.originalValueIntegerValor original solicitado em centavos
charge.feeIntegerTaxa cobrada em centavos
charge.statusStringStatus da cobranca (PENDING, COMPLETED, EXPIRED)

Resposta de erro

json
{
  "success": false,
  "error": "value must be a positive integer (cents)"
}

Exemplos

bash
curl -X POST https://api.pix2bit.net/api/deposit \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer SUA_API_KEY" \
  -d '{"value": 5000}'
javascript
const createDeposit = async (valueInCents) => {
  const response = await fetch('https://api.pix2bit.net/api/deposit', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer SUA_API_KEY',
    },
    body: JSON.stringify({
      value: valueInCents,
    }),
  });

  const data = await response.json();

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

  return data.charge;
};

// Criar deposito de R$ 50,00
const charge = await createDeposit(5000);

console.log('QR Code:', charge.qrCodeLink);
console.log('PIX copia-e-cola:', charge.emv);
python
import requests

def create_deposit(value_in_cents, api_key):
    url = "https://api.pix2bit.net/api/deposit"

    response = requests.post(url, json={
        "value": value_in_cents,
    }, headers={
        "Content-Type": "application/json",
        "Authorization": f"Bearer {api_key}",
    })

    data = response.json()

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

    return data["charge"]


# Criar deposito de R$ 50,00
charge = create_deposit(5000, "SUA_API_KEY")

print(f"QR Code: {charge['qrCodeLink']}")
print(f"PIX copia-e-cola: {charge['emv']}")

Status possiveis

StatusDescricao
PENDINGAguardando pagamento
COMPLETEDPagamento confirmado
EXPIREDQR Code expirado
CANCELEDCobranca cancelada

Fluxo completo

INFO

Recomendamos configurar um webhook para receber a notificacao de pagamento confirmado em vez de fazer polling no status.