VCNConsultar transações do VCN (Em breve)

Consultar transações do VCN (Em breve)

🚧 Em breve — este endpoint ainda não está disponível em Sandbox nem Produção. A documentação está publicada para você preparar a integração; avisaremos no changelog quando entrar no ar.

Use para conciliar os pagamentos de uma reserva: lista as transações de um VCN, identificado pelo vcnId retornado em Criar VCN. Resultado paginado e ordenado por data decrescente.

Autenticação: além da API key/secret, este endpoint exige mTLS na camada de transporte.

Autorização: o vcnId precisa pertencer ao cliente autenticado; um vcnId de outro cliente retorna 404.

curl -X GET "https://api-sandbox.contasimples.com/credit-cards/v1/vcns/21624502/transactions?limit=50&startDate=2026-06-01&endDate=2026-06-30&status=%5B%22AUTHORIZED%22%5D&nextPageStartKey=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "transactions": [
    {
      "transactionId": "txn_01HF8Z3K2QX5",
      "status": "SETTLED",
      "amount": {
        "value": 101,
        "currency": "BRL"
      },
      "date": "2026-06-09T16:02:40Z",
      "merchantName": "CIA AEREA EXEMPLO",
      "merchantCategory": "AIR",
      "authorizationCode": "A1B2C3"
    }
  ],
  "nextPageStartKey": "eyJsYXN0SWQiOiJ0eG5fMDFIRjhaIn0="
}
GET
/credit-cards/v1/vcns/{vcnId}/transactions
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
path
vcnIdstring
Required

Identificador do VCN retornado na emissão (campo vcnId).

query
limitinteger

Número máximo de transações por página. Mínimo: 1, Máximo: 100. Padrão: 50.

Min: 1 • Max: 100
query
startDatestring

Data inicial do período consultado (formato YYYY-MM-DD).

Format: date
query
endDatestring

Data final do período consultado (formato YYYY-MM-DD).

Format: date
query
statusarray

Filtro opcional por situação da transação.

query
nextPageStartKeystring

Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Path Parameters

vcnIdstring
Required

Identificador do VCN retornado na emissão (campo vcnId).

Example:
21624502

Query Parameters

limitinteger

Número máximo de transações por página. Mínimo: 1, Máximo: 100. Padrão: 50.

Example:
50
startDatestring

Data inicial do período consultado (formato YYYY-MM-DD).

Example:
2026-06-01
endDatestring

Data final do período consultado (formato YYYY-MM-DD).

Example:
2026-06-30
statusarray

Filtro opcional por situação da transação.

nextPageStartKeystring

Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.

Responses

transactionsarray
Required
nextPageStartKeystring

Token opaco de paginação. Reenvie no parâmetro nextPageStartKey para obter a próxima página. Ausente na última página.