Invoices

Visualizar transações da fatura do cartão de crédito

get/{companyId}/banking/cards/invoices/{invoiceId}/transactions

Request

  • Base URL
    https://api.sandbox.empresas.btgpactual.com
  • Auth
    OAuth 2
    Authorization codehttps://id.empresas.btgpactual.com/oauth2/authorize
    Token URLhttps://id.empresas.btgpactual.com/oauth2/token
    Scopesbrn:btg:empresas:banking:payroll

Path parameters

companyIdstring required

CNPJ da empresa

invoiceIdstring nullable required

Identificador único da fatura do cartão de crédito

Query parameters

cursorstring nullable

Cursor para paginação dos resultados

itemsPerPageinteger nullable

Número de itens por página

pageinteger nullable

Número da página

Response

Success

Example response

{
  "data": [
    {
      "id": 1234567890,
      "installment": 1,
      "numberOfInstallments": 3,
      "softDescriptor": "PARCELADO BOLETO",
      "processingCode": "000000",
      "processingDescription": "PARCELADO BOLETO",
      "customerId": 56789,
      "tax": [
        {
          "type": "INTEREST",
          "value": 15
        }
      ],
      "eventDate": "2023-05-20T14:30:00",
      "createdAt": "2023-05-20T14:35:00",
      "transactionType": {
        "id": 1234,
        "description": "Compra à vista",
        "postedTransaction": true
      },
      "amount": [
        {
          "type": "PRINCIPAL",
          "currency": "BRL",
          "value": 250.75,
          "rate": 1
        }
      ],
      "merchant": {
        "type": "NETWORK",
        "name": "Google",
        "city": "SAO PAULO",
        "state": "BR",
        "imageUrl": "https://example.com/example.png",
        "category": {
          "description": "Eating places and restaurants",
          "groupName": "Alimentação",
          "networkGroup": "FOOD",
          "imageURL": "https://example.com/example.png"
        }
      },
      "card": {
        "id": 1234567890,
        "name": "JOAO DA SILVA",
        "last4Digits": "1234",
        "type": "PHYSICAL",
        "ownerName": "JOAO DA SILVA",
        "modality": "CREDIT"
      }
    }
  ],
  "_links": [
    {
      "rel": "self",
      "href": "/direct-debits/d2627834-dd84-4094-9dcf-ca784460b352",
      "method": "DELETE",
      "type": "application/json"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.