Taxas da empresa
Método#
/getOrganizationFee
POST https://e-vendi.com.br/api/getOrganizationFee
Conceituação#
Verificar as taxas que serão cobradas de acordo com o método de pagamento escolhido pelo cliente.
Esse método é responsável por pegar as taxas da empresa.
Atributos#
note
externalId é o id do seu cliente na sua base de dados, sempre que você for criar um e-commerce para seu cliente, você precisa informar o ID do seu cliente na sua base de dados.
por exemplo, você tem 2 clientes na sua base de dados Cliente 01 : ID: 1001 Cliente 02 : ID: 1002, nesse caso o externalId será 1001 para o cliente 01 e 1002 para o cliente 02.
Atributos que contém external em seu nome são para identificar que os ID's passados serão da sua base de dados, isso facilita futuras buscas, pois você poderá fazer consultas através do seu ID uma vez que este está sob seu controle.
Atributos obrigatórios
São obrigatórios todos atributos marcados com * (asterisco).
| Atributos | Tipo | Descrição |
|---|---|---|
| env* | string | Tipo de envio que será feito. Os tipos de envio são: dev (Para quando for enviado para um ambiente de desenvolvimento) ou prod (Para quando for enviado para um ambiente de produção). ATENÇÃO, caso seja enviado para um ambiente de produção todas as transações serão debitadas ou creditadas |
| integrationToken* | string | Para se conectar com o e-vendi é necessário um token integrador, ele será passado como parâmetro para todos os requisitos |
| externalId* | string | Seu código de identificação no e-vendi |
Request body#
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| boleto | boleto | Informações sobre cobrança no boleto |
| pix | pix | Informações sobre cobrança no pix |
| creditCard | creditCard | Informações sobre cobrança no cartão de crédito |
boleto#
| Atributos | Tipo | Descrição |
|---|---|---|
| type | string | Informação sobre o tipo da cobraça, (valor ou porcentagem) |
| description | string | Descrição sobre a taxa e como é aplicada |
| fee | number | Valor/Porcentagem da taxa |
pix#
| Atributos | Tipo | Descrição |
|---|---|---|
| type | string | Informação sobre o tipo da cobraça, (valor ou porcentagem) |
| description | string | Descrição sobre a taxa e como é aplicada |
| fee | number | Valor/Porcentagem da taxa |
creditCard#
| Atributos | Tipo | Descrição |
|---|---|---|
| type | string | Informação sobre o tipo da cobraça, (valor ou porcentagem) |
| description | string | Descrição sobre a taxa e como é aplicada |
| rules | rules | Regras que serão aplicadas conforme a quantidade de parcelas |
rules#
| Atributos | Tipo | Descrição |
|---|---|---|
| description | string | Descrição sobre a taxa e como é aplicada |
| fee | number | Valor/Porcentagem da taxa |
| parcelStart | number | Número da parcela inicial |
| parcelEnd | number | Número da parcela final |
Exemplo
405#
Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico.
415#
Caso você receba um erro 415, certifique-se de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"