Consultar checkout
curl --request GET \
--url https://api.ephra.io/v1/checkouts/{checkoutId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ephra.io/v1/checkouts/{checkoutId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ephra.io/v1/checkouts/{checkoutId}', 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.ephra.io/v1/checkouts/{checkoutId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ephra.io/v1/checkouts/{checkoutId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ephra.io/v1/checkouts/{checkoutId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ephra.io/v1/checkouts/{checkoutId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "clx9f1m2p0004qz0a7h8j9k0l",
"version": "v2",
"checkoutName": "Checkout principal",
"productId": "clx8a2h4k0001qz0a1b2c3d4e",
"active": true,
"slug": "trafego-pago-2026",
"isDefault": null,
"model": null,
"billingType": "one_time",
"acceptMethod": [
"pix",
"credit_card"
],
"preferredPaymentMethod": "pix",
"maxInstallments": 12,
"defaultOfferId": 4821,
"preDefinedInstallmentEnabled": true,
"preDefinedInstallmentValue": 12,
"collectBuyerAddress": false,
"askBuyerInstagram": false,
"enableAddressAutofill": true,
"collectInstagram": false,
"upsellEnabled": true,
"upsellRedirectUrl": "https://exemplo.com.br/obrigado",
"imageUrl": "https://images.ephra.io/checkouts/clx9f1m2p0004qz0a7h8j9k0l.jpg",
"marketLanguage": "pt-BR",
"invoiceName": "EPHRA*TRAFEGO",
"billetExpireTime": 3,
"allowedDoubleCard": true,
"allowedCardPix": false,
"allowedSmartInstallment": true,
"createdAt": "2026-09-02T10:15:00.000Z",
"updatedAt": "2026-09-11T17:40:00.000Z"
}
}{
"success": false,
"message": "Token inválido ou expirado"
}{
"success": false,
"message": "Checkout não encontrado"
}{
"success": false,
"message": "name: Nome é obrigatório"
}{
"success": false,
"message": "Muitas requisições. Tente novamente em breve."
}{
"success": false,
"message": "Erro interno do servidor"
}Checkout
Consultar checkout
Devolve a configuração completa de um checkout da empresa autenticada — meios de pagamento, parcelamento, campos do formulário e aparência —, para editar no seu próprio painel ou pré-visualizar antes de divulgar. Responde 404 quando o checkout não existe, foi excluído ou pertence a outra empresa.
GET
/
v1
/
checkouts
/
{checkoutId}
Consultar checkout
curl --request GET \
--url https://api.ephra.io/v1/checkouts/{checkoutId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ephra.io/v1/checkouts/{checkoutId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ephra.io/v1/checkouts/{checkoutId}', 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.ephra.io/v1/checkouts/{checkoutId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ephra.io/v1/checkouts/{checkoutId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ephra.io/v1/checkouts/{checkoutId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ephra.io/v1/checkouts/{checkoutId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "clx9f1m2p0004qz0a7h8j9k0l",
"version": "v2",
"checkoutName": "Checkout principal",
"productId": "clx8a2h4k0001qz0a1b2c3d4e",
"active": true,
"slug": "trafego-pago-2026",
"isDefault": null,
"model": null,
"billingType": "one_time",
"acceptMethod": [
"pix",
"credit_card"
],
"preferredPaymentMethod": "pix",
"maxInstallments": 12,
"defaultOfferId": 4821,
"preDefinedInstallmentEnabled": true,
"preDefinedInstallmentValue": 12,
"collectBuyerAddress": false,
"askBuyerInstagram": false,
"enableAddressAutofill": true,
"collectInstagram": false,
"upsellEnabled": true,
"upsellRedirectUrl": "https://exemplo.com.br/obrigado",
"imageUrl": "https://images.ephra.io/checkouts/clx9f1m2p0004qz0a7h8j9k0l.jpg",
"marketLanguage": "pt-BR",
"invoiceName": "EPHRA*TRAFEGO",
"billetExpireTime": 3,
"allowedDoubleCard": true,
"allowedCardPix": false,
"allowedSmartInstallment": true,
"createdAt": "2026-09-02T10:15:00.000Z",
"updatedAt": "2026-09-11T17:40:00.000Z"
}
}{
"success": false,
"message": "Token inválido ou expirado"
}{
"success": false,
"message": "Checkout não encontrado"
}{
"success": false,
"message": "name: Nome é obrigatório"
}{
"success": false,
"message": "Muitas requisições. Tente novamente em breve."
}{
"success": false,
"message": "Erro interno do servidor"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identificador do checkout.
Minimum string length:
1⌘I
