Skip to main content
GET
/
v4
/
i
/
baas
/
pix
/
payments
/
{accountId}
/
{endToEndId}
curl -X GET https://api.owem.com.br/v4/i/baas/pix/payments/123456789012/E5470000120260113123456789012345 \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)"
{
  "requestId": "o695q2r0-4s19-889r-2sro-87t239rp2os8",
  "success": true,
  "size": 1,
  "data": {
    "endToEndId": "E5470000120260113123456789012345",
    "status": "succeeded",
    "type": "pix_out",
    "reason": "pix_out:emv_pay",
    "amount": 100.0,
    "externalId": "pagamento-001",
    "payer": {
      "name": "JOAO DA SILVA",
      "cpfCnpj": "***.449.621-**"
    },
    "receiver": {
      "name": "Maria dos Santos",
      "cpfCnpj": "***.123.456-**"
    },
    "createdAt": 1768265000000,
    "updatedAt": 1768265100000
  }
}
curl -X GET https://api.owem.com.br/v4/i/baas/pix/payments/123456789012/E5470000120260113123456789012345 \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)"

Descrição

Consulta o status de um pagamento PIX usando o End-to-End ID (E2E ID) retornado nos endpoints de pagamento.
PROGRAMA BETA - Este endpoint está disponível apenas para parceiros aprovados no programa BAAS.

Autenticação

Este endpoint usa Basic Auth com sua API Key + Secret. O scope baas:pix é configurado pela Owem na sua API Key.
Authorization: Basic {Base64(API_KEY:API_SECRET)}

Request

Headers

HeaderTipoObrigatórioDescrição
AuthorizationstringBasic Auth (API Key + Secret em Base64)

Path Parameters

ParâmetroTipoObrigatórioDescrição
accountIdstringID da conta que fez o pagamento
endToEndIdstringE2E ID retornado no pagamento

Response

Sucesso (200 OK)

{
  "requestId": "o695q2r0-4s19-889r-2sro-87t239rp2os8",
  "success": true,
  "size": 1,
  "data": {
    "endToEndId": "E5470000120260113123456789012345",
    "status": "succeeded",
    "type": "pix_out",
    "reason": "pix_out:emv_pay",
    "amount": 100.0,
    "externalId": "pagamento-001",
    "payer": {
      "name": "JOAO DA SILVA",
      "cpfCnpj": "***.449.621-**"
    },
    "receiver": {
      "name": "Maria dos Santos",
      "cpfCnpj": "***.123.456-**"
    },
    "createdAt": 1768265000000,
    "updatedAt": 1768265100000
  }
}

Campos da Response

CampoTipoDescrição
endToEndIdstringID E2E do PIX
statusstringStatus atual do pagamento
typestringTipo de transação (pix_out)
reasonstringMotivo/método do pagamento
amountnumberValor do pagamento
externalIdstringID externo (se informado no pagamento)
payerobjectDados do pagador
receiverobjectDados do recebedor
createdAtnumberTimestamp de criação (ms)
updatedAtnumberTimestamp da última atualização (ms)

Objeto payer / receiver

CampoTipoDescrição
namestringNome (parcialmente mascarado)
cpfCnpjstringCPF/CNPJ (parcialmente mascarado)

Status Possíveis

StatusDescrição
processingEm processamento
succeededPagamento concluído com sucesso
failedPagamento falhou (ver failureReason)

Motivos de Pagamento (reason)

ReasonDescrição
pix_out:keyPIX enviado via chave
pix_out:emv_payPIX enviado via QR Code

Erros

CódigoDescrição
403Conta não pertence a este parceiro
404Pagamento não encontrado
Se o status for failed, verifique o campo failureReason na response para entender o motivo da falha.
O endToEndId (E2E ID) é o identificador único do PIX no sistema brasileiro. Ele pode ser usado para consultas e comprovantes.
{
  "requestId": "o695q2r0-4s19-889r-2sro-87t239rp2os8",
  "success": true,
  "size": 1,
  "data": {
    "endToEndId": "E5470000120260113123456789012345",
    "status": "succeeded",
    "type": "pix_out",
    "reason": "pix_out:emv_pay",
    "amount": 100.0,
    "externalId": "pagamento-001",
    "payer": {
      "name": "JOAO DA SILVA",
      "cpfCnpj": "***.449.621-**"
    },
    "receiver": {
      "name": "Maria dos Santos",
      "cpfCnpj": "***.123.456-**"
    },
    "createdAt": 1768265000000,
    "updatedAt": 1768265100000
  }
}