v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Authorizations

Obtem detalhes de autorização usando token

get/reports/authorizations

Query parameters

startDatestring date required
Example:2024-01-01

Filtro Data de Início

endDatestring date required
Example:2024-12-31

Filtro Data de Fim

perPageinteger required

Definir número de itens por página

comparisonStartDatestring date
Example:2024-12-01

Filtro Data de Início de Comparação

comparisonEndDatestring date
Example:2024-12-01

Filtro Data de Fim de Comparação

amountRangestring[]

Filtro Faixa de Valor da Autorização

[
  "ZERO_TO_TEN"
]
merchantCategorystring[]

Filtro Categoria do Estabelecimento

programIdinteger

Filtro por Id do Programa

productstring[]

Filtro por Nome do Produto

[
  "Platinum"
]
captureModestring[]

Filtro por Modo de Captura

authorizationTypestring[]

Filtro por Tipo de Autorização

authorizationstring[]

Filtro por Autorização

authorizationCodestring
Example:XPTZ11A

Filtro por Código de Autorização

processingCodestring
Example:00

Filtro por Código de Processamento

cardIdinteger

Filtro por ID do Cartão

accountIdinteger

Filtro por Id da Conta.

customerIdinteger

Filtro por Id do Cliente.

Headers

Authorizationstring required
Example:Bearer {token}

Bearer authentication token

Response

Ok

versionstring
statusnumber

Example response

{
  "version": "1.0.0",
  "body": {
    "startPeriod": {
      "startDate": "2024-01-01T00:00:00.000000Z",
      "endDate": "2024-12-31T23:59:59.999999Z",
      "data": [
        {
          "category": "AUTHORIZATION",
          "amount": "3.00",
          "dateTimeAuthorization": "2024-12-31T23:59:59.999999Z",
          "flag": "Visa",
          "merchantCategory": "AUTONOMOUS_FUEL_PUMP",
          "authorizationType": "CARD_NOT_PRESENT",
          "captureMode": "ECOMMERCE",
          "authorization": "APPROVE_IN_HOST",
          "authorizationResponseCode": "APROVADO",
          "product": "Programa novo atualizado",
          "authorizationCode": "TST123",
          "transactionOrigin": "NATIONAL_TRANSACTION",
          "paymentMethod": "CREDIT",
          "paymentType": "CASH_PAYMENT",
          "description": "Quitada do Fulado de Tal",
          "merchantCity": "Sao Paulo",
          "merchantState": "BR",
          "processingCode": "00",
          "cardFirstDigits": "1234",
          "cardLastDigits": "7890",
          "cvvPresence": true,
          "installments": 1,
          "transactionIdentifier": "1234567890",
          "statusTransaction": "PENDENTE",
          "acquirerId": "010203",
          "ARN": "24894275079206900183654",
          "programType": "CREDIT"
        }
      ],
      "pagination": {
        "totalPages": 10
      }
    }
  }
}