Iniciar pagamento via PIX
curl --request POST \
--url https://api.vertracloud.app/v1/orders/{orderId}/initiate/pix \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/orders/{orderId}/initiate/pix', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vertracloud.app/v1/orders/{orderId}/initiate/pix"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/orders/{orderId}/initiate/pix"
req, _ := http.NewRequest("POST", 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))
}{
"response": {
"transaction_amount": 24.9,
"external_reference": "order-abc123",
"txid": "9c2b1e3a-...-000",
"expires_at": "2026-10-13T15:30:00.000Z",
"qrcode": {
"copy": "00020126...6304ABCD",
"base64": "iVBORw0KGgoAAAANSUhEUgAA..."
}
}
}
Cobrança
Iniciar pagamento via PIX
Gera a cobrança PIX (QR code) de um pedido não pago.
POST
/
v1
/
orders
/
{orderId}
/
initiate
/
pix
Iniciar pagamento via PIX
curl --request POST \
--url https://api.vertracloud.app/v1/orders/{orderId}/initiate/pix \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/orders/{orderId}/initiate/pix', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vertracloud.app/v1/orders/{orderId}/initiate/pix"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/orders/{orderId}/initiate/pix"
req, _ := http.NewRequest("POST", 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))
}{
"response": {
"transaction_amount": 24.9,
"external_reference": "order-abc123",
"txid": "9c2b1e3a-...-000",
"expires_at": "2026-10-13T15:30:00.000Z",
"qrcode": {
"copy": "00020126...6304ABCD",
"base64": "iVBORw0KGgoAAAANSUhEUgAA..."
}
}
}
string
obrigatório
O ID do pedido.
expires_at), nunca além da expiração do próprio pedido.
Chamar de novo enquanto o QR code ainda é válido retorna o mesmo. Depois que ele expira,
chamar de novo enquanto o pedido ainda está aberto retorna um novo QR code para o mesmo pedido.
Resposta
object
Mostrar Mostrar objeto
Mostrar Mostrar objeto
number
O valor da cobrança, em BRL.
string | null
O ID do pedido, devolvido como a referência externa do pagamento.
string
O ID da transação PIX.
string | null
Quando este QR code deixa de ser pagável, em ISO 8601 (até 30 minutos depois de gerado, nunca depois da expiração do pedido).
{
"response": {
"transaction_amount": 24.9,
"external_reference": "order-abc123",
"txid": "9c2b1e3a-...-000",
"expires_at": "2026-10-13T15:30:00.000Z",
"qrcode": {
"copy": "00020126...6304ABCD",
"base64": "iVBORw0KGgoAAAANSUhEUgAA..."
}
}
}
Respostas de erro
string
O código de erro que indica o motivo da falha. Valores possíveis:
AUTH_TOKEN_MISSING,API_KEY_INVALID,SESSION_REVOKED: o headerAuthorizationestá ausente, a chave de API é inválida ou a sessão do painel foi revogada (401).API_KEY_IP_DENIED,API_KEY_SCOPE_DENIED: a chave de API é usada a partir de um IP fora da sua allowlist, ou não tem o escopo que a rota exige (403).USER_NOT_FOUND: o usuário autenticado não foi encontrado.ORDER_NOT_FOUND: o pedido informado não existe.FORBIDDEN: o pedido não pertence ao usuário autenticado.ORDER_NOT_PAYABLE: o pedido já está pago, cancelado ou expirou (400), ou um pagamento com cartão do pedido ainda está sendo confirmado (409).COUPON_PAYMENT_METHOD: o cupom do pedido não permite PIX.PAYMENT_METHOD_UNAVAILABLE: o pagamento online está temporariamente indisponível.INVALID_PARAMS: oorderIdestá malformado.RATE_LIMIT_EXCEEDED: outro pagamento da conta está sendo iniciado. Tente de novo em instantes.INTERNAL_SERVER_ERROR: ocorreu um erro inesperado no servidor.
{
"code": "ORDER_NOT_PAYABLE"
}
Última modificação em 28 de outubro de 2026