Consultar Transações

Dados da API

API Conciliação e Boletos
Estas APIs são utilizadas para funcionalidades adicionais, como geração e gestão de boletos:

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

Consulta por código de operação

Utilizada para consultar os dados das transações através do código da transação.

POST /api/transaction/concil/search-by-code

Via request Representational State Transfer (REST) com query parameters:

Dicionário de dados - Parâmetros

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
accountNumber	Número da conta que o operação foi emitida	long	-	-
Nsu	Número de identificação da operação	string	100	-
CodAuth	Código de autorização da operação	string	30	-

🟢 200

Resposta

[
  {
      "transactionDate": "2024-09-24T16:19:29",
      "terminal": "string",
      "cardNumber": "string",
      "cardType": "string",
      "cardName": "string",
      "codAuth": "string",
      "nsu": "string",
      "installmentNumber": 0,
      "installmentsCount": 0,
      "installmentValue": 0.0000,
      "transactionTotalValue": 0.0000,
      "installmentStatus": "string",
      "discountMdrValue": 0.0000,
      "discountMdrTax": 0.0000,
      "discountTrnRateInstalmentValue": 0.0000,
      "discountTrnRateTransactionValue": 0.0000,
      "discountAntifraudRateInstalmentValue": 0.0000,
      "discountAntifraudRateTransactionValue": 0.0000,
      "discountAntecipationValue": 0.0000,
      "discountAntecipationTax": 0.0000,
      "receivedValue": 0.0000,
      "receivedDateForeast": "2024-10-25",
      "receivedDateEffective": "2024-11-07",
      "receivedType": "string",
      "receivedStatus": "string",
      "transactionReference": "string",
      "transactionPaymentIdWeb": "string"
  }
]

Dicionário de dados - Retorno

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
transactionDate	Data em que ocorreu a transação	datetime	-	-
terminal	Número de série do terminal	string	30	-
cardNumber	Número do cartão	string	15	Número mascarado.
cardType	Tipo de cartão ou operação	string	50	Crédito, Débito, PIX, etc.
cardName	Bandeira do cartão	string	50	Visa, Mastercard, Elo, Maestro, PIX etc.
codAuth	Código de autorização da operação	string	30	-
nsu	Número de identificação da operação	string	100	-
installmentNumber	Número da parcela	int	-	Somente números
installmentsCount	Quantidade total de parcelas da venda	int	-	Somente números
installmentValue	Valor da parcela	decimal	10,4	-
transactionTotalValue	Valor total da transação	decimal	10,4	-
installmentStatus	Status da parcela	string	1	“A” = Aprovado; “B” = Bloqueado; “C” = Cancelado;
discountMdrValue	Valor do desconto MDR	decimal	10,4	-
discountMdrTax	Taxa do desconto MDR	decimal	10,4	-
discountTrnRateInstalmentValue	Valor da taxa de transação por parcela	decimal	10,4	-
discountTrnRateTransactionValue	Valor da taxa de transação	decimal	10,4	-
discountAntifraudRateInstalmentValue	Valor da taxa antifraude por parcela	decimal	10,4	-
discountAntifraudRateTransactionValue	Valor da taxa antifraude da transação	decimal	10,4	-
discountAntecipationValue	Valor do desconto de antecipação	decimal	10,4	-
discountAntecipationTax	Taxa do desconto de antecipação	decimal	10,4	-
receivedValue	Valor recebido	decimal	10,4	-
receivedDateForeast	Data prevista para recebimento	datetime	-	-
receivedDateEffective	Data efetiva de recebimento	datetime	-	-
receivedType	Tipo de recebimento	string	1	-
receivedStatus	Status do recebimento	string	1	-
transactionReference	Referência da transação	string	100	-
transactionPaymentIdWeb	identificador de pagamento retornado pelo gateway no momento da autorização da venda	string	100	-

Consulta por código de autorização e data de operação

Utilizada para consultar os dados das transações atraves do codigo de autorização e data de operação.

POST /api/transaction/concil/search-by-auth-code

Via request Representational State Transfer (REST) com query parameters:

Dicionário de dados - Parâmetros

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
accountNumber	Número da conta que o operação foi emitida	long	-	-
CodAuth	Código de autorização da operação	string	30	-
OperationDate	Data de operação	Date	-	-
Value	Valor da operação	Decimal	10,4	-

🟢 200

Resposta

[
  {
      "transactionDate": "2024-09-24T16:19:29",
      "terminal": "string",
      "cardNumber": "string",
      "cardType": "string",
      "cardName": "string",
      "codAuth": "string",
      "nsu": "string",
      "installmentNumber": 0,
      "installmentsCount": 0,
      "installmentValue": 0.0000,
      "transactionTotalValue": 0.0000,
      "installmentStatus": "string",
      "discountMdrValue": 0.0000,
      "discountMdrTax": 0.0000,
      "discountTrnRateInstalmentValue": 0.0000,
      "discountTrnRateTransactionValue": 0.0000,
      "discountAntifraudRateInstalmentValue": 0.0000,
      "discountAntifraudRateTransactionValue": 0.0000,
      "discountAntecipationValue": 0.0000,
      "discountAntecipationTax": 0.0000,
      "receivedValue": 0.0000,
      "receivedDateForeast": "2024-10-25",
      "receivedDateEffective": "2024-11-07",
      "receivedType": "string",
      "receivedStatus": "string",
      "transactionReference": "string",
      "transactionPaymentIdWeb": "string"
  }
]

Dicionário de dados - Retorno

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
transactionDate	Data em que ocorreu a transação	datetime	-	-
terminal	Número de série do terminal	string	30	-
cardNumber	Número do cartão	string	15	Número mascarado.
cardType	Tipo de cartão ou operação	string	50	Crédito, Débito, PIX, etc.
cardName	Bandeira do cartão	string	50	Visa, Mastercard, Elo, Maestro, PIX etc.
codAuth	Código de autorização da operação	string	30	-
nsu	Número de identificação da operação	string	100	-
installmentNumber	Número da parcela	int	-	Somente números
installmentsCount	Quantidade total de parcelas da venda	int	-	Somente números
installmentValue	Valor da parcela	decimal	10,4	-
transactionTotalValue	Valor total da transação	decimal	10,4	-
installmentStatus	Status da parcela	string	1	“A” = Aprovado; “B” = Bloqueado; “C” = Cancelado;
discountMdrValue	Valor do desconto MDR	decimal	10,4	-
discountMdrTax	Taxa do desconto MDR	decimal	10,4	-
discountTrnRateInstalmentValue	Valor da taxa de transação por parcela	decimal	10,4	-
discountTrnRateTransactionValue	Valor da taxa de transação	decimal	10,4	-
discountAntifraudRateInstalmentValue	Valor da taxa antifraude por parcela	decimal	10,4	-
discountAntifraudRateTransactionValue	Valor da taxa antifraude da transação	decimal	10,4	-
discountAntecipationValue	Valor do desconto de antecipação	decimal	10,4	-
discountAntecipationTax	Taxa do desconto de antecipação	decimal	10,4	-
receivedValue	Valor recebido	decimal	10,4	-
receivedDateForeast	Data prevista para recebimento	datetime	-	-
receivedDateEffective	Data efetiva de recebimento	datetime	-	-
receivedType	Tipo de recebimento	string	1	-
receivedStatus	Status do recebimento	string	1	-
transactionReference	Referência da transação	string	100	-
transactionPaymentIdWeb	identificador de pagamento retornado pelo gateway no momento da autorização da venda	string	100	-

Atenção

Ao consultar uma transação parcelada, o sistema irá retornar a lista de parcelas, cada qual com suas informações de vencimento, valores e status, permitindo a conciliação completa da operação.

Consulta por data de operação

Busca pela data da operação

Utilizada para consultar um resumo dos principais dados das transações, filtrando através da data da operação (data da venda). Retorna sempre uma linha por transação, mesmo se a transação for parcelada. Para trazer informações mais detalhadas e uma linha por parcela, utilize o método "search-by-operation-date-installments"

POST /api/transaction/concil/search-by-operation-date

Via request Representational State Transfer (REST) com query parameters:

Dicionário de dados - Parâmetros

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
accountNumber	Número da conta que o operação foi emitida	long	-	-
StartDate	Data de início da busca	Date	30	Formato YYYY-MM-DD
EndDate	Data de fim da busca	Date	256	Formato YYYY-MM-DD

🟢 200

Resposta

[
  {
      "transactionDate":"2023-01-01T14:25:28.913Z",
      "terminal":"0",
      "cardNumber":"string",
      "cardType":"string",
      "cardName":"string",
      "codAuth":"",
      "nsu":"",
      "installments":"0",
      "amount":"0.00",
      "transactionStatus":"string",
      "transactionReference": "string",
      "transactionPaymentIdWeb": "string"
  }
]

Dicionário de dados - Retorno

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
TransactionDate	Data em que ocorreu a transação	datetime	-	-
Terminal	Número de série do terminal	string	30	-
CardNumber	Número do cartão	string	15	Número mascarado.
CardType	Tipo de cartão ou operação	string	50	Crédito, Débito, PIX, etc.
CardName	Bandeira do cartão	string	50	Visa, Mastercard, Elo, Maestro, PIX etc.
Nsu	Número de identificação da operação	string	100	-
CodAuth	Código de autorização da operação	string	30	-
Installments	Quantidade de parcelas	int	-	Somente números
Amount	Valor da transação	decimal	10,4	-
TransactionStatus	Status da transação	string	1	“A” = Aprovado; “B” = Bloqueado; “C” = Cancelado;
TransactionReference	Referência da transação	string	100	-
TransactionPaymentIdWeb	identificador de pagamento retornado pelo gateway no momento da autorização da venda	string	100	-

Busca pela data da operação com detalhes das parcelas

Utilizada para consultar dados detalhados das transações, filtrando através da data do operação (data da venda). Diferente do "search-by-operation-date", esse endpoint trás as transações parcela a parcela.

POST /api/transaction/concil/search-by-operation-date-installments

Via request Representational State Transfer (REST) com query parameters:

Dicionário de dados - Parâmetros

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
accountNumber	Número da conta que o operação foi emitida	long	-	-
StartDate	Data de início da busca	Date	30	Formato YYYY-MM-DD
EndDate	Data de fim da busca	Date	256	Formato YYYY-MM-DD

🟢 200

Resposta

[
  {
      "transactionDate": "2024-09-24T16:19:29",
      "terminal": "string",
      "cardNumber": "string",
      "cardType": "string",
      "cardName": "string",
      "codAuth": "string",
      "nsu": "string",
      "installmentNumber": 0,
      "installmentsCount": 0,
      "installmentValue": 0.0000,
      "transactionTotalValue": 0.0000,
      "installmentStatus": "string",
      "discountMdrValue": 0.0000,
      "discountMdrTax": 0.0000,
      "discountTrnRateInstalmentValue": 0.0000,
      "discountTrnRateTransactionValue": 0.0000,
      "discountAntifraudRateInstalmentValue": 0.0000,
      "discountAntifraudRateTransactionValue": 0.0000,
      "discountAntecipationValue": 0.0000,
      "discountAntecipationTax": 0.0000,
      "receivedValue": 0.0000,
      "receivedDateForeast": "2024-10-25",
      "receivedDateEffective": "2024-11-07",
      "receivedType": "string",
      "receivedStatus": "string",
      "transactionReference": "string",
      "transactionPaymentIdWeb": "string"
  }
]

Dicionário de dados - Retorno

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
transactionDate	Data em que ocorreu a transação	datetime	-	-
terminal	Número de série do terminal	string	30	-
cardNumber	Número do cartão	string	15	Número mascarado.
cardType	Tipo de cartão ou operação	string	50	Crédito, Débito, PIX, etc.
cardName	Bandeira do cartão	string	50	Visa, Mastercard, Elo, Maestro, PIX etc.
codAuth	Código de autorização da operação	string	30	-
nsu	Número de identificação da operação	string	100	-
installmentNumber	Número da parcela	int	-	Somente números
installmentsCount	Quantidade total de parcelas da venda	int	-	Somente números
installmentValue	Valor da parcela	decimal	10,4	-
transactionTotalValue	Valor total da transação	decimal	10,4	-
installmentStatus	Status da parcela	string	1	“A” = Aprovado; “B” = Bloqueado; “C” = Cancelado;
discountMdrValue	Valor do desconto MDR	decimal	10,4	-
discountMdrTax	Taxa do desconto MDR	decimal	10,4	-
discountTrnRateInstalmentValue	Valor da taxa de transação por parcela	decimal	10,4	-
discountTrnRateTransactionValue	Valor da taxa de transação	decimal	10,4	-
discountAntifraudRateInstalmentValue	Valor da taxa antifraude por parcela	decimal	10,4	-
discountAntifraudRateTransactionValue	Valor da taxa antifraude da transação	decimal	10,4	-
discountAntecipationValue	Valor do desconto de antecipação	decimal	10,4	-
discountAntecipationTax	Taxa do desconto de antecipação	decimal	10,4	-
receivedValue	Valor recebido	decimal	10,4	-
receivedDateForeast	Data prevista para recebimento	datetime	-	-
receivedDateEffective	Data efetiva de recebimento	datetime	-	-
receivedType	Tipo de recebimento	string	1	-
receivedStatus	Status do recebimento	string	1	-
transactionReference	Referência da transação	string	100	-
transactionPaymentIdWeb	identificador de pagamento retornado pelo gateway no momento da autorização da venda	string	100	-

Busca pela data do pagamento

Utilizada para consultar os dados das transações através da data do pagamento.

POST /api/transaction/concil/search-by-payment-date

Via request Representational State Transfer (REST) com query parameters:

Dicionário de dados - Parâmetros

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
accountNumber	Número da conta que o operação foi emitida	long	-	-
StartDate	Data de início da busca	Date	30	Formato YYYY-MM-DD
EndDate	Data de fim da busca	Date	256	Formato YYYY-MM-DD

🟢 200

Resposta

[
  {
      "transactionDate": "2024-09-24T16:19:29",
      "terminal": "string",
      "cardNumber": "string",
      "cardType": "string",
      "cardName": "string",
      "codAuth": "string",
      "nsu": "string",
      "installmentNumber": 0,
      "installmentsCount": 0,
      "installmentValue": 0.0000,
      "transactionTotalValue": 0.0000,
      "installmentStatus": "string",
      "discountMdrValue": 0.0000,
      "discountMdrTax": 0.0000,
      "discountTrnRateInstalmentValue": 0.0000,
      "discountTrnRateTransactionValue": 0.0000,
      "discountAntifraudRateInstalmentValue": 0.0000,
      "discountAntifraudRateTransactionValue": 0.0000,
      "discountAntecipationValue": 0.0000,
      "discountAntecipationTax": 0.0000,
      "receivedValue": 0.0000,
      "receivedDateForeast": "2024-10-25",
      "receivedDateEffective": "2024-11-07",
      "receivedType": "string",
      "receivedStatus": "string",
      "transactionReference": "string",
      "transactionPaymentIdWeb": "string"
  }
]

Dicionário de dados - Retorno

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
transactionDate	Data em que ocorreu a transação	datetime	-	-
terminal	Número de série do terminal	string	30	-
cardNumber	Número do cartão	string	15	Número mascarado.
cardType	Tipo de cartão ou operação	string	50	Crédito, Débito, PIX, etc.
cardName	Bandeira do cartão	string	50	Visa, Mastercard, Elo, Maestro, PIX etc.
codAuth	Código de autorização da operação	string	30	-
nsu	Número de identificação da operação	string	100	-
installmentNumber	Número da parcela	int	-	Somente números
installmentsCount	Quantidade total de parcelas da venda	int	-	Somente números
installmentValue	Valor da parcela	decimal	10,4	-
transactionTotalValue	Valor total da transação	decimal	10,4	-
installmentStatus	Status da parcela	string	1	“A” = Aprovado; “B” = Bloqueado; “C” = Cancelado;
discountMdrValue	Valor do desconto MDR	decimal	10,4	-
discountMdrTax	Taxa do desconto MDR	decimal	10,4	-
discountTrnRateInstalmentValue	Valor da taxa de transação por parcela	decimal	10,4	-
discountTrnRateTransactionValue	Valor da taxa de transação	decimal	10,4	-
discountAntifraudRateInstalmentValue	Valor da taxa antifraude por parcela	decimal	10,4	-
discountAntifraudRateTransactionValue	Valor da taxa antifraude da transação	decimal	10,4	-
discountAntecipationValue	Valor do desconto de antecipação	decimal	10,4	-
discountAntecipationTax	Taxa do desconto de antecipação	decimal	10,4	-
receivedValue	Valor recebido	decimal	10,4	-
receivedDateForeast	Data prevista para recebimento	datetime	-	-
receivedDateEffective	Data efetiva de recebimento	datetime	-	-
receivedType	Tipo de recebimento	string	1	-
receivedStatus	Status do recebimento	string	1	-
transactionReference	Referência da transação	string	100	-
transactionPaymentIdWeb	identificador de pagamento retornado pelo gateway no momento da autorização da venda	string	100	-

Informações Adicionais

Em todos os métodos da API, exceto o método de obtenção de token, a chamada deverá ser enviada com um header no seguinte formato:

Key	Value
Authorization	Bearer eyJhbGciOiJSUzIlxdWVtZS [...] mj2m65fJfvmjdVXp6dQ

Onde o tipo de autenticação Bearer nunca mudará, e o token que vem logo em seguida, no caso exemplificado por: “eyJhbGciOiJSUzIlxdWVtZS [...] mj2m65fJfvmjdVXp6dQ”

corresponde ao token obtido através do método api/Auth/Token.

Atenção

Todo token tem uma data e hora de expiração, ficando a cargo do sistema integrador a responsabilidade de providenciar um novo token para realizar novas chamadas após a expiração deste.