Comprovante

Utilize este endpoint para consultar o comprovante de um depósito pelo id.

Ambientes Disponíveis

Produção

https://api.gateway.com.br

Endpoint

• Método: POST
• Endpoint: /deposit/{id}/receipt
• Autenticação: Bearer token

Path Params

Nome	Tipo	Obrigatório	Descrição	Validações
id	string (UUID)	Sim	Identificador do depósito	Deve ser UUID válido

Exemplo de Requisição

cURL

curl --request POST \
--url https://api.gateway.com.br/deposit/553e8400-e29b-41d4-a716-436251480000/receipt \
--header 'Authorization: Bearer seu-token-jwt'

JavaScript

const response = await fetch('https://api.gateway.com.br/deposit/553e8400-e29b-41d4-a716-436251480000/receipt', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer seu-token-jwt'
  }
});

const data = await response.json();

Resposta de Sucesso

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador do depósito
paymentReceiptUrl	string	Sim	URL para download/visualização do comprovante
expirationDate	string (ISO)	Não	Data de expiração do comprovante

Exemplo de Resposta

{
  "id": "553e8400-e29b-41d4-a716-436251480000",
  "paymentReceiptUrl": "https://files.exemplo.com.br/receipts/deposit-553e8400-e29b-41d4-a716-436251480000.pdf",
  "expirationDate": "2026-04-01T00:00:00.000Z"
}

Possíveis Erros

Código	Descrição	Solução
401	Credenciais inválidas	Verifique suas credenciais
403	Sem permissão/autorização	Contate o suporte
404	Depósito/comprovante não encontrado	Verifique o id informado
422	Dados inválidos ou faltando	Verifique o formato dos dados
500	Erro interno	Contate o suporte