Skip to content

Comprovante do Saque ​

Gera o comprovante de um saque finalizado como imagem PNG e devolve uma URL temporária para download.

GET /api/withdraws/{id}/receipt ​

Endpoint ​

GET https://api.divipay.com.br/api/withdraws/{id}/receipt

Headers ​

HeaderValorObrigatório
AuthorizationBearerSim

Path Parameters ​

ParâmetroTipoDescrição
idstring (UUID)ID do saque

Query Parameters ​

ParâmetroTipoDescriçãoObrigatório
customerIdstring (UUID)ID da sub-contaNão

Exemplo de Requisição ​

bash
curl -X GET https://api.divipay.com.br/api/withdraws/3b2f09c7-99f0-4a6e-9ea5-6a497bb7f301/receipt \
  -H "Authorization: Bearer SEU_TOKEN"
javascript
const response = await fetch(
  'https://api.divipay.com.br/api/withdraws/3b2f09c7-99f0-4a6e-9ea5-6a497bb7f301/receipt',
  {
    headers: {
      'Authorization': 'Bearer SEU_TOKEN'
    }
  }
);

const { url, expiresAt } = await response.json();

// Baixe a imagem antes de expiresAt
const image = await fetch(url);
python
import requests

response = requests.get(
    'https://api.divipay.com.br/api/withdraws/3b2f09c7-99f0-4a6e-9ea5-6a497bb7f301/receipt',
    headers={
        'Authorization': 'Bearer SEU_TOKEN'
    }
)

receipt = response.json()
image = requests.get(receipt['url']).content

Resposta de Sucesso ​

Status: 200 OK

json
{
  "url": "https://<bucket>.s3.sa-east-1.amazonaws.com/receipts/withdrawals/3b2f09c7-99f0-4a6e-9ea5-6a497bb7f301.png?X-Amz-Expires=300&...",
  "expiresIn": 300,
  "expiresAt": "2024-11-04T16:05:00.000Z"
}
CampoTipoDescrição
urlstringURL do comprovante em PNG
expiresInnumberValidade da URL em segundos (sempre 300)
expiresAtstringData/hora (ISO 8601, UTC) em que a URL deixa de funcionar

VALIDADE DE 5 MINUTOS

A URL expira em 5 minutos. Baixe e guarde a imagem do seu lado; para obter de novo, chame a rota outra vez — cada chamada gera uma URL nova.

O que o comprovante mostra ​

Tipo do saqueTítuloConteúdo
DICT / MANU / QRCODEComprovante de transferência PixValor, data/hora da liquidação, chave Pix, favorecido, conta pagadora e ID da transação (E2E)
INTERNALComprovante de transferênciaValor, data/hora, conta de destino e conta de origem
BILLETComprovante de pagamentoValor pago, data do pagamento, linha digitável, beneficiário e autenticação bancária

Respostas de Erro ​

400 Bad Request ​

O id do saque ou o customerId não é um UUID válido.

json
{
  "statusCode": 400,
  "message": "Validation failed (uuid is expected)",
  "error": "Bad Request"
}

404 Not Found ​

Saque ou sub-conta não encontrados. A mensagem indica qual: Withdraw not found (saque) ou Customer not found (sub-conta).

json
{
  "statusCode": 404,
  "message": "Withdraw not found"
}

409 Conflict ​

O comprovante só existe para saques com status FINISHED.

json
{
  "statusCode": 409,
  "message": "Comprovante disponível apenas para saques finalizados"
}

503 Service Unavailable ​

Falha temporária ao gerar o comprovante. Tente novamente.

json
{
  "statusCode": 503,
  "message": "Não foi possível gerar o comprovante, tente novamente"
}

403 Forbidden ​

Credencial sem a permissão de saques da API.

Próximos Passos ​

Documentação da API DiviPay