Pesquisar Pagamento

Dados da API

API Gateway
Esta API é utilizada para operações do gateway de pagamento:

• Produção: https://api.sopague.com.br/gateway
• Homologação: https://api-hmg.sopague.com.br/gateway
• Arquitetura: Representational State Transfer (REST)

Introdução

A consulta de pagamento permite verificar o status e outros detalhes de uma transação específica. Para realizar a operação, envie uma requisição GET ao endpoint indicado.

Realizar Operação de Consulta de Pagamento

GET /v1/payments/{paymentId}

Via request Representational State Transfer (REST) com o body:

Dicionário de dados - Parâmetros

PROPRIEDADE	DESCRIÇÃO	TIPO	LOCAL	OBRIGATÓRIO	TAMANHO
PaymentId	Identificador do pagamento a ser pesquisado.	string	path	sim	42

🟢 200

Pesquisa realizada com sucesso

  {
    "paymentId": "020037308007081506570001580648030000000000", 
    "statusDescription": "Cancelada", 
    "transactionDate": "2024-07-08T12:06:57.07", 
    "authorizationCode": "078704", 
    "value": 15000
  }

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
PaymentId	Identificador do pagamento.	string
StatusDescription	Descrição do status da transação.	string
transactionDate	Data da transação.	string
AuthorizationCode	Código de autorização da transação.	string
Value	Valor da transação.	integer

🔴 400

Erro na requisição

[ 
    { 
        "tag": "__general__", 
        "description": "Transação não localizada, verifique os dados informados."
    } 
] 

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string

🔴 500

Erro interno

[ 
    { 
        "tag": "", 
        "description": "Não foi possível executar comando. Erro desconhecido." 
    } 
]

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string