GET/api/v2/baas/contracts/{contractId}

Consultar contrato

Produto BaaS (titular). Requer Bearer JWT do login da conta e assinatura HMAC obrigatória. Scope: baas.contracts.read. Guia: documentação técnica.

Parâmetros

AcceptObrigatório
header
Tipo:string
X-SignatureObrigatório
header

Assinatura HMAC-SHA256 da requisição (hex).

Tipo:string
X-TimestampObrigatório
header

Timestamp Unix (segundos, UTC) usado na assinatura.

Tipo:string
X-NonceObrigatório
header

Nonce único por requisição (anti-replay).

Tipo:string
contractIdObrigatório
path

ID numérico do contrato (campo `id` na resposta).

Tipo:integer

Autenticação e headers

Requer Bearer JWT do login da conta (titular) e assinatura HMAC obrigatórios. Scope: baas.contracts.read.

Envie X-Signature, X-Timestamp e X-Nonce em todo pedido assinado. Veja Autenticação do parceiro (HMAC).

HeaderObrigatórioDescrição
AuthorizationSimBearer {{access_token}}
AcceptSimapplication/json
X-SignatureSimAssinatura HMAC
X-TimestampSimTimestamp da assinatura
X-NonceSimNonce único por requisição

Titular: Bearer do login da conta. Path contractId = ID numérico do contrato (campo id na resposta). GET assinado: BODY [] na mensagem HMAC.

Resposta

Objeto com products[], pricing[] (tarifas em centavos), titular fictício e status do contrato.

Códigos

CódigoDescrição
200OK
201Recurso criado
400Parâmetros inválidos
401Token ou HMAC inválido
403Scope ausente
404Não encontrado
422Validação ou regra de negócio
500Erro interno

Notas

curl --request GET \
  --url 'https://api-h.nuvende.com.br/api/v2/baas/contracts/42' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'X-Timestamp: {{timestamp}}' \
  --header 'X-Nonce: {{nonce}}' \
  --header 'X-Signature: {{signature}}'
const axios = require("axios");

const contractId = 42;

axios({
  method: "get",
  url: `https://api-h.nuvende.com.br/api/v2/baas/contracts/${contractId}`,
  headers: {
    Accept: "application/json",
    Authorization: "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
  },
})
  .then((response) => console.log(JSON.stringify(response.data)))
  .catch((error) => console.log(error.response?.data || error.message));
import requests

contract_id = 42
url = f"https://api-h.nuvende.com.br/api/v2/baas/contracts/{contract_id}"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
}
response = requests.get(url, headers=headers)
print(response.text)
<?php
$contractId = 42;
$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-h.nuvende.com.br/api/v2/baas/contracts/{$contractId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Accept: application/json',
    'Authorization: Bearer {{access_token}}',
    'X-Timestamp: {{timestamp}}',
    'X-Nonce: {{nonce}}',
    'X-Signature: {{signature}}',
  ],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
  "id": 42,
  "account_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Contrato Exemplo PF",
  "status": "active",
  "holder_name": "Maria Pagadora Exemplo",
  "holder_document": "11144477735",
  "products": [
    "pix",
    "pix-cash-in",
    "bankslip-payments",
    "key-managements"
  ],
  "pricing": [
    {
      "product": "pix_sent",
      "fee_cents": 0
    },
    {
      "product": "pix_received",
      "fee_cents": 0
    },
    {
      "product": "bankslip_payment",
      "fee_cents": 150
    }
  ]
}

No portal público, o titular consulta o contrato em GET /api/v2/baas/contracts/{contractId} (ID numérico do contrato, campo id na resposta).