Pular para o conteúdo principal
GET
/
transactions
/
{id}
Buscar transação por ID
curl --request GET \
  --url https://api.pague.dev/v1/transactions/{id} \
  --header 'X-API-Key: <x-api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "type": "payment",
  "paymentMethod": "pix",
  "amount": 150.75,
  "currency": "BRL",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "externalReference": "pedido-12345",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {
    "orderId": "12345",
    "source": "website"
  },
  "pixCopyPaste": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "expiresAt": "2023-11-07T05:31:56Z",
  "paidAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Cabeçalhos

​
X-API-Key
string
obrigatório

Chave de API de integração (pd_live_* para produção, pd_test_* para sandbox)

Parâmetros de caminho

​
id
string<uuid>
obrigatório

ID da transação

Resposta

Detalhes da transação

​
id
string<uuid>
obrigatório

ID da transação

​
status
enum<string>
obrigatório

Status da transação

Opções disponíveis:
pending,
completed,
failed,
cancelled
​
type
enum<string>
obrigatório

Tipo da transação

Opções disponíveis:
payment,
fee,
refund,
chargeback,
withdrawal
​
paymentMethod
enum<string>
obrigatório

Método de pagamento utilizado

Opções disponíveis:
pix,
credit_card,
boleto
​
amount
number
obrigatório

Valor em BRL

Exemplo:

150.75

​
currency
string
obrigatório

Código da moeda

Exemplo:

"BRL"

​
createdAt
string<date-time>
obrigatório

Data de criação

​
description
string

Descrição da transação

​
externalReference
string

Seu ID de referência externa

Exemplo:

"pedido-12345"

​
customerId
string<uuid>

ID do cliente

​
projectId
string<uuid>

ID do projeto

​
metadata
object

Metadados personalizados (pares chave-valor)

Exemplo:
{ "orderId": "12345", "source": "website" }
​
pixCopyPaste
string

Código PIX copia e cola (apenas para transações PIX pendentes)

Exemplo:

"00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
expiresAt
string<date-time>

Data de expiração (apenas para transações pendentes)

​
paidAt
string<date-time>

Data em que a transação foi paga

​
updatedAt
string<date-time>

Data de atualização