Criar Transação
curl --request POST \
--url https://api.example.com/transactions \
--header 'Content-Type: application/json' \
--data '
{
"api_token": "<string>",
"amount": 123,
"offer_hash": "<string>",
"payment_method": "<string>",
"customer": {
"customer.name": "<string>",
"customer.email": "<string>",
"customer.phone_number": "<string>",
"customer.document": "<string>"
},
"cart": [
{}
],
"installments": 123,
"expire_in_days": 123,
"postback_url": "<string>",
"address": {}
}
'import requests
url = "https://api.example.com/transactions"
payload = {
"api_token": "<string>",
"amount": 123,
"offer_hash": "<string>",
"payment_method": "<string>",
"customer": {
"customer.name": "<string>",
"customer.email": "<string>",
"customer.phone_number": "<string>",
"customer.document": "<string>"
},
"cart": [{}],
"installments": 123,
"expire_in_days": 123,
"postback_url": "<string>",
"address": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
api_token: '<string>',
amount: 123,
offer_hash: '<string>',
payment_method: '<string>',
customer: {
'customer.name': '<string>',
'customer.email': '<string>',
'customer.phone_number': '<string>',
'customer.document': '<string>'
},
cart: [{}],
installments: 123,
expire_in_days: 123,
postback_url: '<string>',
address: {}
})
};
fetch('https://api.example.com/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'api_token' => '<string>',
'amount' => 123,
'offer_hash' => '<string>',
'payment_method' => '<string>',
'customer' => [
'customer.name' => '<string>',
'customer.email' => '<string>',
'customer.phone_number' => '<string>',
'customer.document' => '<string>'
],
'cart' => [
[
]
],
'installments' => 123,
'expire_in_days' => 123,
'postback_url' => '<string>',
'address' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/transactions"
payload := strings.NewReader("{\n \"api_token\": \"<string>\",\n \"amount\": 123,\n \"offer_hash\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"customer\": {\n \"customer.name\": \"<string>\",\n \"customer.email\": \"<string>\",\n \"customer.phone_number\": \"<string>\",\n \"customer.document\": \"<string>\"\n },\n \"cart\": [\n {}\n ],\n \"installments\": 123,\n \"expire_in_days\": 123,\n \"postback_url\": \"<string>\",\n \"address\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/transactions")
.header("Content-Type", "application/json")
.body("{\n \"api_token\": \"<string>\",\n \"amount\": 123,\n \"offer_hash\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"customer\": {\n \"customer.name\": \"<string>\",\n \"customer.email\": \"<string>\",\n \"customer.phone_number\": \"<string>\",\n \"customer.document\": \"<string>\"\n },\n \"cart\": [\n {}\n ],\n \"installments\": 123,\n \"expire_in_days\": 123,\n \"postback_url\": \"<string>\",\n \"address\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"api_token\": \"<string>\",\n \"amount\": 123,\n \"offer_hash\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"customer\": {\n \"customer.name\": \"<string>\",\n \"customer.email\": \"<string>\",\n \"customer.phone_number\": \"<string>\",\n \"customer.document\": \"<string>\"\n },\n \"cart\": [\n {}\n ],\n \"installments\": 123,\n \"expire_in_days\": 123,\n \"postback_url\": \"<string>\",\n \"address\": {}\n}"
response = http.request(request)
puts response.read_body{
"201": {},
"400": {},
"401": {},
"422": {},
"500": {}
}Transações
Criar Transação
Cria uma nova transação de pagamento no sistema KlivoPay
POST
/
transactions
Criar Transação
curl --request POST \
--url https://api.example.com/transactions \
--header 'Content-Type: application/json' \
--data '
{
"api_token": "<string>",
"amount": 123,
"offer_hash": "<string>",
"payment_method": "<string>",
"customer": {
"customer.name": "<string>",
"customer.email": "<string>",
"customer.phone_number": "<string>",
"customer.document": "<string>"
},
"cart": [
{}
],
"installments": 123,
"expire_in_days": 123,
"postback_url": "<string>",
"address": {}
}
'import requests
url = "https://api.example.com/transactions"
payload = {
"api_token": "<string>",
"amount": 123,
"offer_hash": "<string>",
"payment_method": "<string>",
"customer": {
"customer.name": "<string>",
"customer.email": "<string>",
"customer.phone_number": "<string>",
"customer.document": "<string>"
},
"cart": [{}],
"installments": 123,
"expire_in_days": 123,
"postback_url": "<string>",
"address": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
api_token: '<string>',
amount: 123,
offer_hash: '<string>',
payment_method: '<string>',
customer: {
'customer.name': '<string>',
'customer.email': '<string>',
'customer.phone_number': '<string>',
'customer.document': '<string>'
},
cart: [{}],
installments: 123,
expire_in_days: 123,
postback_url: '<string>',
address: {}
})
};
fetch('https://api.example.com/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'api_token' => '<string>',
'amount' => 123,
'offer_hash' => '<string>',
'payment_method' => '<string>',
'customer' => [
'customer.name' => '<string>',
'customer.email' => '<string>',
'customer.phone_number' => '<string>',
'customer.document' => '<string>'
],
'cart' => [
[
]
],
'installments' => 123,
'expire_in_days' => 123,
'postback_url' => '<string>',
'address' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/transactions"
payload := strings.NewReader("{\n \"api_token\": \"<string>\",\n \"amount\": 123,\n \"offer_hash\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"customer\": {\n \"customer.name\": \"<string>\",\n \"customer.email\": \"<string>\",\n \"customer.phone_number\": \"<string>\",\n \"customer.document\": \"<string>\"\n },\n \"cart\": [\n {}\n ],\n \"installments\": 123,\n \"expire_in_days\": 123,\n \"postback_url\": \"<string>\",\n \"address\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/transactions")
.header("Content-Type", "application/json")
.body("{\n \"api_token\": \"<string>\",\n \"amount\": 123,\n \"offer_hash\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"customer\": {\n \"customer.name\": \"<string>\",\n \"customer.email\": \"<string>\",\n \"customer.phone_number\": \"<string>\",\n \"customer.document\": \"<string>\"\n },\n \"cart\": [\n {}\n ],\n \"installments\": 123,\n \"expire_in_days\": 123,\n \"postback_url\": \"<string>\",\n \"address\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"api_token\": \"<string>\",\n \"amount\": 123,\n \"offer_hash\": \"<string>\",\n \"payment_method\": \"<string>\",\n \"customer\": {\n \"customer.name\": \"<string>\",\n \"customer.email\": \"<string>\",\n \"customer.phone_number\": \"<string>\",\n \"customer.document\": \"<string>\"\n },\n \"cart\": [\n {}\n ],\n \"installments\": 123,\n \"expire_in_days\": 123,\n \"postback_url\": \"<string>\",\n \"address\": {}\n}"
response = http.request(request)
puts response.read_body{
"201": {},
"400": {},
"401": {},
"422": {},
"500": {}
}Visão Geral
Uma transação representa uma operação de pagamento no sistema KlivoPay. Cada transação possui um identificador único (hash) e passa por diferentes status durante seu ciclo de vida:pending- Aguardando pagamentopaid- Pagamento confirmadocanceled- Canceladarefunded- Reembolsada
Métodos de Pagamento Suportados
PIX
Pagamento instantâneo via QR Code ou Copia e Cola
Cartão de Crédito
Aprovação imediata com suporte a parcelamento
Boleto Bancário
Pagamento com prazo de vencimento configurável
Endpoint
POST https://api.klivopay.com.br/api/public/v1/transactions
Parâmetros
Obrigatórios
Seu token de autenticação da API KlivoPay
Valor da transação em centavos. Exemplo: R$ 150,00 =
15000Hash identificador da oferta do produto
Método de pagamento:
pix, credit_card ou billetOpcionais
Array de itens do carrinho com detalhes dos produtos
Número de parcelas para cartão de crédito (1 a 12)
Dias para vencimento do boleto (padrão: 3 dias)
URL para receber notificações de mudança de status
Endereço de entrega (opcional para produtos digitais, recomendado para físicos)
Exemplo de Requisição
curl -X POST 'https://api.klivopay.com.br/api/public/v1/transactions' \
-H 'Content-Type: application/json' \
-d '{
"api_token": "seu_token_aqui",
"amount": 15000,
"offer_hash": "abc123def456",
"payment_method": "pix",
"customer": {
"name": "João Silva",
"email": "joao@example.com",
"phone_number": "11987654321",
"document": "12345678900"
},
"cart": [
{
"name": "Produto Exemplo",
"quantity": 1,
"unit_price": 15000
}
]
}'
const response = await fetch('https://api.klivopay.com.br/api/public/v1/transactions', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
api_token: 'seu_token_aqui',
amount: 15000,
offer_hash: 'abc123def456',
payment_method: 'pix',
customer: {
name: 'João Silva',
email: 'joao@example.com',
phone_number: '11987654321',
document: '12345678900'
}
})
});
const data = await response.json();
console.log(data);
import requests
url = 'https://api.klivopay.com.br/api/public/v1/transactions'
payload = {
'api_token': 'seu_token_aqui',
'amount': 15000,
'offer_hash': 'abc123def456',
'payment_method': 'pix',
'customer': {
'name': 'João Silva',
'email': 'joao@example.com',
'phone_number': '11987654321',
'document': '12345678900'
}
}
response = requests.post(url, json=payload)
print(response.json())
<?php
$url = 'https://api.klivopay.com.br/api/public/v1/transactions';
$data = [
'api_token' => 'seu_token_aqui',
'amount' => 15000,
'offer_hash' => 'abc123def456',
'payment_method' => 'pix',
'customer' => [
'name' => 'João Silva',
'email' => 'joao@example.com',
'phone_number' => '11987654321',
'document' => '12345678900'
]
];
$options = [
'http' => [
'header' => "Content-Type: application/json\r\n",
'method' => 'POST',
'content' => json_encode($data)
]
];
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
$response = json_decode($result);
print_r($response);
?>
Resposta de Sucesso
201 Created
{
"success": true,
"data": {
"hash": "abc123def456ghi789",
"status": "pending",
"amount": 15000,
"payment_method": "pix",
"pix_qr_code": "00020126580014br.gov.bcb.pix...",
"pix_copy_paste": "00020126580014br.gov.bcb.pix...",
"created_at": "2025-01-20T10:15:00Z",
"expires_at": "2025-01-20T10:30:00Z"
}
}
Códigos de Resposta
Transação criada com sucesso
Dados inválidos na requisição
Token de API inválido ou ausente
Erro de validação nos dados enviados
Erro interno do servidor
Webhook / Postback
Quando o status da transação mudar, você receberá uma notificação nopostback_url configurado:
{
"transaction_hash": "abc123def456ghi789",
"status": "paid",
"amount": 15000,
"payment_method": "pix",
"paid_at": "2025-01-20T10:20:00Z"
}
Configure o
postback_url para receber atualizações automáticas sobre mudanças no status das transações.⌘I