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

Consultar saques

Lista os Pix enviados pela conta e consulta um saque pelo id.

GET/payouts

Lista paginada de saques.

Query

CampoTipoDescrição
statusopcionalstringpending, processing, completed, failed ou refunded.
referenceopcionalstringA sua reference (valor exato).
tracking_idopcionalstringCódigo de rastreio do Pix (valor exato).
nameopcionalstringParte do nome do destinatário.
keyopcionalstringParte da chave Pix de destino.
date_fromopcionalstringData inicial (YYYY-MM-DD).
date_toopcionalstringData final (YYYY-MM-DD).
amount_minopcionalnumberValor mínimo.
amount_maxopcionalnumberValor máximo.
pageopcionalintegerPágina, a partir de 1.
per_pageopcionalintegerItens por página, de 1 a 100 (padrão 20).
Requisição
curl -X GET "https://api.sancopay.com/api/v1/payouts?status=completed&date_from=2026-11-01" \  -H "Authorization: Bearer <TOKEN>"
Resposta200 OK
{  "data": [    {      "id": 912,      "tracking_id": "9b7f3c2e-41d8-4a6e-b0c5-2f1e8d7a6c90",      "reference": "SAQUE-0001",      "status": "completed",      "amount": 250,      "fee": 1,      "total": 251,      "pix": {        "type": "email",        "key": "[email protected]",        "masked_key": "jo***@exemplo.com"      },      "recipient": {        "name": "JOAO PEREIRA",        "tax_id": "***.654.321-**",        "bank": "Banco Exemplo S.A."      },      "end_to_end_id": "E00000000202611091504a9b8c7d6e5f",      "pre_approval_id": null,      "metadata": {        "invoice": "NF-778"      },      "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  }}

Pela reference ou pelo tracking_id

Use a mesma lista com o filtro reference ou tracking_id. A resposta é uma lista (vazia quando nada bate); com uma reference única por saque, ela traz no máximo um item.

Requisição
curl -X GET "https://api.sancopay.com/api/v1/payouts?reference=SAQUE-0001" \  -H "Authorization: Bearer <TOKEN>"

Consultar um saque

GET/payouts/{id}

Consulta um saque pelo id da SancoPay.

Parâmetros da URL

CampoTipoDescrição
idobrigatóriointegerO id devolvido no envio (também em data.id dos webhooks payout.*).
Requisição
curl -X GET "https://api.sancopay.com/api/v1/payouts/912" \  -H "Authorization: Bearer <TOKEN>"
Resposta
{  "id": 912,  "tracking_id": "9b7f3c2e-41d8-4a6e-b0c5-2f1e8d7a6c90",  "reference": "SAQUE-0001",  "status": "completed",  "amount": 250,  "fee": 1,  "total": 251,  "pix": {    "type": "email",    "key": "[email protected]",    "masked_key": "jo***@exemplo.com"  },  "recipient": {    "name": "JOAO PEREIRA",    "tax_id": "***.654.321-**",    "bank": "Banco Exemplo S.A."  },  "end_to_end_id": "E00000000202611091504a9b8c7d6e5f",  "pre_approval_id": null,  "metadata": {    "invoice": "NF-778"  },  "failure_reason": null,  "created_at": "2026-11-09T15:04:05.000000Z",  "updated_at": "2026-11-09T15:04:41.000000Z"}