API atual/Referência completa/Gateways de pagamento

Pagar.me: consultar cobranças

Lê uma cobrança pelo id ou a mais recente de um pedido.

Duas consultas públicas ao que foi cobrado no Pagar.me. Para a tela de confirmação do pedido, a segunda é a que importa: ela recupera o boleto ou o QR Code do Pix só com o orderID.

Consultar cobrança

Devolve uma cobrança criada por Cobrança Pagar.me (versão antiga), pelo id dela. Cobranças criadas por /pagarme/charge não estão nesta tabela; para elas use a consulta por pedido.

GET/api/v1/storefront/pagarme/charges/{id}Pública

Cobrança da rota antiga, pelo id da plataforma

Parâmetros de caminho

iduuidobrigatório

Id da cobrança na plataforma (campo id da criação).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/pagarme/charges/5e8d2f4a-1b3c-4d6e-8f9a-0b1c2d3e4f5a"

Resposta

200Cobrança

json

{
  "id": "5e8d2f4a-1b3c-4d6e-8f9a-0b1c2d3e4f5a",
  "order_id": "3f73310d-bfdd-4713-a664-305c08eda58b",
  "pagarme_id": "ch_Kx9QzR2mVn3LdY7a",
  "payment_method": "boleto",
  "status": "pending",
  "amount": 22500,
  "boleto_pdf": "https://api.pagar.me/core/v5/transactions/tran_xxxx/pdf",
  "boleto_barcode": "34191.79001 01043.510047 91020.150008 8 99990000022500",
  "boleto_expiry": "2026-10-14T23:59:59Z",
  "created_at": "2026-10-11T15:02:11Z",
  "updated_at": "2026-10-11T15:02:11Z"
}

Campos da resposta

(corpo)object

Os campos descritos em Cobrança Pagar.me (versão antiga).

Erros

Status	Quando	Corpo de exemplo
403	O módulo `pagarme` está desligado nesta loja.	`{"error":"module_disabled","module":"pagarme"}`
404	Cobrança inexistente.	`{"error":"charge not found"}`
500	`id` que não é um UUID válido, ou falha de leitura.	`{"error":"failed to get charge","detail":"..."}`

Devolve a cobrança mais recente do pedido. É a rota da página de confirmação, que precisa recarregar o PDF e a linha digitável do boleto ou o QR Code do Pix sem ter guardado nada. Procura primeiro nas cobranças de Cobrar no Pagar.me e, se não achar, na tabela antiga.

GET/api/v1/storefront/pagarme/charges/order/{orderID}Pública

A cobrança Pagar.me mais recente de um pedido

Parâmetros de caminho

orderIDuuidobrigatório

Id do pedido.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/pagarme/charges/order/3f73310d-bfdd-4713-a664-305c08eda58b"

Resposta

200Cobrança do pedido

json

{
  "id": 15,
  "order_id": "3f73310d-bfdd-4713-a664-305c08eda58b",
  "pagarme_order_id": "or_3JvQ8xYk2m5NdR7a",
  "charge_id": "ch_Kx9QzR2mVn3LdY7a",
  "payment_method": "pix",
  "status": "paid",
  "amount_cents": 22500,
  "refund_amount_cents": 0,
  "installments": 1,
  "pix_qr_code": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890520400005303986540522.505802BR5913MINHA LOJA6009SAO PAULO62070503***6304ABCD",
  "pix_qr_code_url": "https://api.pagar.me/core/v5/transactions/tran_P4sT8wZc1uHeB6nM/qrcode?payment_method=pix",
  "pix_expires_at": "2026-10-11T15:32:11Z",
  "created_at": "2026-10-11T15:02:11Z",
  "updated_at": "2026-10-11T15:04:40Z"
}

Campos da resposta

idinteger

Id interno da cobrança (número).

order_iduuid

O pedido.

pagarme_order_id, charge_idstring

Ids no Pagar.me (or_..., ch_...).

payment_methodstring

credit_cardboletopix

Forma usada.

statusstring

Estado conforme o Pagar.me (pending, paid, failed...).

amount_centsinteger

Valor, em centavos.

refund_amount_centsinteger

Já reembolsado, em centavos.

installmentsinteger

Parcelas.

card_brand, card_last_digitsstring

Só cartão.

boleto_url, boleto_barcode, boleto_due_atstring

Só boleto: PDF, linha digitável e vencimento.

pix_qr_code, pix_qr_code_url, pix_expires_atstring

Só Pix: copia e cola, imagem do QR e validade.

error_messagestring

Erro do gateway, quando houver.

gateway_response, metadataobject

Dados brutos do gateway e da plataforma. Não dependa do formato.

created_at, updated_atstring

Datas (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
403	O módulo `pagarme` está desligado nesta loja.	`{"error":"module_disabled","module":"pagarme"}`
404	Nenhuma cobrança Pagar.me para o pedido.	`{"error":"no charge found for order"}`
500	`orderID` que não é um UUID válido, ou falha de leitura.	`{"error":"failed to get charge by order","detail":"..."}`

Veja também

API atual/Referência completa/Gateways de pagamento

Pagar.me: consultar cobranças

Lê uma cobrança pelo id ou a mais recente de um pedido.

Duas consultas públicas ao que foi cobrado no Pagar.me. Para a tela de confirmação do pedido, a segunda é a que importa: ela recupera o boleto ou o QR Code do Pix só com o orderID.

Consultar cobrança

Devolve uma cobrança criada por Cobrança Pagar.me (versão antiga), pelo id dela. Cobranças criadas por /pagarme/charge não estão nesta tabela; para elas use a consulta por pedido.

GET/api/v1/storefront/pagarme/charges/{id}Pública

Cobrança da rota antiga, pelo id da plataforma

Parâmetros de caminho

iduuidobrigatório

Id da cobrança na plataforma (campo id da criação).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/pagarme/charges/5e8d2f4a-1b3c-4d6e-8f9a-0b1c2d3e4f5a"

Resposta

200Cobrança

json

{
  "id": "5e8d2f4a-1b3c-4d6e-8f9a-0b1c2d3e4f5a",
  "order_id": "3f73310d-bfdd-4713-a664-305c08eda58b",
  "pagarme_id": "ch_Kx9QzR2mVn3LdY7a",
  "payment_method": "boleto",
  "status": "pending",
  "amount": 22500,
  "boleto_pdf": "https://api.pagar.me/core/v5/transactions/tran_xxxx/pdf",
  "boleto_barcode": "34191.79001 01043.510047 91020.150008 8 99990000022500",
  "boleto_expiry": "2026-10-14T23:59:59Z",
  "created_at": "2026-10-11T15:02:11Z",
  "updated_at": "2026-10-11T15:02:11Z"
}

Campos da resposta

(corpo)object

Os campos descritos em Cobrança Pagar.me (versão antiga).

Erros

Status	Quando	Corpo de exemplo
403	O módulo `pagarme` está desligado nesta loja.	`{"error":"module_disabled","module":"pagarme"}`
404	Cobrança inexistente.	`{"error":"charge not found"}`
500	`id` que não é um UUID válido, ou falha de leitura.	`{"error":"failed to get charge","detail":"..."}`

Cobrança de um pedido

GET/api/v1/storefront/pagarme/charges/order/{orderID}Pública

A cobrança Pagar.me mais recente de um pedido

Parâmetros de caminho

orderIDuuidobrigatório

Id do pedido.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/pagarme/charges/order/3f73310d-bfdd-4713-a664-305c08eda58b"

Resposta

200Cobrança do pedido

json

{
  "id": 15,
  "order_id": "3f73310d-bfdd-4713-a664-305c08eda58b",
  "pagarme_order_id": "or_3JvQ8xYk2m5NdR7a",
  "charge_id": "ch_Kx9QzR2mVn3LdY7a",
  "payment_method": "pix",
  "status": "paid",
  "amount_cents": 22500,
  "refund_amount_cents": 0,
  "installments": 1,
  "pix_qr_code": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890520400005303986540522.505802BR5913MINHA LOJA6009SAO PAULO62070503***6304ABCD",
  "pix_qr_code_url": "https://api.pagar.me/core/v5/transactions/tran_P4sT8wZc1uHeB6nM/qrcode?payment_method=pix",
  "pix_expires_at": "2026-10-11T15:32:11Z",
  "created_at": "2026-10-11T15:02:11Z",
  "updated_at": "2026-10-11T15:04:40Z"
}

Campos da resposta

idinteger

Id interno da cobrança (número).

order_iduuid

O pedido.

pagarme_order_id, charge_idstring

Ids no Pagar.me (or_..., ch_...).

payment_methodstring

credit_cardboletopix

Forma usada.

statusstring

Estado conforme o Pagar.me (pending, paid, failed...).

amount_centsinteger

Valor, em centavos.

refund_amount_centsinteger

Já reembolsado, em centavos.

installmentsinteger

Parcelas.

card_brand, card_last_digitsstring

Só cartão.

boleto_url, boleto_barcode, boleto_due_atstring

Só boleto: PDF, linha digitável e vencimento.

pix_qr_code, pix_qr_code_url, pix_expires_atstring

Só Pix: copia e cola, imagem do QR e validade.

error_messagestring

Erro do gateway, quando houver.

gateway_response, metadataobject

Dados brutos do gateway e da plataforma. Não dependa do formato.

created_at, updated_atstring

Datas (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
403	O módulo `pagarme` está desligado nesta loja.	`{"error":"module_disabled","module":"pagarme"}`
404	Nenhuma cobrança Pagar.me para o pedido.	`{"error":"no charge found for order"}`
500	`orderID` que não é um UUID válido, ou falha de leitura.	`{"error":"failed to get charge by order","detail":"..."}`