Transações do Pagar.me

Lista e consulta as transações de pagamento do checkout: método, valor, status, boleto, PIX e a resposta do gateway.

Uma transação é o registro que o checkout grava quando cria o pedido no gateway: qual foi o método (cartão, boleto ou PIX), quanto, em que status está e o que o Pagar.me respondeu. É a fonte para responder "este pedido foi pago?" e "por que o cartão foi recusado?". Exigem o módulo pagarme e o privilégio manage_payments ou view_payments.

Listar transações

Devolve as transações, das mais novas para as mais antigas, com paginação.

GET/api/v1/admin/pagarme/transactionsAdmin

Lista as transações do Pagar.me

Parâmetros de consulta

order_iduuid

Só as transações deste pedido.

statusstring

pendingpaidfailedrefundedcanceled

Filtra pelo status. Aceita a palavra (refused conta como recusa) ou a letra gravada pela loja.

payment_methodstring

credit_cardboletopix

Filtra pelo método de pagamento.

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 20

Itens por página, de 1 a 100. Fora disso volta para 20.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/pagarme/transactions?status=paid&payment_method=pix&per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Transações devolvidas

json

{
  "transactions": [
    {
      "id": 110,
      "order_id": "6c1b45aa-1acd-4576-95ac-1c684454bd31",
      "pagarme_order_id": "or_zOoLYy3HZf58m1Rj",
      "charge_id": "ch_Z1dxXYKcNWcnw547",
      "payment_method": "pix",
      "status": "paid",
      "amount_cents": 68040,
      "refund_amount_cents": 0,
      "installments": 1,
      "pix_qr_code": "00020126580014br.gov.bcb.pix...",
      "pix_qr_code_url": "https://api.pagar.me/core/v5/transactions/tran_xxx/qrcode?payment_method=pix",
      "pix_expires_at": "2026-07-14T07:50:07Z",
      "created_at": "2026-07-14T06:50:07Z",
      "updated_at": "2026-07-14T06:52:31Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20
}

Campos da resposta

transactionsarray

Transações da página.

totalinteger

Total que casa com os filtros.

pageinteger

Página devolvida.

per_pageinteger

Tamanho de página aplicado.

idinteger

Id interno da transação (número inteiro, não UUID).

order_iduuid

Pedido da plataforma.

pagarme_order_idstring

Id do pedido no gateway (or_...).

charge_idstring

Id da cobrança no gateway (ch_...). É o que o estorno aceita.

payment_methodstring

credit_cardboletopix

Método de pagamento.

statusstring

Status da transação (pending, paid, failed, refunded, canceled...). Em algumas lojas vem como letra.

amount_centsinteger

Valor em centavos.

refund_amount_centsinteger

Quanto já foi estornado, em centavos.

installmentsinteger

Parcelas (1 para boleto e PIX).

card_brandstring

Bandeira do cartão. Só em cartão.

card_last_digitsstring

Últimos 4 dígitos do cartão. Só em cartão.

boleto_urlstring

Endereço do boleto para imprimir. Só em boleto.

boleto_barcodestring

Linha digitável do boleto. Só em boleto.

boleto_due_atstring

Vencimento do boleto, RFC 3339. Só em boleto.

pix_qr_codestring

Código "copia e cola" do PIX. Só em PIX.

pix_qr_code_urlstring

Imagem do QR code. Só em PIX.

pix_expires_atstring

Quando o PIX expira, RFC 3339. Só em PIX.

gateway_responseobject

Resposta completa do gateway. Contém dados pessoais do pagador.

metadataobject

Dados extras gravados pela plataforma, quando houver.

error_messagestring

Motivo da falha, quando a cobrança foi recusada ou deu erro.

created_atstring

Criação, RFC 3339.

updated_atstring

Última alteração, RFC 3339.

Os campos de cartão, boleto e PIX só aparecem no método correspondente.

Erros

Status	Quando	Corpo
401	Sem token	`{"error":"missing authorization header"}`
403	Sem privilégio	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
403	Módulo desligado	`{"error":"module_disabled","module":"pagarme"}`
500	Falha de consulta (inclui `order_id` que não é UUID)	`{"error":"failed to list transactions","detail":"..."}`

Consultar uma transação

GET/api/v1/admin/pagarme/transactions/{id}Admin

Consulta uma transação do Pagar.me

Parâmetros de caminho

idintegerobrigatório

Id interno da transação (número inteiro).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/pagarme/transactions/110" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Transação devolvida

json

{
  "id": 110,
  "order_id": "6c1b45aa-1acd-4576-95ac-1c684454bd31",
  "pagarme_order_id": "or_zOoLYy3HZf58m1Rj",
  "charge_id": "ch_Z1dxXYKcNWcnw547",
  "payment_method": "boleto",
  "status": "pending",
  "amount_cents": 68040,
  "refund_amount_cents": 0,
  "installments": 1,
  "boleto_url": "https://simulator-web-pages-sdx.stone.com.br/boleto/f7125a02",
  "boleto_barcode": "23792.65602 90004.711496 35005.393703 7 74970000003663",
  "boleto_due_at": "2026-07-17T00:00:00Z",
  "created_at": "2026-07-14T06:50:07Z",
  "updated_at": "2026-07-14T06:50:08Z"
}

Exemplo sem gateway_response, que na resposta real é um objeto grande com os dados do gateway. Os campos são os da listagem.

Erros

Status	Quando	Corpo
400	`id` que não é inteiro	`{"error":"invalid transaction id"}`
500	Transação que não existe	`{"error":"failed to get transaction","detail":"pagarme: get transaction 99999: ..."}`

Veja também

API atual/Referência completa/Pagar.me

Transações do Pagar.me

Lista e consulta as transações de pagamento do checkout: método, valor, status, boleto, PIX e a resposta do gateway.

Listar transações

Devolve as transações, das mais novas para as mais antigas, com paginação.

GET/api/v1/admin/pagarme/transactionsAdmin

Lista as transações do Pagar.me

Parâmetros de consulta

order_iduuid

Só as transações deste pedido.

statusstring

pendingpaidfailedrefundedcanceled

Filtra pelo status. Aceita a palavra (refused conta como recusa) ou a letra gravada pela loja.

payment_methodstring

credit_cardboletopix

Filtra pelo método de pagamento.

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 20

Itens por página, de 1 a 100. Fora disso volta para 20.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/pagarme/transactions?status=paid&payment_method=pix&per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Transações devolvidas

json

{
  "transactions": [
    {
      "id": 110,
      "order_id": "6c1b45aa-1acd-4576-95ac-1c684454bd31",
      "pagarme_order_id": "or_zOoLYy3HZf58m1Rj",
      "charge_id": "ch_Z1dxXYKcNWcnw547",
      "payment_method": "pix",
      "status": "paid",
      "amount_cents": 68040,
      "refund_amount_cents": 0,
      "installments": 1,
      "pix_qr_code": "00020126580014br.gov.bcb.pix...",
      "pix_qr_code_url": "https://api.pagar.me/core/v5/transactions/tran_xxx/qrcode?payment_method=pix",
      "pix_expires_at": "2026-07-14T07:50:07Z",
      "created_at": "2026-07-14T06:50:07Z",
      "updated_at": "2026-07-14T06:52:31Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20
}

Campos da resposta

transactionsarray

Transações da página.

totalinteger

Total que casa com os filtros.

pageinteger

Página devolvida.

per_pageinteger

Tamanho de página aplicado.

idinteger

Id interno da transação (número inteiro, não UUID).

order_iduuid

Pedido da plataforma.

pagarme_order_idstring

Id do pedido no gateway (or_...).

charge_idstring

Id da cobrança no gateway (ch_...). É o que o estorno aceita.

payment_methodstring

credit_cardboletopix

Método de pagamento.

statusstring

Status da transação (pending, paid, failed, refunded, canceled...). Em algumas lojas vem como letra.

amount_centsinteger

Valor em centavos.

refund_amount_centsinteger

Quanto já foi estornado, em centavos.

installmentsinteger

Parcelas (1 para boleto e PIX).

card_brandstring

Bandeira do cartão. Só em cartão.

card_last_digitsstring

Últimos 4 dígitos do cartão. Só em cartão.

boleto_urlstring

Endereço do boleto para imprimir. Só em boleto.

boleto_barcodestring

Linha digitável do boleto. Só em boleto.

boleto_due_atstring

Vencimento do boleto, RFC 3339. Só em boleto.

pix_qr_codestring

Código "copia e cola" do PIX. Só em PIX.

pix_qr_code_urlstring

Imagem do QR code. Só em PIX.

pix_expires_atstring

Quando o PIX expira, RFC 3339. Só em PIX.

gateway_responseobject

Resposta completa do gateway. Contém dados pessoais do pagador.

metadataobject

Dados extras gravados pela plataforma, quando houver.

error_messagestring

Motivo da falha, quando a cobrança foi recusada ou deu erro.

created_atstring

Criação, RFC 3339.

updated_atstring

Última alteração, RFC 3339.

Os campos de cartão, boleto e PIX só aparecem no método correspondente.

Erros

Status	Quando	Corpo
401	Sem token	`{"error":"missing authorization header"}`
403	Sem privilégio	`{"error":"insufficient privileges","privilege_required_any":["manage_payments","view_payments"]}`
403	Módulo desligado	`{"error":"module_disabled","module":"pagarme"}`
500	Falha de consulta (inclui `order_id` que não é UUID)	`{"error":"failed to list transactions","detail":"..."}`

Consultar uma transação

GET/api/v1/admin/pagarme/transactions/{id}Admin

Consulta uma transação do Pagar.me

Parâmetros de caminho

idintegerobrigatório

Id interno da transação (número inteiro).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/pagarme/transactions/110" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Transação devolvida

json

{
  "id": 110,
  "order_id": "6c1b45aa-1acd-4576-95ac-1c684454bd31",
  "pagarme_order_id": "or_zOoLYy3HZf58m1Rj",
  "charge_id": "ch_Z1dxXYKcNWcnw547",
  "payment_method": "boleto",
  "status": "pending",
  "amount_cents": 68040,
  "refund_amount_cents": 0,
  "installments": 1,
  "boleto_url": "https://simulator-web-pages-sdx.stone.com.br/boleto/f7125a02",
  "boleto_barcode": "23792.65602 90004.711496 35005.393703 7 74970000003663",
  "boleto_due_at": "2026-07-17T00:00:00Z",
  "created_at": "2026-07-14T06:50:07Z",
  "updated_at": "2026-07-14T06:50:08Z"
}

Exemplo sem gateway_response, que na resposta real é um objeto grande com os dados do gateway. Os campos são os da listagem.

Erros

Status	Quando	Corpo
400	`id` que não é inteiro	`{"error":"invalid transaction id"}`
500	Transação que não existe	`{"error":"failed to get transaction","detail":"pagarme: get transaction 99999: ..."}`