API legada/Referência completa/API 4.0 (app móvel)

Formas de pagamento

Lista as formas de pagamento cadastradas para a loja inteira ou para um seller, no formato que o checkout do app espera.

O checkout do app precisa saber quais formas de pagamento oferecer: PIX, cartão com parcelas, boleto, pagamento a prazo. Esta rota devolve as formas de pagamento cadastradas na loja, no formato da plataforma 1.0 (todos os valores como texto), uma por item.

Diferente do resto da API 4.0, esta rota usa credencial de administrador (e-mail e chave de API), não a ekey do cliente. Ela serve a um servidor que monta o checkout, não ao aparelho do cliente. A chave de API nunca deve ir dentro do app.

GET/api/4.0/payments_ext_aAdmin

Listar formas de pagamento

Devolve as formas de pagamento da empresa pedida. Por padrão (sem company_id) são só as da loja inteira; as de um seller vêm quando você informa o seller, junto com as da loja inteira. As formas do ponto de venda (balcão) nunca entram.

Cabeçalhos

Authorizationstringobrigatório

Basic <base64 de e-mail:chave_de_api> de um usuário administrador ativo, tudo num único Base64. Um token de cliente (ekey) é recusado.

Parâmetros de consulta

company_idstring

Seller (id decimal, id antigo ou UUID). Vazio ou 0 significa só as formas da loja inteira. Seller desconhecido devolve payments vazio.

statusstring

ADactiveinactive

Só as formas ativas (A) ou só as desativadas (D). Vazio não filtra. Valor desconhecido devolve lista vazia.

lang_codestringpadrão: pt-BR

Valor devolvido em cada item no campo lang_code. Não traduz nada.

Exemplo de requisição

bash

curl "$BASE_URL/api/4.0/payments_ext_a?company_id=496868694&status=A" \
  -u "$EMAIL:$API_KEY"

Resposta

200Formas de pagamento

json

{
  "payments": [
    {
      "payment_id": "1204113",
      "payment": "PIX",
      "description": "Pague com PIX e ganhe desconto.",
      "instructions": "",
      "template": "",
      "company_id": "0",
      "status": "A",
      "usergroup_ids": "0",
      "a_surcharge": "0.00",
      "p_surcharge": "0.00",
      "min_order_limit": "0.00",
      "max_order_limit": "0.00",
      "processor_params": "a:1:{s:18:\"installment_number\";a:1:{i:1;a:2:{s:9:\"surcharge\";s:0:\"\";s:11:\"is_selected\";s:1:\"Y\";}}}",
      "position": "10",
      "processor_id": "0",
      "processor_type": "P",
      "processor_status": "A",
      "lang_code": "pt-BR",
      "surcharge_title": "",
      "payment_period": "0",
      "min_order_count": "0",
      "max_order_count": "0",
      "ec_payment_code": "",
      "ec_usergroup_code": "",
      "allow_to_use_seller_limit": "N",
      "v_temp_wallet_allow": "N",
      "tax_ids": "",
      "localization": "",
      "payment_category": ""
    }
  ]
}

Campos da resposta

payments[].payment_idstring

Id decimal da forma de pagamento. É o valor que o pedido do app envia ao escolher a forma.

payments[].paymentstring

Nome mostrado ao cliente. Em formas a prazo, vem com o prazo (Boleto (30 dias)) e main_payment traz o nome base.

payments[].descriptionstring

Descrição curta.

payments[].instructionsstring

Instruções ao cliente.

payments[].templatestring

Caminho do modelo de tela que o app compara para saber se a forma é cartão ou boleto. Vazio nas demais (PIX, offline).

payments[].company_idstring

Seller dono da forma. "0" é da loja inteira.

payments[].statusstring

AD

A ativa, D desativada.

payments[].usergroup_idsstring

Ids dos grupos de usuários que podem usar a forma, separados por vírgula. "0" é todos.

payments[].a_surchargestring

Acréscimo fixo, em reais, com duas casas.

payments[].p_surchargestring

Acréscimo percentual, com duas casas.

payments[].min_order_limitstring

Pedido mínimo para usar a forma, em reais. "0.00" é sem mínimo.

payments[].max_order_limitstring

Pedido máximo para usar a forma, em reais. "0.00" é sem máximo.

payments[].processor_paramsstring

Opções de parcelamento, serializadas no formato de serialização do PHP (assim o app 1.0 as lê). Em formas sem parcelamento vem uma única opção de 1 parcela.

payments[].positionstring

Ordem de exibição.

payments[].payment_periodstring

Prazo em dias, para formas a prazo. "0" quando não há.

payments[].ec_payment_codestring

Código interno 1 da forma, usado por integrações com ERP.

payments[].ec_usergroup_codestring

Código interno 2 da forma, usado por integrações com ERP.

payments[].allow_to_use_seller_limitstring

YN

Y quando a forma usa o limite de crédito do cliente com o fornecedor.

payments[].main_paymentstring

Nome base, presente só nas formas a prazo.

payments[].lang_codestring

O lang_code pedido.

Os campos processor_id ("0"), processor_type ("P"), processor_status ("A"), surcharge_title, min_order_count, max_order_count, v_temp_wallet_allow, tax_ids, localization e payment_category existem para o app 1.0 e têm sempre os valores fixos do exemplo.

Erros

Status	Quando	Corpo
401	Sem `Authorization`, em formato inválido, e-mail desconhecido, usuário inativo ou chave errada	`{"error":"unauthorized"}`
403	Credencial válida de usuário que não é administrador	`{"error":"forbidden"}`
500	Falha ao ler	`{"error":"internal error"}`

Veja também