DOCUMENTAÇÃO API

Introdução

Bem-vindo à API da VenturePay, sua solução completa para integração de pagamentos PIX. Nossa API foi projetada para ser intuitiva, robusta e segura, permitindo que você integre facilmente funcionalidades de pagamento em suas aplicações.

Segurança

Segurança Avançada

Proteção de dados e criptografia em todas as transações

Performance

Alta Performance

Resposta rápida e processamento eficiente

Integração

Fácil Integração

Documentação clara e exemplos práticos

AUTENTICAÇÃO

Começando com a API

Todas as requisições à API precisam ser autenticadas usando um token no cabeçalho HTTP. Obtenha seu token na área do desenvolvedor.

Configuração do Token

cURL 

curl -X POST https://venturepay.com.br/api/endpoint \
-H "Authorization: seu_token_aqui" \
-H "Content-Type: application/json"
PHP 

$token = 'seu_token_aqui';

$headers = [
    'Authorization: ' . $token,
    'Content-Type: application/json'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://venturepay.com.br/api/endpoint");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
Python 

import requests

headers = {
    'Authorization': 'seu_token_aqui',
    'Content-Type': 'application/json'
}

response = requests.post(
    'https://venturepay.com.br/api/endpoint',
    headers=headers
)
JavaScript 

const headers = {
    'Authorization': 'seu_token_aqui',
    'Content-Type': 'application/json'
};

fetch('https://venturepay.com.br/api/endpoint', {
    method: 'POST',
    headers: headers
})
.then(response => response.json())
.then(data => console.log(data));
POST

Criar Transação PIX

https://venturepay.com.br/sandbox/api/create/transaction/

Parâmetros da Requisição

Parâmetro Tipo Descrição
amount Obrigatório Integer Valor em centavos
nome Obrigatório String Nome do cliente
cpf Obrigatório String CPF do cliente (apenas números)
email Obrigatório String Email do cliente
number_phone Obrigatório String Número de telefone (apenas números)
area_code Obrigatório String DDD do telefone
id_split Opcional String Chave Pública da conta para split
value_split Opcional String Porcentagem do split
cURL 

curl -X POST https://venturepay.com.br/sandbox/api/create/transaction/ \
-H "Authorization: seu_token_aqui" \
-H "Content-Type: application/json" \
-d '{
    "amount": 100,
    "nome": "Lucas Caslini",
    "cpf": "55555555555",
    "email": "exemplo@gmail.com",
    "number_phone": "999999999",
    "area_code": "11",
    "id_split": "Chp3lkB8IHfpMJXmG3zC",
    "value_split": "20"
}'
PHP 

$data = [
    'amount' => 100,
    'nome' => 'Lucas Caslini',
    'cpf' => '55555555555',
    'email' => 'exemplo@gmail.com',
    'number_phone' => '999999999',
    'area_code' => '11',
    'id_split' => 'Chp3lkB8IHfpMJXmG3zC',
    'value_split' => '20'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://venturepay.com.br/sandbox/api/create/transaction/");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: seu_token_aqui',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$result = json_decode($response, true);
Python 

import requests
import json

url = "https://venturepay.com.br/sandbox/api/create/transaction/"
headers = {
    'Authorization': 'seu_token_aqui',
    'Content-Type': 'application/json'
}
data = {
    'amount': 100,
    'nome': 'Lucas Caslini',
    'cpf': '55555555555',
    'email': 'exemplo@gmail.com',
    'number_phone': '999999999',
    'area_code': '11',
    'id_split': 'Chp3lkB8IHfpMJXmG3zC',
    'value_split': '20'
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
JavaScript 

const data = {
    amount: 100,
    nome: 'Lucas Caslini',
    cpf: '55555555555',
    email: 'exemplo@gmail.com',
    number_phone: '999999999',
    area_code: '11',
    id_split: 'Chp3lkB8IHfpMJXmG3zC',
    value_split: '20'
};

fetch('https://venturepay.com.br/sandbox/api/create/transaction/', {
    method: 'POST',
    headers: {
        'Authorization': 'seu_token_aqui',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => console.log(result));

Exemplo de Resposta

JSON 

{
    "id": "or_66fd8f69e7a7b",
    "code": "B3063E24",
    "amount": 100,
    "currency": "BRL",
    "customer": {
        "name": "Lucas Caslini",
        "email": "exemplo@gmail.com",
        "type": "individual",
        "document": "55555555555",
        "phones": {
            "home_phone": {
                "country_code": "55",
                "number": "999999999",
                "area_code": "11"
            }
        }
    },
    "status": "pending",
    "created_at": "2024-10-02 15:22:33",
    "updated_at": "2024-10-02 15:22:33",
    "closed_at": null,
    "last_transaction": {
        "qr_code": "00020101021226820014br.gov.bcb.pix2560pix.stone.com.br/pix/v2/5ecedb73-aa54-42cc-bc28-eccc2d55202e52040000530398654041.005802BR5924VENTUREPAV SISTEMAS LTDA6014RIO DE JANEIRO622905251665d0b241091d6308181632b6304D8CE",
        "expires_at": "2024-10-03 15:22:33",
        "qr_code_url": "https://api.qrserver.com/v1/create-qr-code/?data=00020101021226820014br.gov.bcb.pix2560pix.stone.com.br/pix/v2/5ecedb73-aa54-42cc-bc28-eccc2d55202e52040000530398654041.005802BR5924VENTUREPAV SISTEMAS LTDA6014RIO DE JANEIRO622905251665d0b241091d6308181632b6304D8CE"
    }
}
POST

Consultar Status da Transação

https://venturepay.com.br/sandbox/api/get/transaction/

Parâmetros da Requisição

Parâmetro Tipo Descrição
id_transaction Obrigatório String ID da transação gerado na criação
cURL 

curl -X POST https://venturepay.com.br/sandbox/api/get/transaction/ \
-H "Authorization: seu_token_aqui" \
-H "Content-Type: application/json" \
-d '{
    "id_transaction": "GATETECH00000367865079ASA"
}'
PHP 

$data = [
    'id_transaction' => 'GATETECH00000367865079ASA'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://venturepay.com.br/sandbox/api/get/transaction/");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: seu_token_aqui',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$result = json_decode($response, true);
Python 

import requests

url = "https://venturepay.com.br/sandbox/api/get/transaction/"
headers = {
    'Authorization': 'seu_token_aqui',
    'Content-Type': 'application/json'
}
data = {
    'id_transaction': 'GATETECH00000367865079ASA'
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
JavaScript 

const data = {
    id_transaction: 'GATETECH00000367865079ASA'
};

fetch('https://venturepay.com.br/sandbox/api/get/transaction/', {
    method: 'POST',
    headers: {
        'Authorization': 'seu_token_aqui',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => console.log(result));

Exemplo de Resposta (Transação Pendente)

JSON 

{
    "id": "GATETECH00000367865079ASA",
    "code": "24PA7KSL93",
    "amount": 100,
    "currency": "BRL",
    "customer": "{\"id\":\"cus_djxEBdOf9flWA0J1\",\"name\":\"NOME FICTICIO\",\"email\":\"emailficition@exemplo.com\",\"document\":\"999999999\",\"document_type\":\"cpf\",\"type\":\"individual\",\"delinquent\":false,\"created_at\":\"2024-03-06T06:59:06Z\",\"updated_at\":\"2024-04-15T20:30:21Z\",\"phones\":{\"home_phone\":{\"country_code\":\"55\",\"number\":\"9999999999\",\"area_code\":\"11\"},\"mobile_phone\":{\"country_code\":\"55\",\"number\":\"9999999999\",\"area_code\":\"11\"}}}",
    "status": "pending",
    "created_at": "2024-04-15 20:30:21",
    "updated_at": "2024-04-15 20:30:22",
    "closed_at": "2024-04-15 20:30:21",
    "qr_code": "00020101021226820014br.gov.bcb.pix2560pix.stone.com.br/pix/v2/5ecedb73-aa54-42cc-bc28-eccc2d55202e52040000530398654041.005802BR5924VENTUREPAV SISTEMAS LTDA6014RIO DE JANEIRO622905251665d0b241091d6308181632b6304D8CE",
    "qr_code_url": "https://api.qrserver.com/v1/create-qr-code/?data=00020101021226820014br.gov.bcb.pix2560pix.stone.com.br/pix/v2/5ecedb73-aa54-42cc-bc28-eccc2d55202e52040000530398654041.005802BR5924VENTUREPAV SISTEMAS LTDA6014RIO DE JANEIRO622905251665d0b241091d6308181632b6304D8CE",
    "expires_at": "2025-12-10 06:20:34",
    "owner_email": "exemplodonodatransacao@gmail.com"
}
POST

Registrar Webhook

https://venturepay.com.br/api/webhook/transaction/
⚠️
Importante: Não existe ambiente de sandbox para webhooks. Configure com cautela em produção.

Parâmetros da Requisição

Parâmetro Tipo Descrição
url Obrigatório String URL para receber as notificações webhook
cURL 

curl -X POST https://venturepay.com.br/api/webhook/transaction/ \
-H "Authorization: seu_token_aqui" \
-H "Content-Type: application/json" \
-d '{
    "url": "https://exemplo.com.br/webhook"
}'
PHP 

$data = [
    'url' => 'https://exemplo.com.br/webhook'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://venturepay.com.br/api/webhook/transaction/");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: seu_token_aqui',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$result = json_decode($response, true);
Python 

import requests

url = "https://venturepay.com.br/api/webhook/transaction/"
headers = {
    'Authorization': 'seu_token_aqui',
    'Content-Type': 'application/json'
}
data = {
    'url': 'https://exemplo.com.br/webhook'
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
JavaScript 

const data = {
    url: 'https://exemplo.com.br/webhook'
};

fetch('https://venturepay.com.br/api/webhook/transaction/', {
    method: 'POST',
    headers: {
        'Authorization': 'seu_token_aqui',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => console.log(result));

Exemplo de Resposta

JSON 

{
    "message": "Webhook registrada com sucesso."
}
POST

Realizar Pagamento PIX

https://venturepay.com.br/api/pay/transaction/
⚠️
Importante: Configure o webhook para rejeitar todas as transações durante o desenvolvimento, pois não há ambiente de sandbox para esta operação.

Parâmetros da Requisição

Parâmetro Tipo Descrição
chave Obrigatório String Chave PIX do destinatário
tipo Obrigatório String Tipo da chave (CPF/EMAIL/EVP)
value Obrigatório Number Valor em reais (ex: 50.00)
cURL 

curl -X POST https://venturepay.com.br/api/pay/transaction/ \
-H "Authorization: seu_token_aqui" \
-H "Content-Type: application/json" \
-d '{
    "chave": "99999999999",
    "tipo": "CPF",
    "value": 50.00
}'
PHP 

$data = [
    'chave' => '99999999999',
    'tipo' => 'CPF',
    'value' => 50.00
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://venturepay.com.br/api/pay/transaction/");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: seu_token_aqui',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$result = json_decode($response, true);
Python 

import requests

url = "https://venturepay.com.br/api/pay/transaction/"
headers = {
    'Authorization': 'seu_token_aqui',
    'Content-Type': 'application/json'
}
data = {
    'chave': '99999999999',
    'tipo': 'CPF',
    'value': 50.00
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
JavaScript 

const data = {
    chave: '99999999999',
    tipo: 'CPF',
    value: 50.00
};

fetch('https://venturepay.com.br/api/pay/transaction/', {
    method: 'POST',
    headers: {
        'Authorization': 'seu_token_aqui',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => console.log(result));

Exemplo de Resposta

JSON 

{
    "status": "success",
    "transaction_id": "txn_66fd80cf0b0423.11544421",
    "url": "https://exemplo.com.br/webhook/",
    "transaction_status": "pending_authorization",
    "authentication": {
        "status": "authenticated",
        "message": "Autenticação aprovada, transação enviada.",
        "body": {
            "chave": "99999999999",
            "tipo": "CPF",
            "value": 50.00
        }
    }
}
ERROS

Códigos de Erro

Lista de possíveis códigos de erro retornados pela API.

400

Bad Request

Requisição inválida ou mal formatada

401

Unauthorized

Autenticação falhou ou token inválido

404

Not Found

Recurso não encontrado

500

Server Error

Erro interno do servidor

Exemplo de Resposta de Erro

JSON 

{
    "error": "Descrição detalhada do erro"
}