📘 Documentação da API

POST Depósito PIX

Descrição

Endpoint responsável por gerar um Código PIX no formato PIX Copia e Cola.

Endpoint

https://www.e-pagamentos.digital/v3/pix/qrcode

Headers


Content-Type: application/json

Body (application/json)

Campo Tipo Obrigatório Descrição
client_id string Sim Identificador do cliente
client_secret string Sim Chave secreta do cliente
nome string Sim Nome do pagador
cpf string Sim CPF do pagador
valor number Sim Valor do pagamento
descricao string Não Descrição do pagamento
urlnoty string Sim URL de callback para notificações

Exemplo de Implementação em cURL


curl -X POST "https://www.e-pagamentos.digital/v3/pix/qrcode" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "seu_client_id",
    "client_secret": "seu_client_secret",
    "nome": "Nome do Cliente",
    "cpf": "CPF do Cliente",
    "valor": 100.00,
    "descricao": "Descrição do pagamento",
    "urlnoty": "https://seuservidor.com/callback"
  }'

Resposta Esperada (Exemplo)


{
  "statusCode": 200,
  "qrcode": "00020126580014BR.GOV.BCB.PIX0136..."
  "external_id": "1234567890"
}

Resposta de Erro


{
  "statusCode": 400,
  "message": "Parâmetros inválidos"
}

POST Saque PIX

Descrição

Endpoint responsável por realizar um pagamento PIX para uma chave informada (transferência/payout), utilizando PHP com cURL.

Endpoint

https://www.e-pagamentos.digital/v3/pix/payment

Headers


Content-Type: application/json

Body (application/json)

Campo Tipo Obrigatório Descrição
client_id string Sim ID do cliente
client_secret string Sim Chave secreta do cliente
nome string Sim Nome do beneficiário
cpf string Sim CPF do beneficiário
valor number Sim Valor do pagamento
chave_pix string Sim Chave PIX do destinatário

Exemplo de Implementação em cURL


curl -X POST "https://www.e-pagamentos.digital/v3/pix/payment" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "SEU CLIENT ID",
    "client_secret": "SEU CLIENT SECRET",
    "nome": "Nome do cliente",
    "cpf": "Cpf do cliente",
    "valor": 1.00,
    "chave_pix": "Chave pix Cliente"
  }'

Resposta Esperada (Exemplo)


{
  "statusCode": 200,
  "message": "PIX Cashout criado com sucesso",
  "id": "1234567890"
}

Resposta de Erro


{
  "statusCode": 400,
  "message": "Parâmetros inválidos"
}

WEBHOOK Notificação de Pagamento PIX

Descrição

Este webhook é acionado automaticamente pelo gateway sempre que houver uma atualização no status de uma transação PIX, como confirmação de pagamento.

Método

POST

Content-Type

application/json

Body


{
  "transactionType": "RECEIVEPIX",
  "transactionId": "c327ce8bee2a18565ec2m1zdu6px2keu",
  "external_id": "55aefd02e54e785fbb5a80faa19f8802",
  "amount": 15.00,
  "paymentType": "PIX",
  "status": "PAID"
}

Campos do Webhook

Campo Tipo Descrição
transactionType string Tipo da transação (ex: RECEIVEPIX)
transactionId string ID único da transação no gateway
external_id string ID externo informado pelo sistema integrador
amount number Valor da transação
paymentType string Tipo de pagamento (PIX)
status string Status da transação (ex: PAID)