Criar checkout
curl --request POST \
--url https://api.valorapayments.com.br/v1/checkouts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"product_id": "prod_abc123",
"return_url": "https://meusite.com/obrigado",
"cancel_url": "https://meusite.com/cancelado",
"title": "Plano Premium",
"slug": "plano-premium"
}
'import requests
url = "https://api.valorapayments.com.br/v1/checkouts"
payload = {
"product_id": "prod_abc123",
"return_url": "https://meusite.com/obrigado",
"cancel_url": "https://meusite.com/cancelado",
"title": "Plano Premium",
"slug": "plano-premium"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
product_id: 'prod_abc123',
return_url: 'https://meusite.com/obrigado',
cancel_url: 'https://meusite.com/cancelado',
title: 'Plano Premium',
slug: 'plano-premium'
})
};
fetch('https://api.valorapayments.com.br/v1/checkouts', 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.valorapayments.com.br/v1/checkouts",
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([
'product_id' => 'prod_abc123',
'return_url' => 'https://meusite.com/obrigado',
'cancel_url' => 'https://meusite.com/cancelado',
'title' => 'Plano Premium',
'slug' => 'plano-premium'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.valorapayments.com.br/v1/checkouts"
payload := strings.NewReader("{\n \"product_id\": \"prod_abc123\",\n \"return_url\": \"https://meusite.com/obrigado\",\n \"cancel_url\": \"https://meusite.com/cancelado\",\n \"title\": \"Plano Premium\",\n \"slug\": \"plano-premium\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.valorapayments.com.br/v1/checkouts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"product_id\": \"prod_abc123\",\n \"return_url\": \"https://meusite.com/obrigado\",\n \"cancel_url\": \"https://meusite.com/cancelado\",\n \"title\": \"Plano Premium\",\n \"slug\": \"plano-premium\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valorapayments.com.br/v1/checkouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"product_id\": \"prod_abc123\",\n \"return_url\": \"https://meusite.com/obrigado\",\n \"cancel_url\": \"https://meusite.com/cancelado\",\n \"title\": \"Plano Premium\",\n \"slug\": \"plano-premium\"\n}"
response = http.request(request)
puts response.read_body{
"checkout_id": "chk_a1b2c3d4",
"business_id": "<string>",
"product_id": "<string>",
"slug": "plano-premium-x7a3b2c1",
"title": "<string>",
"return_url": "<string>",
"cancel_url": "<string>",
"metadata": "<string>",
"status": "active",
"created_at": "2023-11-07T05:31:56Z"
}Checkouts
Criar Checkout
Cria um checkout linkado a um produto. O campo slug é gerado automaticamente se não informado. O checkout pode ser compartilhado via URL.
POST
/
v1
/
checkouts
Criar checkout
curl --request POST \
--url https://api.valorapayments.com.br/v1/checkouts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"product_id": "prod_abc123",
"return_url": "https://meusite.com/obrigado",
"cancel_url": "https://meusite.com/cancelado",
"title": "Plano Premium",
"slug": "plano-premium"
}
'import requests
url = "https://api.valorapayments.com.br/v1/checkouts"
payload = {
"product_id": "prod_abc123",
"return_url": "https://meusite.com/obrigado",
"cancel_url": "https://meusite.com/cancelado",
"title": "Plano Premium",
"slug": "plano-premium"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
product_id: 'prod_abc123',
return_url: 'https://meusite.com/obrigado',
cancel_url: 'https://meusite.com/cancelado',
title: 'Plano Premium',
slug: 'plano-premium'
})
};
fetch('https://api.valorapayments.com.br/v1/checkouts', 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.valorapayments.com.br/v1/checkouts",
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([
'product_id' => 'prod_abc123',
'return_url' => 'https://meusite.com/obrigado',
'cancel_url' => 'https://meusite.com/cancelado',
'title' => 'Plano Premium',
'slug' => 'plano-premium'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.valorapayments.com.br/v1/checkouts"
payload := strings.NewReader("{\n \"product_id\": \"prod_abc123\",\n \"return_url\": \"https://meusite.com/obrigado\",\n \"cancel_url\": \"https://meusite.com/cancelado\",\n \"title\": \"Plano Premium\",\n \"slug\": \"plano-premium\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.valorapayments.com.br/v1/checkouts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"product_id\": \"prod_abc123\",\n \"return_url\": \"https://meusite.com/obrigado\",\n \"cancel_url\": \"https://meusite.com/cancelado\",\n \"title\": \"Plano Premium\",\n \"slug\": \"plano-premium\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valorapayments.com.br/v1/checkouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"product_id\": \"prod_abc123\",\n \"return_url\": \"https://meusite.com/obrigado\",\n \"cancel_url\": \"https://meusite.com/cancelado\",\n \"title\": \"Plano Premium\",\n \"slug\": \"plano-premium\"\n}"
response = http.request(request)
puts response.read_body{
"checkout_id": "chk_a1b2c3d4",
"business_id": "<string>",
"product_id": "<string>",
"slug": "plano-premium-x7a3b2c1",
"title": "<string>",
"return_url": "<string>",
"cancel_url": "<string>",
"metadata": "<string>",
"status": "active",
"created_at": "2023-11-07T05:31:56Z"
}Authorizations
Chave de API gerada no painel Valora. Envie em todas as requisições.
Body
application/json
ID do produto cadastrado na Valora
Example:
"prod_abc123"
URL de redirecionamento após pagamento bem-sucedido
URL de redirecionamento após cancelamento
Título exibido na página de checkout
Example:
"Plano Premium"
Slug personalizado para a URL do checkout. Gerado automaticamente se omitido.
Example:
"plano-premium"
JSON serializado com dados extras