Quickstart

Antes de começar, você precisa de:

E-mail validado
2FA ativado
API Key gerada (sk_live_...)

Passo a passo completo: Pré-requisitos

1. Obtenha sua credencial

Faça login no Dashboard e acesse a seção Integrações para gerar uma API Key. A chave (sk_live_...) é exibida uma única vez na criação. Guarde-a em local seguro — ela não pode ser recuperada depois.

2. Autentique-se

Envie a API Key no header x-api-key em todas as requisições:

curl -X POST https://api.linkagateway.com/api/v1/cobranca/transactions \
  -H "x-api-key: sk_live_sua_api_key_aqui" \
  -H "Content-Type: application/json"

const response = await fetch('https://api.linkagateway.com/api/v1/cobranca/transactions', {
  method: 'POST',
  headers: {
    'x-api-key': 'sk_live_sua_api_key_aqui',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(payload),
});

import requests

headers = {
    'x-api-key': 'sk_live_sua_api_key_aqui',
    'Content-Type': 'application/json',
}
response = requests.post('https://api.linkagateway.com/api/v1/cobranca/transactions', headers=headers, json=payload)

const response = await fetch('https://api.linkagateway.com/api/v1/cobranca/transactions', {
  method: 'POST',
  headers: {
    'x-api-key': 'sk_live_sua_api_key_aqui',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(payload),
});

const data = await response.json();

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload := map[string]interface{}{}
	body, _ := json.Marshal(payload)

	req, _ := http.NewRequest("POST", "https://api.linkagateway.com/api/v1/cobranca/transactions", bytes.NewReader(body))
	req.Header.Set("x-api-key", "sk_live_sua_api_key_aqui")
	req.Header.Set("Content-Type", "application/json")

	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

3. Crie uma transação PIX

Os campos amount (centavos), customer e items são obrigatórios. paymentMethod é opcional (padrão PIX). O header Idempotency-Key também é obrigatório na criação. A resposta vem no envelope {status, data} — o objeto da transação fica em data (ex.: data.pix.copyPaste).

curl -X POST https://api.linkagateway.com/api/v1/cobranca/transactions \
  -H "x-api-key: sk_live_sua_api_key_aqui" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
  -d '{
    "amount": 1000,
    "paymentMethod": "PIX",
    "customer": {
      "name": "Joao Silva",
      "email": "[email protected]",
      "phone": "11987654321",
      "document": "12345678900"
    },
    "items": [
      {"title": "Pedido #1001", "amount": 1000, "quantity": 1, "tangible": false}
    ]
  }'

const response = await fetch('https://api.linkagateway.com/api/v1/cobranca/transactions', {
  method: 'POST',
  headers: {
    'x-api-key': 'sk_live_sua_api_key_aqui',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    amount: 1000,
    paymentMethod: 'PIX',
    customer: {
      name: 'Joao Silva',
      email: '[email protected]',
      phone: '11987654321',
      document: '12345678900',
    },
    items: [{ title: 'Pedido #1001', amount: 1000, quantity: 1, tangible: false }],
  }),
});

const { data: transaction } = await response.json(); // resposta vem no envelope { status, data }
console.log(transaction.pix.copyPaste); // Código Copia e Cola para pagamento

import requests, uuid

response = requests.post(
    'https://api.linkagateway.com/api/v1/cobranca/transactions',
    headers={
        'x-api-key': 'sk_live_sua_api_key_aqui',
        'Content-Type': 'application/json',
        'Idempotency-Key': str(uuid.uuid4()),
    },
    json={
        'amount': 1000,
        'paymentMethod': 'PIX',
        'customer': {
            'name': 'Joao Silva',
            'email': '[email protected]',
            'phone': '11987654321',
            'document': '12345678900',
        },
        'items': [{'title': 'Pedido #1001', 'amount': 1000, 'quantity': 1, 'tangible': False}],
    },
)

transaction = response.json()['data']  # resposta vem no envelope { status, data }
print(transaction['pix']['copyPaste'])  # Código Copia e Cola

interface CreateTransactionResponse {
  status: boolean;
  data: {
    id: string;
    amount: number;
    paymentMethod: string;
    status: string;
    pix?: { qrCode: string; copyPaste: string; expiresAt: string };
  };
}

const response = await fetch('https://api.linkagateway.com/api/v1/cobranca/transactions', {
  method: 'POST',
  headers: {
    'x-api-key': 'sk_live_sua_api_key_aqui',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    amount: 1000,
    paymentMethod: 'PIX',
    customer: {
      name: 'Joao Silva',
      email: '[email protected]',
      phone: '11987654321',
      document: '12345678900',
    },
    items: [{ title: 'Pedido #1001', amount: 1000, quantity: 1, tangible: false }],
  }),
});

const { data: transaction }: CreateTransactionResponse = await response.json();
console.log(transaction.pix?.copyPaste);

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	payload := map[string]interface{}{
		"amount":        1000,
		"paymentMethod": "PIX",
		"customer": map[string]string{
			"name":     "Joao Silva",
			"email":    "[email protected]",
			"phone":    "11987654321",
			"document": "12345678900",
		},
		"items": []map[string]interface{}{
			{"title": "Pedido #1001", "amount": 1000, "quantity": 1, "tangible": false},
		},
	}
	body, _ := json.Marshal(payload)

	req, _ := http.NewRequest("POST", "https://api.linkagateway.com/api/v1/cobranca/transactions", bytes.NewReader(body))
	req.Header.Set("x-api-key", "sk_live_sua_api_key_aqui")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Idempotency-Key", "550e8400-e29b-41d4-a716-446655440000")

	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()

	var result map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&result)
	fmt.Println(result)
}

Resposta

{
  "status": true,
  "data": {
    "id": "txn_uuid_aqui",
    "amount": 1000,
    "paymentMethod": "PIX",
    "status": "PENDING",
    "createdAt": "2026-04-11T14:30:00.000Z",
    "pix": {
      "qrCode": "data:image/png;base64,...",
      "copyPaste": "00020126580014br.gov.bcb.pix...",
      "expiresAt": "2026-04-11T15:30:00.000Z"
    }
  }
}

4. Configure um webhook

Cadastre uma URL para receber notificações quando o pagamento for confirmado. O campo eventType define a categoria de eventos: TRANSACTION, WITHDRAWAL, DISPUTE ou ALL.

curl -X POST https://api.linkagateway.com/v1/webhooks \
  -H "x-api-key: sk_live_sua_api_key_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://seusite.com/webhooks/linka",
    "eventType": "TRANSACTION"
  }'

const response = await fetch('https://api.linkagateway.com/v1/webhooks', {
  method: 'POST',
  headers: {
    'x-api-key': 'sk_live_sua_api_key_aqui',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: 'https://seusite.com/webhooks/linka',
    eventType: 'TRANSACTION',
  }),
});

const webhook = await response.json();
// webhook.secret é exibido APENAS nesta resposta — guarde para validar assinaturas

const response = await fetch('https://api.linkagateway.com/v1/webhooks', {
  method: 'POST',
  headers: {
    'x-api-key': 'sk_live_sua_api_key_aqui',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: 'https://seusite.com/webhooks/linka',
    eventType: 'TRANSACTION',
  }),
});

const webhook = await response.json();
// webhook.secret é exibido APENAS nesta resposta — guarde para validar assinaturas

import requests

response = requests.post(
    'https://api.linkagateway.com/v1/webhooks',
    headers={
        'x-api-key': 'sk_live_sua_api_key_aqui',
        'Content-Type': 'application/json',
    },
    json={
        'url': 'https://seusite.com/webhooks/linka',
        'eventType': 'TRANSACTION',
    },
)

webhook = response.json()
# webhook['secret'] é exibido APENAS nesta resposta — guarde para validar assinaturas

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	payload := map[string]interface{}{
		"url":       "https://seusite.com/webhooks/linka",
		"eventType": "TRANSACTION",
	}
	body, _ := json.Marshal(payload)

	req, _ := http.NewRequest("POST", "https://api.linkagateway.com/v1/webhooks", bytes.NewReader(body))
	req.Header.Set("x-api-key", "sk_live_sua_api_key_aqui")
	req.Header.Set("Content-Type", "application/json")

	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()

	var result map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&result)
	fmt.Println(result)
}

O secret do webhook aparece apenas na resposta da criação. Guarde-o para validar as assinaturas dos eventos recebidos.

5. Receba a confirmação

Quando o cliente pagar o PIX, sua URL receberá um POST com o evento. Os campos do recurso vêm no nível raiz do JSON (não aninhados em data), junto com eventType e signature:

{
  "version": "1",
  "expires_at": "2026-04-12T14:31:00.000Z",
  "eventType": "TRANSACTION_PAID",
  "signature": "v1=K7gNU3sdo-OL0wNhqoVWhr3g6s1xYv72ol_pe_Unols",
  "id": "clxyz1234abcdef",
  "amount": 1000,
  "method": "PIX",
  "status": "PAID",
  "paidAt": "2026-04-11T14:31:00.000Z",
  "customer": {
    "name": "Joao Silva",
    "email": "j***@email.com"
  }
}

Valide a assinatura usando o campo signature do body e o header X-Webhook-Timestamp. Veja o passo a passo completo em Webhooks.

Próximos passos

Autenticação

Como obter e usar sua API Key

Idempotência

Evite cobranças duplicadas

Guia PIX

Fluxo completo de PIX recebimento

Status de transação

Máquina de estados completa

Visao Geral

Onboarding

Guias

Referencia

Quickstart

Quickstart

1. Obtenha sua credencial

2. Autentique-se

3. Crie uma transação PIX

Resposta

4. Configure um webhook

5. Receba a confirmação

Próximos passos

Autenticação

Idempotência

Guia PIX

Status de transação

​Quickstart

​1. Obtenha sua credencial

​2. Autentique-se

​3. Crie uma transação PIX

​Resposta

​4. Configure um webhook

​5. Receba a confirmação

​Próximos passos

Autenticação

Idempotência

Guia PIX

Status de transação

Quickstart

1. Obtenha sua credencial

2. Autentique-se

3. Crie uma transação PIX

Resposta

4. Configure um webhook

5. Receba a confirmação

Próximos passos