Documentação SnowPay

Introdução

A API SnowPay PIX permite que você integre pagamentos e saques via PIX de forma eficiente e segura. Este documento detalha os endpoints disponíveis, parâmetros necessários e exemplos de uso. Para começar, obtenha suas credenciais (client_id e secret_key) entrando em contato com a equipe da SnowPay.

Autenticação

Todos os endpoints requerem autenticação via Basic Auth:

Header: Authorization
Formato: Basic base64(client_id:secret_key)
client_id e secret_key são fornecidos pela SnowPay.
Para gerar o valor Base64, codifique a string client_id:secret_key em Base64.

Nota: Mantenha suas credenciais seguras e não as exponha em ambientes públicos.

Pagamento PIX

Endpoint

POST https://snowpaybr.com/api/v2/
Content-Type: application/json
Authorization: Basic base64(client_id:secret_key)

Parâmetros (JSON)

Campo	Tipo	Descrição	Obrigatório
nome	string	Nome completo do cliente	Sim
cpf	string	CPF do cliente (somente números)	Sim
celular	string	Telefone do cliente (somente números)	Sim
email	string	E-mail do cliente	Sim
valor	integer	Valor do PIX em centavos (ex: R$50,00 = 5000)	Sim
rua	string	Endereço do cliente	Sim
numero	string	Número do endereço	Sim
cep	string	CEP	Sim
bairro	string	Bairro	Sim
cidade	string	Cidade	Sim
estado	string	UF (ex: SP, RJ)	Sim
postbackUrl	string	URL para receber webhook com atualização do status da transação	Opcional

Exemplo de Requisição

POST https://snowpaybr.com/api/v2/
Content-Type: application/json
Authorization: Basic Y2xpZW50XzYDJKASJHKDAJHKSljMjI6YzFiZjdkJDACDSDASBNDADA3MWVjZjgyOTE1NzQ=

{
    "nome": "Joao Dos Testes da Silva",
    "cpf": "00000000000",
    "celular": "11999999999",
    "email": "joao@email.com",
    "valor": 200,
    "rua": "Rua Teste",
    "numero": "123",
    "cep": "12345678",
    "bairro": "Centro",
    "cidade": "São Paulo",
    "estado": "SP",
    "postbackUrl": "https://seusite.com/webhook"
}

Exemplo de Resposta (200 OK)

{
    "transactionId": "a94f3b2c7d8e49fa83b7c5e20e4a17d9",
    "pix": "00020126820014br.gov.bcb.pix2560pix.treeal.com/qr/v3/at/9d7a1c4e-12b3-4f5a-8e6d-3f29a4c9f2b0....."
}

Cash IN - PIX

Endpoint

POST https://snowpaybr.com/api/transfers/
Content-Type: application/json
Authorization: Basic base64(client_id:secret_key)

Parâmetros (JSON)

Campo	Tipo	Descrição	Obrigatório
valor	integer	Valor do saque em centavos (ex: R$2,00 = 200)	Sim
tipo_chave	string	Tipo da chave PIX (ex: cpf, email, telefone, cnpj)	Sim
chave_pix	string	Chave PIX do destinatário	Sim
cpf	string	CPF do cliente (somente números)	Sim

Exemplo de Requisição

POST https://snowpaybr.com/api/transfers/
Content-Type: application/json
Authorization: Basic Y2xpZW50XzY4YTI5YTNlYWM1MCJAJBJKBSDJKJKCADJjNWNiYjM0ZTdmMjMxOGI=

{
    "valor": 200,
    "tipo_chave": "cpf",
    "chave_pix": "04257242205",
    "cpf": "04257242205"
}

Exemplo de Resposta (200 OK)

{
    "statusCode": 200,
    "saque_id": "a94f3b2c7d8e49fa83b7c5e20e4a17d9",
    "status": "aprovado",
    "message": "Saque realizado com sucesso"
}

Exemplos de Respostas de Erro

401 Unauthorized (ex: credenciais inválidas)

{
    "statusCode": 401,
    "message": "Unauthorized"
}

Webhook

Quando o status de uma transação de pagamento PIX muda, a API envia uma requisição POST para o postbackUrl informado no endpoint de pagamento. Este recurso não está disponível para saques.

Exemplo de Payload

{
    "transactionId": "b8c72d3f9a4e56d7c1f0e8a9b3c2d4f5",
    "external_id": "DEP_10_1755547676_9041",
    "status": "paid",
    "amount": 500,
    "postbackUrl": "https://seusite.com/webhook"
}