Documentação da API Valorion - Saldo

Atenção: Somente IP's autorizados

Consulta saldo

Endpoint: https://app.valorion.com.br/api/s1/getsaldo/api/

Descrição

Esse endpoint permite realizar a consulta do usuario.

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações da transação e confirmação do processamento.

Erros

Exemplo Json Response

 
{
    "data": {
        "usuario": "gustavo",
        "nome": "gustavo",
        "saldo_liquido": 0,
        "transacoes": {
            "entrada": {
                "quantidade": 1,
                "bruto": "1151.00",
                "liquido": "1146.00"
            },
            "saida": {
                "quantidade": 4,
                "bruto": "889.00",
                "liquido": "880.00"
            }
        }
    },
    "status": 200,
    "message": "Sucesso ao consultar saldo!",
    "error": ""
}

Documentação da API Valorion - Consulta transação

Atenção: Transação

Endpoint: https://app.valorion.com.br/api/s1/getTransaction/api/getTransactionStatus.php?id_transaction={id_transaction}

Descrição

Esse endpoint permite realizar a consulta de informações sobre determinada transação, seja cashIn ou cashOut.

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações da transação e confirmação do processamento.

Erros

Exemplo Json Response

 
{
    "id_transaction": "5ef620fa304421ab5bdb6b48c6ded6",
    "situacao": "AGUARDANDO_PAGAMENTO",
    "tipo": "CASH IN",
    "data_transacao": "2025-01-25 21:42:01",
    "nome": "Bechara Jalkh",
    "documento": null,
    "valor_bruto": "1.60",
    "valor_liquido": "1",
    "referencia_externa": "ov0kXOhAZadCrEI9hPPC5VkzddKfn7qG",
    "status": 200,
    "error": ""
}

Documentação da API Valorion - Consulta transação

Atenção: Transação

Endpoint: https://app.valorion.com.br/api/s1/getCompany/

Descrição

Esse endpoint permite realizar a consulta de informações sobre o seller. A identificação é feita através da API Key.

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações do usuário

Erros

Exemplo Json Response

 
{
    "dados_seller": {
        "empresa": {
            "id": 18777723,
            "user_id": "Bruno_dev",
            "nome": "Bruno Rogério",
            "email": "felipe@gmail.com.com",
            "cpf_cnpj": "65214585423",
            "data_nascimento": "1994-10-20",
            "telefone": "61987669422",
            "data_cadastro": "2024-12-06 22:07:20",
            "ip_user": "201.14.83.1,189.49.141.176,2804:d59:aa07:4700",
            "taxa_cash_in": "7.00"
        },
        "endereco": {
            "cep": "73097514",
            "estado": "Distrito Federal",
            "cidade": "Brasilia",
            "bairro": "Sobradinho",
            "numero": "01",
            "complemento": "SH Contagem"
        }
    }
}

Documentação da API Valorion - CashIn

Atenção: Somente IP's autorizados

Solicitação de Depósito (Pix de Entrada)

Endpoint: https://api-fila-cash-in-out.onrender.com/v2/pix/charge

Descrição

Esse endpoint permite realizar requisições de pagamento via PIX, com autenticação por chave de API e validação de IP autorizado. Ele também verifica campos obrigatórios e requisitos de valores mínimos.

Parâmetros da Requisição (JSON)

Campos do Cliente

Endereço do Cliente

Detalhes do Pagamento

items

Outros Parâmetros

Exemplo Json de Envio

 
{
	"amount": 10,
	"customer": {
		"name": "Paulo Queiroz",
		"email": "cliente@email.com",
		"cpf": "02965847521",
		"phone": "(99) 98765-4321",
		"externaRef": "",
		"address": {
			"street": "Rua Exemplo",    
			"streetNumber": "123",
			"complement": "Complemento",
			"zipCode": "73070713",
			"neighborhood": "Bairro",
			"city": "Cidade",
			"state": "SP",
			"country": "br"
		}
	},
    "checkout" : {
          "utm_source": "exemplo utm_source",
          "utm_medium": "exemplo utm_medium",
          "utm_campaign": "exemplo utm_campaign",
          "utm_term": "exemplo utm_term",
          "utm_content": "exemplo utm_content"
    },
	"pix": {
		"expiresInDays": 2
	},
	"items": [
		{
			"title": "Produto Exemplo",
			"quantity": 1,
			"unitPrice": 10,
			"tangible": true
		}
	],
	"postbackUrl": "https://exemple/webhook/",
	"metadata": "metadata",
	"traceable": true
}

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações da transação e confirmação do processamento.

Erros

Exemplo Json Response

 
{
  "status": "success",
  "status_transaction": "WAITING_FOR_APPROVAL",
  "message": "ok",
  "client_id": "e3f8ad47-3cb7-4129-9fad-bh891c42c493",
  "paymentCode": "00020126860014br.gov.bcb.pix2563pix.bankn.com.br/qr/v3/at/fa68393e-d775-415a-9336-244c020194605204000053039865802BR5925PAGPIX_SOLUCAO_EM_PAGAMEN6014SAO_BERNARDO_D62070503***630426F7",
  "idTransaction": "28564976-75v5-427c-a693-5e89e8849b76",
  "paymentCodeBase64": "MDAwMjAxMjY4NTAwMTRicdafd34afqa3mNvbS5ici9xci92My9hdC9mYTY4MzkzZS1kMjc1LTQxNWEtOTIyNi0yNDRjMDIwMTk0NjA1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTI1UEFHUElYX1NPTFVDQU9fRU1fUEFHQU1FTjYwMTRTQU9fQkVSTkFSRE9fRDYyMDcwNTAzKi
  oqNjMwNDI2Rjc=",
  "urlWebHook": "https://exemple/webhook/"
}

Documentação da API Valorion - Cashout

Pix de Saída (2 etapas): Autenticação + Criação

ATENÇÃO: Para usar o Pix de Saída é obrigatório:

• IPs autorizados e Chaves Pix autorizadas (X-Pix-Key) cadastrados previamente.
• Entre em contato com o Time de Tecnologia da Valorion para cadastrar/alterar IPs e chaves Pix permitidas.

1- Autenticação

Método: POST

Endpoint: /v2/pix/transaction/auth

Headers

Body: vazio

Exemplo cURL

curl --location --request POST 'https://api-fila-cash-in-out.onrender.com/v2/pix/transaction/auth' \
  --header 'X-API-Key: {API_KEY}' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'X-Pix-Key: {PIX_KEY}' \
  --data ''

Resposta (200)

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",
  "token_type": "Bearer",
  "scope": "cashout:create",
  "expires_in": 180
}

Erros comuns

2- Criação do Pix de Saída

Método: POST

Endpoint: /v2/pix/transaction/create

Headers

Body (JSON)

Exemplo cURL

curl --location 'https://api-fila-cash-in-out.onrender.com/v2/pix/transaction/create' \
  --header 'X-API-Key: {API_KEY}' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'X-Pix-Key: {PIX_KEY}' \
  --header 'Authorization: Bearer <TOKEN_DA_ETAPA_AUTH>' \
  --data '{
    "amount": 5.04,
    "pixKey": "{PIX_KEY}",
    "pixType": "CPF",
    "beneficiaryName": "Bruno",
    "beneficiaryDocument": "{PIX_KEY}",
    "postbackUrl": "https://webhook.site/8122cc52-30a2-462f-98b8-7d960bbbed9f"
  }'

Exemplo de resposta (200)

{
  "status": "success",
  "message": "Cashout criado com sucesso.",
  "status_transaction": "PENDING",
  "idTransaction": "456daid6-15l1-4372-72b9-52r321gs8b07",
  "externalreference": "07f5bced-37c2-4b75-b5d7-3691f8ed4262",
  "amount": "5.04",
  "valor_liquido": "5.04"
}

Erros comuns

Observações:
• Tokens possuem validade curta (ex.: expires_in). Autentique novamente quando expirar.
• O webhook informará as mudanças de status (ex.: COMPLETED, FAILED).

Documentação da API Valorion - Refund

Solicitação de Saques (Pix de Saída)

Endpoint: https://app.valorion.com.br/api/v1/gateway/api/refund/

Descrição

Esse endpoint permite realizar requisições de devolução de PIX por parte do recebedor. O valor pode ser devolvido parcialmente. Em nenhuma hipótese a soma das devoluções podem ultrapassar o valor da transação origem.

Parâmetros da Requisição (JSON)

Exemplo Json de Envio

 
{
  "id": 3125413,
  "external_reference": "e65JzaGhjhyVQDK7TFHENKdasrn5BWO7O"
}

Respostas da API

Sucesso

Código: 200 OK

Corpo: JSON contendo informações sobre a transação e o saldo atualizado.

Erros

Exemplo Json Response

 
{
  "status": "success",
  "message": "Solicitação de devolução enviada com sucesso!",
  "rtrId": "D3038525920250303230647424c88eb2",
  "valor": "0.10",
  "idTransaction": "E00360305202502071525e88da9d19e1"
}

Documentação da API Valorion - Webhook para Transações

Este webhook permite que o sistema receba notificações de transações de depósito e saque via JSON.

Endpoint

https://seuservidor.com/webhook.php

Descrição

Este webhook recebe notificações automáticas para depósitos e saques, fornecendo dados detalhados das transações. No caso de um depósito, o campo paymentCode pode ser usado para gerar um QR Code para pagamento.

Estrutura JSON da Requisição

1. Depósito

2. Saque

Exemplo de Código para Implementação do Webhook

O exemplo a seguir ilustra como configurar o webhook para receber e processar as notificações de transações.

 
// webhook.php
$data = file_get_contents("php://input");
$jsonData = json_decode($data, true);

if ($jsonData) {
    if (isset($jsonData['client_name']) && isset($jsonData['paymentcode'])) {
        $transactionType = 'Depósito';
        $paymentCode = $jsonData['paymentcode']; // QR Code pode ser gerado com este código
    } elseif (isset($jsonData['beneficiaryname']) && isset($jsonData['pixkey'])) {
        $transactionType = 'Saque';
    } else {
        $transactionType = 'Desconhecido';
    }

    echo json_encode(['status' => 'success', 'message' => "$transactionType recebido com sucesso."]);
} else {
    http_response_code(400);
    echo json_encode(['status' => 'error', 'message' => 'Dados inválidos.']);
}

Envio WebHook CashIn

 
{
  "id": "5437946",
  "user_id": "userName",
  "externalreference": "eed9977b-027d-4dd1-87b7-cd4cbde00605",
  "amount": 7,
  "client_name": "Isaias da Fonseca Quintanilha",
  "client_document": "29048225850",
  "client_email": "isaiasquintanilha@gmail.com",
  "data_registro": "2025-11-17 12:55:04",
  "status": "PAID_OUT",
  "idtransaction": "9dec1400-530c-4b31-a659-dc276a020761",
  "paymentcode": "00020101021226820014br.gov.bcb.pix2560qrcode.pagsm.com.br/pix/a424b66b-f69d-4b9d-9f06-d038aec896945204000053039865802BR591455.202.855LTDA6008SaoPaulo62070503***6304B9B7",
  "paymentCodeBase64": "MDAwMjAxMDEwMjEyMjY4MjAwMTRici5nb3YuYmNiLnBpeDI1NjBxcmNvZGUucGFnc20uY29tLmJyL3BpeC9hNDI0YjY2Yi1mNjlkLTRiOWQtOWYwNi1kMDM4YWVjODk2OTQ1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTE0NTUuMjAyLjg1NUxUREE2MDA4U2FvUGF1bG82MjA3MDUwMyoqKjYzMDRCOUI3",
  "deposito_liquido": "6.16",
  "data_med": null,
  "urlcallback": "https://seusite.com/webhook",
  "endToEnd": "E10573521202511171854PqYZrNJIkMg",
  "provider": "syefy"
}

 
{
  "id": "5437946",
  "user_id": "userName",
  "externalreference": "eed9977b-027d-4dd1-87b7-cd4cbde00605",
  "amount": 7,
  "client_name": "Isaias da Fonseca Quintanilha",
  "client_document": "29048225850",
  "client_email": "isaiasquintanilha@gmail.com",
  "data_registro": "2025-11-17 12:55:04",
  "status": "MED",
  "idtransaction": "9dec1400-530c-4b31-a659-dc276a020761",
  "paymentcode": "00020101021226820014br.gov.bcb.pix2560qrcode.pagsm.com.br/pix/a424b66b-f69d-4b9d-9f06-d038aec896945204000053039865802BR591455.202.855LTDA6008SaoPaulo62070503***6304B9B7",
  "paymentCodeBase64": "MDAwMjAxMDEwMjEyMjY4MjAwMTRici5nb3YuYmNiLnBpeDI1NjBxcmNvZGUucGFnc20uY29tLmJyL3BpeC9hNDI0YjY2Yi1mNjlkLTRiOWQtOWYwNi1kMDM4YWVjODk2OTQ1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTE0NTUuMjAyLjg1NUxUREE2MDA4U2FvUGF1bG82MjA3MDUwMyoqKjYzMDRCOUI3",
  "deposito_liquido": "6.16",
  "data_med": null,
  "urlcallback": "https://seusite.com/webhook",
  "endToEnd": "E10573521202511171854PqYZrNJIkMg",
  "provider": "syefy"
}

Envio WebHook CashOut

 
{
  "id": "14517",
  "user_id": "userName",
  "externalreference": "96df6b40-9ecb-4094-83a2-7235832041fb",
  "amount": 10.03,
  "beneficiary_name": "Lucas",
  "beneficiary_document": "12345678900",
  "data_registro": "2025-11-17 12:58:15",
  "status": "COMPLETED",
  "idtransaction": "49696632-51c7-4764-9b8c-966cf3bbd87b",
  "deposito_liquido": "5.03",
  "taxa_cash_out": 5,
  "urlcallback": "https://seusite.com/webhook",
  "provider": "syefy_valorion",
  "kind": "cash_out"
}

 
{
  "id": "14517",
  "user_id": "userName",
  "externalreference": "96df6b40-9ecb-4094-83a2-7235832041fb",
  "amount": 10.03,
  "beneficiary_name": "Lucas",
  "beneficiary_document": "12345678900",
  "data_registro": "2025-11-17 12:58:15",
  "status": "FAILED",
  "idtransaction": "49696632-51c7-4764-9b8c-966cf3bbd87b",
  "deposito_liquido": "5.03",
  "taxa_cash_out": 5,
  "urlcallback": "https://seusite.com/webhook",
  "provider": "syefy_valorion",
  "kind": "cash_out"
}

 
{
  "id": "14517",
  "user_id": "userName",
  "externalreference": "96df6b40-9ecb-4094-83a2-7235832041fb",
  "amount": 10.03,
  "beneficiary_name": "Lucas",
  "beneficiary_document": "12345678900",
  "data_registro": "2025-11-17 12:58:15",
  "status": "CANCELED",
  "idtransaction": "49696632-51c7-4764-9b8c-966cf3bbd87b",
  "deposito_liquido": "5.03",
  "taxa_cash_out": 5,
  "urlcallback": "https://seusite.com/webhook",
  "provider": "syefy_valorion",
  "kind": "cash_out"
}