Search Transactions

API details

Conciliation and Bank Slips API
These APIs are used for additional features such as generating and managing bank slips:

• Production: https://integration.sopague.com.br/sopague
• Homologation: https://api-hmg.sopague.com.br/integration
• Architecture: Representational State Transfer (REST)

Search by operation code

Used to retrieve transaction data by the transaction code.

POST /api/transaction/concil/search-by-code?accountNumber={accountNumber}&nsu={nsu}&codAuth={codAuth}

Data dictionary - Query parameters

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
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",
      "splits": [
          {
              "beneficiario": "string",
              "tipoSplit": "string",
              "pctSplit": 0.0000,
              "valorBaseSplit": 0.0000,
              "valorSplit": 0.0000
          }
      ]
  }
]

Data dictionary - Response

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
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	"R" = Regular (sem antecipação); "A" = Antecipação Pontual; "E" = Antecipação Automática;
receivedStatus	Status do recebimento	string	1	"A" = Aberto; "P" = Pago;
transactionReference	Referência da transação	string	100	-
transactionPaymentIdWeb	identificador de pagamento retornado pelo gateway no momento da autorização da venda	string	100	-
splits	Lista de splits da transação (opcional)	array	-	Apenas se houver split configurado
splits[].beneficiario	CPF/CNPJ do beneficiário do split	string	14	-
splits[].tipoSplit	Tipo do split: 'bruto' ou 'liquido'	string	10	-
splits[].pctSplit	Porcentagem do split	decimal	10,4	-
splits[].valorBaseSplit	Valor base usado no cálculo do split	decimal	10,4	-
splits[].valorSplit	Valor calculado do split	decimal	10,4	-

Search by authorization code and operation date

Used to retrieve transaction data by authorization code and operation date.

POST /api/transaction/concil/search-by-auth-code?accountNumber={accountNumber}&codAuth={codAuth}&operationDate={operationDate}&value={value}&installmentValue={installmentValue}&installmentNumber={installmentNumber}

Data dictionary - Query parameters

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
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 total da operação (soma do valor de todas as parcelas)	Decimal	10,4	-
InstallmentValue	Valor da parcela	Decimal	10,4	-
InstallmentNumber	Número da parcela	int	-	-

🟢 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",
      "splits": [
          {
              "beneficiario": "string",
              "tipoSplit": "string",
              "pctSplit": 0.0000,
              "valorBaseSplit": 0.0000,
              "valorSplit": 0.0000
          }
      ]
  }
]

Data dictionary - Response

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
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	"R" = Regular (sem antecipação); "A" = Antecipação Pontual; "E" = Antecipação Automática;
receivedStatus	Status do recebimento	string	1	"A" = Aberto; "P" = Pago;
transactionReference	Referência da transação	string	100	-
transactionPaymentIdWeb	identificador de pagamento retornado pelo gateway no momento da autorização da venda	string	100	-
splits	Lista de splits da transação (opcional)	array	-	Apenas se houver split configurado
splits[].beneficiario	CPF/CNPJ do beneficiário do split	string	14	-
splits[].tipoSplit	Tipo do split: 'bruto' ou 'liquido'	string	10	-
splits[].pctSplit	Porcentagem do split	decimal	10,4	-
splits[].valorBaseSplit	Valor base usado no cálculo do split	decimal	10,4	-
splits[].valorSplit	Valor calculado do split	decimal	10,4	-

Important

When searching for an installment transaction, the system returns the list of installments, each with due date, amounts, and status, enabling full conciliation of the operation.

Search by operation date

Search by operation date

Used to retrieve a summary of the main transaction data filtered by operation date (sale date). It always returns one row per transaction, even for installment transactions. For more detailed information and one row per installment, use the "search-by-operation-date-installments" method.

POST /api/transaction/concil/search-by-operation-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}

Data dictionary - Query parameters

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
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"
  }
]

Data dictionary - Response

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
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	-

Search by operation date com detalhes das parcelas

Used to retrieve detailed transaction data filtered by operation date (sale date). Unlike "search-by-operation-date", this endpoint returns transactions installment by installment.

POST /api/transaction/concil/search-by-operation-date-installments?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}

Data dictionary - Query parameters

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
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",
      "splits": [
          {
              "beneficiario": "string",
              "tipoSplit": "string",
              "pctSplit": 0.0000,
              "valorBaseSplit": 0.0000,
              "valorSplit": 0.0000
          }
      ]
  }
]

Data dictionary - Response

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
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	"R" = Regular (sem antecipação); "A" = Antecipação Pontual; "E" = Antecipação Automática;
receivedStatus	Status do recebimento	string	1	"A" = Aberto; "P" = Pago;
transactionReference	Referência da transação	string	100	-
transactionPaymentIdWeb	identificador de pagamento retornado pelo gateway no momento da autorização da venda	string	100	-
splits	Lista de splits da transação (opcional)	array	-	Apenas se houver split configurado
splits[].beneficiario	CPF/CNPJ do beneficiário do split	string	14	-
splits[].tipoSplit	Tipo do split: 'bruto' ou 'liquido'	string	10	-
splits[].pctSplit	Porcentagem do split	decimal	10,4	-
splits[].valorBaseSplit	Valor base usado no cálculo do split	decimal	10,4	-
splits[].valorSplit	Valor calculado do split	decimal	10,4	-

Search by payment date

Used to retrieve transaction data by payment date.

POST /api/transaction/concil/search-by-payment-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}

Data dictionary - Query parameters

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
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",
      "splits": [
          {
              "beneficiario": "string",
              "tipoSplit": "string",
              "pctSplit": 0.0000,
              "valorBaseSplit": 0.0000,
              "valorSplit": 0.0000
          }
      ]
  }
]

Data dictionary - Response

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
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	"R" = Regular (sem antecipação); "A" = Antecipação Pontual; "E" = Antecipação Automática;
receivedStatus	Status do recebimento	string	1	"A" = Aberto; "P" = Pago;
transactionReference	Referência da transação	string	100	-
transactionPaymentIdWeb	identificador de pagamento retornado pelo gateway no momento da autorização da venda	string	100	-
splits	Lista de splits da transação (opcional)	array	-	Apenas se houver split configurado
splits[].beneficiario	CPF/CNPJ do beneficiário do split	string	14	-
splits[].tipoSplit	Tipo do split: 'bruto' ou 'liquido'	string	10	-
splits[].pctSplit	Porcentagem do split	decimal	10,4	-
splits[].valorBaseSplit	Valor base usado no cálculo do split	decimal	10,4	-
splits[].valorSplit	Valor calculado do split	decimal	10,4	-

Additional information

For all API methods (except the token retrieval method), requests must be sent with a header in the following format:

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”

corresponds to the token obtained via api/Auth/Token.

Important

Each token has an expiration date and time. The integrating system is responsible for requesting a new token to make new calls after the previous one expires.