Docs
EntrarCriar conta
Ambiente
Base URLhttps://api.sancopay.com/api/v1
Arquivo para IA
Cobranças Pix

Consultar cobrança

Busca uma cobrança pelo id da SancoPay. Para achar pela sua reference ou pelo tracking_id, use os filtros exatos da lista.

GET/charges/{id}

Consulta uma cobrança pelo id.

Parâmetros da URL

CampoTipoDescrição
idobrigatóriointegerO id devolvido na criação.
Requisição
curl -X GET "https://api.sancopay.com/api/v1/charges/4821" \  -H "Authorization: Bearer <TOKEN>"
Resposta
{  "id": 4821,  "tracking_id": "c62abd1d-9092-4892-b163-cef2951912ad",  "reference": "PED-123",  "status": "paid",  "amount": 150,  "fee": 1.5,  "message": "Pedido #123",  "customer": {    "name": "Maria Souza",    "email": "[email protected]",    "tax_id": "12345678909"  },  "pix": {    "copy_paste": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d65204000053039865406150.005802BR5913LOJA EXEMPLO6009SAO PAULO62070503***6304A1B2"  },  "end_to_end_id": "E18236120202611091504s0a1b2c3d4e",  "metadata": {    "order_id": "123",    "coupon": "OFF10"  },  "failure_reason": null,  "created_at": "2026-11-09T15:04:05.000000Z",  "updated_at": "2026-11-09T15:04:41.000000Z"}

Pela reference ou pelo tracking_id

GET/charges

A lista com o filtro reference ou tracking_id.

Requisição
curl -X GET "https://api.sancopay.com/api/v1/charges?reference=PED-123" \  -H "Authorization: Bearer <TOKEN>"
Resposta

A cobrança vem em data[0].

{  "data": [    {      "id": 4821,      "tracking_id": "c62abd1d-9092-4892-b163-cef2951912ad",      "reference": "PED-123",      "status": "paid",      "amount": 150,      "fee": 1.5,      "message": "Pedido #123",      "customer": {        "name": "Maria Souza",        "email": "[email protected]",        "tax_id": "12345678909"      },      "pix": {        "copy_paste": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d65204000053039865406150.005802BR5913LOJA EXEMPLO6009SAO PAULO62070503***6304A1B2"      },      "end_to_end_id": "E18236120202611091504s0a1b2c3d4e",      "metadata": {        "order_id": "123",        "coupon": "OFF10"      },      "failure_reason": null,      "created_at": "2026-11-09T15:04:05.000000Z",      "updated_at": "2026-11-09T15:04:41.000000Z"    }  ],  "meta": {    "page": 1,    "per_page": 20,    "total": 1,    "last_page": 1  }}
  • Os dois filtros são exatos: o valor precisa ser igual ao da cobrança, sem busca parcial.
  • A resposta é sempre uma lista. Com uma reference única por pedido, ela traz no máximo um item.