Buscar Deposito

Utilize este endpoint para buscar um deposito específica pelo id.

Ambientes Disponíveis

Produção

https://api.gateway.com.br/core

Endpoint

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

Path Params

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

Exemplo de Requisição

cURL

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

JavaScript

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

Resposta de Sucesso

Campo	Tipo	Obrigatório	Descrição
id	string (UUID)	Sim	Identificador único do deposito
acquirerCode	string	Não	Código do adquirente
acquirer	string	Sim	Adquirente do deposito
amount	number	Sim	Valor do deposito (inteiro em centavos)
paymentMethod	string (enum) - PIX	Sim	Método de pagamento
webhookUrl	string	Não	URL de webhook configurada
externalCode	string	Não	Seu código de referência
paymentReceipt	object	Não	Comprovante de pagamento (ver Sub-Objeto PaymentReceiptUrl)
refundReceipt	object	Não	Comprovante de estorno (ver Sub-Objeto PaymentReceiptUrl)
createdAt	string (ISO)	Sim	Data de criação
status	string (enum) - PENDING, PIX_QRCODE_GENERATED, PAID, PROCESSING_REFUND, PROCESSING_INFRACTION, REFUNDED, INFRACTION, FAILED, BLOCKED, DEPOSIT_PIXKEY_GENERATED, PENDING_COMPLIANCE	Sim	PENDING: Deposito criada, aguardando processamento PIX_QRCODE_GENERATED: QRCode PIX gerada, aguardando pagamento PAID: Deposito paga PROCESSING_REFUND: Estorno em processamento PROCESSING_INFRACTION: Infração em processamento REFUNDED: Deposito estornada INFRACTION: Deposito estornada(MED) FAILED: Error no processamento BLOCKED: Bloqueado devido abertura de MED DEPOSIT_PIXKEY_GENERATED: Deposito gerada via chave PIX PENDING_COMPLIANCE: Deposito pendente de análise de compliance
statusHistory	array	Sim	Histórico de status (ver Sub-Objeto StatusHistory)
updatedAt	string (ISO)	Sim	Data da última atualização
amountPaid	number	Não	Valor efetivamente pago (inteiro em centavos)
paymentDate	string (ISO)	Não	Data de pagamento
refundDate	string (ISO)	Não	Data do estorno
refundAmount	number	Não	Valor do estorno (inteiro em centavos)
pixResponse	object	Sim (se paymentMethod for PIX)	Dados do PIX (ver Sub-Objeto PixResponse)
errorMessage	string	Não	Mensagem de erro
errorMessageRefund	string	Não	Mensagem de erro do estorno
endToEnd	string	Não	Identificador end-to-end do deposito
endToEndRefund	string	Não	Identificador end-to-end do estorno
payer	object	Não	Dados do pagador (ver Sub-Objeto AccountHolder)
receiver	object	Não	Dados do recebedor (ver Sub-Objeto AccountHolder)
feeAmount	number	Não	Valor da taxa
depositOrigin	string (enum) - QRCODE, PIX_KEY	Sim	Origem do deposito

Sub-Objetos

StatusHistory (item)

Campo	Tipo	Obrigatório	Descrição
status	string (enum) - PENDING, PIX_QRCODE_GENERATED, PAID, PROCESSING_REFUND, PROCESSING_INFRACTION, REFUNDED, INFRACTION, FAILED, BLOCKED, DEPOSIT_PIXKEY_GENERATED, PENDING_COMPLIANCE	Sim	Status do deposito
date	string (ISO)	Sim	Data do status
durationInMilliseconds	number	Sim	Duração do status em milissegundos

PixResponse

Campo	Tipo	Obrigatório	Descrição
uri	string	Sim	Copia e cola do QRCode
qrCodeBase64	string	Sim	Imagem do QRCode
expirationDate	string	Sim	Data de expiração do QRCode

AccountHolder

Campo	Tipo	Obrigatório	Descrição
type	string (enum) - PF, PJ	Sim	Tipo do titular
name	string	Sim	Nome do titular
document	string	Sim	Documento do titular
bankAccount	object	Sim	Dados bancários (ver Sub-Objeto BankAccount)
pix	object	Sim	Chave PIX do titular (ver Sub-Objeto PixKeyVo)

BankAccount

Campo	Tipo	Obrigatório	Descrição
type	string	Sim	Tipo de conta
digit	string	Sim	Dígito da conta
ispb	string	Sim	ISPB do banco

PaymentReceiptUrl

Campo	Tipo	Obrigatório	Descrição
url	string	Sim	URL do comprovante
expirationDate	string (ISO)	Sim	Data de expiração do comprovante

Exemplo de Resposta

Dados mascarados

Valores sensiveis podem estar mascarados com ***.

{
  "id": "553e8400-e29b-41d4-a716-436251480000",
  "acquirerCode": "ACQ-123",
  "acquirer": "ACQUIRER_EXEMPLO",
  "amount": 500,
  "paymentMethod": "PIX",
  "webhookUrl": "https://sua-api.com/webhooks/deposit",
  "externalCode": "DEPOSIT-123",
  "paymentReceipt": {
    "url": "https://files.exemplo.com.br/receipts/deposit-553e8400-e29b-41d4-a716-436251480000.pdf",
    "expirationDate": "2026-04-01T00:00:00.000Z"
  },
  "refundReceipt": {
    "url": "https://files.exemplo.com.br/receipts/deposit-refund-553e8400-e29b-41d4-a716-436251480000.pdf",
    "expirationDate": "2026-04-01T00:00:00.000Z"
  },
  "createdAt": "2026-03-06T12:49:04.681Z",
  "status": "REFUNDED",
  "statusHistory": [
    {
      "status": "PENDING",
      "date": "2026-03-06T12:49:04.681Z",
      "durationInMilliseconds": 1000
    },
    {
      "status": "PIX_QRCODE_GENERATED",
      "date": "2026-03-06T12:49:04.681Z",
      "durationInMilliseconds": 10000
    },
    {
      "status": "PAID",
      "date": "2026-03-06T12:49:04.681Z",
      "durationInMilliseconds": 10000
    },
    {
      "status": "REFUNDED",
      "date": "2026-03-06T12:49:04.681Z",
      "durationInMilliseconds": 5000
    }
  ],
  "updatedAt": "2026-03-06T12:49:04.681Z",
  "amountPaid": 500,
  "paymentDate": "2026-03-06T12:49:04.681Z",
  "refundDate": "2026-03-06T12:49:04.681Z",
  "refundAmount": 500,
  "pixResponse": {
    "uri": "00020126580014br.gov.bcb.pix0136123e4567-e89b-12d3-a456-426614174000",
    "qrCodeBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "expirationDate": "2026-03-06T12:49:04.681Z"
  },
  "errorMessage": null,
  "errorMessageRefund": null,
  "endToEnd": "0123456789",
  "endToEndRefund": "0123456789-REFUND",
  "payer": {
    "type": "PF",
    "name": "Fulano de Tal",
    "document": "***456789**",
    "bankAccount": {
      "type": "CHECKING",
      "digit": "7",
      "ispb": "12345678"
    },
    "pix": {
      "key": "12345678910",
      "type": "CPF"
    }
  },
  "receiver": {
    "type": "PJ",
    "name": "Empresa Exemplo LTDA",
    "document": "12345678000199",
    "bankAccount": {
      "type": "CHECKING",
      "digit": "0",
      "ispb": "12345678"
    },
    "pix": {
      "key": "contato@exemplo.com",
      "type": "EMAIL"
    }
  },
  "feeAmount": 150,
  "depositOrigin": "QRCODE"
}

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	Registro não encontrado	Verifique o id informado
422	Dados inválidos ou faltando	Verifique o formato dos dados
422	Validações	Contate o suporte
500	Erro interno	Contate o suporte