API legada/Referência completa/Integração ERP (1.0)

Condições de pagamento

Devolve a lista fixa de condições de pagamento (à vista, 2x e 3x sem juros) que a API 1.0 expõe ao checkout.

Uma condição de pagamento descreve como o cliente paga: à vista com desconto, parcelado sem juros. O checkout de integrações da 1.0 consulta esta rota para montar as opções.

A rota aceita qualquer usuário autenticado (inclusive um cliente), não só administrador.

GET/api/v1.0/payment-conditionsAutenticada

Condições de pagamento (API 1.0)

Parâmetros de consulta

pageintegerpadrão: 1

Só é ecoado em params.page. Não muda a lista.

items_per_pageintegerpadrão: 10

Só é ecoado em params.items_per_page (de 1 a 250). Não corta a lista.

GET/api/payment-conditionsAutenticada

Mesma rota, sem o prefixo /v1.0

Idêntica à anterior em parâmetros e resposta.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1.0/payment-conditions" \
  -u "$EMAIL:$API_KEY"

Resposta

200Condições de pagamento

json

{
  "payment_conditions": [
    { "id": 1, "name": "À vista", "installments": 1, "interest_bps": 0, "discount_bps": 500 },
    { "id": 2, "name": "2x sem juros", "installments": 2, "interest_bps": 0, "discount_bps": 0 },
    { "id": 3, "name": "3x sem juros", "installments": 3, "interest_bps": 0, "discount_bps": 0 }
  ],
  "params": { "page": 1, "items_per_page": 10, "total_items": 3 }
}

Campos da resposta

payment_conditions[].idinteger

Número da condição (1 a 3).

payment_conditions[].namestring

Nome mostrado.

payment_conditions[].installmentsinteger

Quantidade de parcelas.

payment_conditions[].interest_bpsinteger

Juros em pontos-base (100 = 1%). 0 é sem juros.

payment_conditions[].discount_bpsinteger

Desconto em pontos-base. 500 é 5% de desconto.

paramsobject

page e items_per_page ecoados da consulta e total_items, sempre 3.

Erros

Status	Quando	Corpo
401	Sem credencial	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`

Veja também