Criar checkout Pix

cURL

curl -X POST https://api-test.troqpay.com/v1/checkouts \
  -H "Authorization: Bearer trq_test_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order_1001" \
  -d '{
    "amount": 12990,
    "description": "Plano Pro",
    "externalId": "order_1001",
    "expiresIn": 1800,
    "customer": {
      "name": "Maria Silva",
      "email": "maria@example.com"
    },
    "metadata": {
      "plan": "pro"
    }
  }'

const response = await fetch("https://api-test.troqpay.com/v1/checkouts", {
  method: "POST",
  headers: {
    "Authorization": "Bearer trq_test_xxx",
    "Content-Type": "application/json",
    "Idempotency-Key": "order_1001"
  },
  body: JSON.stringify({
    amount: 12990,
    description: "Plano Pro",
    externalId: "order_1001",
    expiresIn: 1800,
    customer: { name: "Maria Silva", email: "maria@example.com" },
    metadata: { plan: "pro" }
  })
});

const checkout = await response.json();

import requests

url = "https://api-test.troqpay.com/v1/checkouts"

payload = {
    "amount": 12990,
    "description": "Plano Pro",
    "externalId": "order_1001",
    "expiresIn": 1800,
    "customer": {
        "name": "Maria Silva",
        "email": "maria@example.com"
    },
    "metadata": { "plan": "pro" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-test.troqpay.com/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([
    'amount' => 12990,
    'description' => 'Plano Pro',
    'externalId' => 'order_1001',
    'expiresIn' => 1800,
    'customer' => [
        'name' => 'Maria Silva',
        'email' => 'maria@example.com'
    ],
    'metadata' => [
        'plan' => 'pro'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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-test.troqpay.com/v1/checkouts"

	payload := strings.NewReader("{\n  \"amount\": 12990,\n  \"description\": \"Plano Pro\",\n  \"externalId\": \"order_1001\",\n  \"expiresIn\": 1800,\n  \"customer\": {\n    \"name\": \"Maria Silva\",\n    \"email\": \"maria@example.com\"\n  },\n  \"metadata\": {\n    \"plan\": \"pro\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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-test.troqpay.com/v1/checkouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 12990,\n  \"description\": \"Plano Pro\",\n  \"externalId\": \"order_1001\",\n  \"expiresIn\": 1800,\n  \"customer\": {\n    \"name\": \"Maria Silva\",\n    \"email\": \"maria@example.com\"\n  },\n  \"metadata\": {\n    \"plan\": \"pro\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-test.troqpay.com/v1/checkouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 12990,\n  \"description\": \"Plano Pro\",\n  \"externalId\": \"order_1001\",\n  \"expiresIn\": 1800,\n  \"customer\": {\n    \"name\": \"Maria Silva\",\n    \"email\": \"maria@example.com\"\n  },\n  \"metadata\": {\n    \"plan\": \"pro\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "chk_4a8b3c1d5e6f2a9b0c1d",
  "livemode": false,
  "status": "PENDING",
  "amount": 12990,
  "currency": "BRL",
  "checkoutUrl": "https://pay-test.troqpay.com/pay/chk_4a8b3c1d5e6f2a9b0c1d",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "pix": {
    "copyPaste": "00020101021226840014br.gov.bcb.pix...",
    "qrCodeUrl": "https://api.openpix.com.br/openpix/charge/brcode/image/chk_4a8b3c1d5e6f2a9b0c1d.png"
  },
  "settlement": {
    "currency": "BRL",
    "status": "PENDING",
    "amount": "129.90"
  },
  "metadata": {},
  "description": "Plano Pro",
  "externalId": "order_1001",
  "paidAt": "2023-11-07T05:31:56Z",
  "customer": {
    "name": "Maria Silva",
    "email": "maria@example.com",
    "document": "12345678900"
  }
}

POST

checkouts

cURL

curl -X POST https://api-test.troqpay.com/v1/checkouts \
  -H "Authorization: Bearer trq_test_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order_1001" \
  -d '{
    "amount": 12990,
    "description": "Plano Pro",
    "externalId": "order_1001",
    "expiresIn": 1800,
    "customer": {
      "name": "Maria Silva",
      "email": "maria@example.com"
    },
    "metadata": {
      "plan": "pro"
    }
  }'

const response = await fetch("https://api-test.troqpay.com/v1/checkouts", {
  method: "POST",
  headers: {
    "Authorization": "Bearer trq_test_xxx",
    "Content-Type": "application/json",
    "Idempotency-Key": "order_1001"
  },
  body: JSON.stringify({
    amount: 12990,
    description: "Plano Pro",
    externalId: "order_1001",
    expiresIn: 1800,
    customer: { name: "Maria Silva", email: "maria@example.com" },
    metadata: { plan: "pro" }
  })
});

const checkout = await response.json();

import requests

url = "https://api-test.troqpay.com/v1/checkouts"

payload = {
    "amount": 12990,
    "description": "Plano Pro",
    "externalId": "order_1001",
    "expiresIn": 1800,
    "customer": {
        "name": "Maria Silva",
        "email": "maria@example.com"
    },
    "metadata": { "plan": "pro" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-test.troqpay.com/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([
    'amount' => 12990,
    'description' => 'Plano Pro',
    'externalId' => 'order_1001',
    'expiresIn' => 1800,
    'customer' => [
        'name' => 'Maria Silva',
        'email' => 'maria@example.com'
    ],
    'metadata' => [
        'plan' => 'pro'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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-test.troqpay.com/v1/checkouts"

	payload := strings.NewReader("{\n  \"amount\": 12990,\n  \"description\": \"Plano Pro\",\n  \"externalId\": \"order_1001\",\n  \"expiresIn\": 1800,\n  \"customer\": {\n    \"name\": \"Maria Silva\",\n    \"email\": \"maria@example.com\"\n  },\n  \"metadata\": {\n    \"plan\": \"pro\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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-test.troqpay.com/v1/checkouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 12990,\n  \"description\": \"Plano Pro\",\n  \"externalId\": \"order_1001\",\n  \"expiresIn\": 1800,\n  \"customer\": {\n    \"name\": \"Maria Silva\",\n    \"email\": \"maria@example.com\"\n  },\n  \"metadata\": {\n    \"plan\": \"pro\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-test.troqpay.com/v1/checkouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 12990,\n  \"description\": \"Plano Pro\",\n  \"externalId\": \"order_1001\",\n  \"expiresIn\": 1800,\n  \"customer\": {\n    \"name\": \"Maria Silva\",\n    \"email\": \"maria@example.com\"\n  },\n  \"metadata\": {\n    \"plan\": \"pro\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "chk_4a8b3c1d5e6f2a9b0c1d",
  "livemode": false,
  "status": "PENDING",
  "amount": 12990,
  "currency": "BRL",
  "checkoutUrl": "https://pay-test.troqpay.com/pay/chk_4a8b3c1d5e6f2a9b0c1d",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "pix": {
    "copyPaste": "00020101021226840014br.gov.bcb.pix...",
    "qrCodeUrl": "https://api.openpix.com.br/openpix/charge/brcode/image/chk_4a8b3c1d5e6f2a9b0c1d.png"
  },
  "settlement": {
    "currency": "BRL",
    "status": "PENDING",
    "amount": "129.90"
  },
  "metadata": {},
  "description": "Plano Pro",
  "externalId": "order_1001",
  "paidAt": "2023-11-07T05:31:56Z",
  "customer": {
    "name": "Maria Silva",
    "email": "maria@example.com",
    "document": "12345678900"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

Chave de idempotência opcional. A API normaliza o corpo da requisição com uma serialização JSON estável e key-sorted, então reordenar chaves equivale ao mesmo corpo. O valor é trimado; uma string vazia após o trim equivale a não enviar a chave (sem erro, mas sem deduplicação). A chave permanece associada ao recurso indefinidamente — não há expiração. Primeira criação devolve 201; reentrega idempotente devolve 200.

Example:

"order_1001"

Request-Id

string

Identificador opcional fornecido pelo cliente para correlação. A API aceita também X-Request-Id. O valor é ecoado de volta no header de resposta Request-Id. Se nenhum dos dois é enviado, a API gera req_<24 hex>.

Example:

"req_4a8b3c1d5e6f2a9b0c1d2e3f"

Body

application/json

Payload para criação de um checkout Pix.

amount

integer

required

Valor em centavos de BRL. Mínimo de 100 centavos (R$ 1,00).

Required range: x >= 100

Example:

12990

currency

enum<string>

default:BRL

Moeda da cobrança. Hoje, sempre BRL.

Available options:

BRL

description

string

Texto livre de 1 a 255 caracteres para identificar a cobrança.

Required string length: 1 - 255

Example:

"Plano Pro"

externalId

string

Identificador do pedido no seu sistema, 1 a 255 caracteres.

Required string length: 1 - 255

Example:

"order_1001"

expiresIn

integer

default:1800

Tempo de expiração da cobrança em segundos. Entre 900 e 86400. O padrão é 1800 (30 minutos).

Required range: 900 <= x <= 86400

Example:

1800

customer

object

Dados do comprador no envio do checkout. Quando enviado, é obrigatório informar name e pelo menos um de email, document ou phone.

Show child attributes

metadata

object

Pares chave-valor livres. Apenas valores string são aceitos.

Show child attributes

Example:

{ "plan": "pro" }

Response

Resposta idempotente: a mesma Idempotency-Key foi usada com o mesmo corpo. A API devolve o checkout já existente em vez de criar um novo.

Objeto principal da API de cobranças. Reúne os dados da cobrança Pix, do pagamento e da liquidação.

string

required

Identificador técnico do checkout. Formato chk_ + 20 caracteres hex.

Example:

"chk_4a8b3c1d5e6f2a9b0c1d"

livemode

boolean

required

true para chaves trq_live_; false para trq_test_.

Example:

false

status

enum<string>

required

Estado atual da cobrança.

Available options:

PENDING,

PAID,

REFUNDED,

EXPIRED,

CANCELLED

amount

integer

required

Valor da cobrança em centavos de BRL.

Example:

12990

currency

enum<string>

required

Moeda da cobrança. Hoje, sempre BRL.

Available options:

BRL

Example:

"BRL"

checkoutUrl

string<uri>

required

URL canônica do checkout hospedado pela TroqPay (/pay/{checkoutId}).

Example:

"https://pay-test.troqpay.com/pay/chk_4a8b3c1d5e6f2a9b0c1d"

createdAt

string<date-time>

required

Quando o checkout foi criado.

expiresAt

string<date-time>

required

Quando o checkout expira (se ainda não foi pago).

pix

object

required

Dados necessários para exibir o Pix ao comprador.

Show child attributes

settlement

object

required

Dados da liquidação do checkout, em BRL.

Show child attributes

metadata

object

required

Os pares chave-valor que você enviou. Pode ser {} se nenhum foi enviado.

Show child attributes

description

string | null

O texto livre que você enviou na criação.

Example:

"Plano Pro"

externalId

string | null

O ID do pedido no seu sistema.

Example:

"order_1001"

paidAt

string<date-time> | null

Preenchido quando status muda para PAID.

customer

object | null

Dados do comprador. O campo phone aceito no envio não é retornado aqui.

Show child attributes

Status

Checkouts

Payment Links

Saldo

Saques

Webhooks

Authorizations

Headers

Body

Response