API Reference

Para cadastrar os planos, é necessário especificar todas as taxas por bandeira. Cada bandeira tem suas próprias taxas e, ao inserir as taxas, serão utilizadas como parâmetros de comparação para validação.

Algumas informações para o cadastro:

  • O nome do plano deve ser é único.
  • Todo novo plano precisa de um plano base (que já está cadastrado e pode ser consultado)
  • Os planos bases (divididos por produto e prazo de antecipação) são gerados no seu cadastro e podem ser acessados pelo endpoint de consulta.
  • O produto e o prazo de antecipação devem ser especificados, caso sejam divergentes do plano base um erro será apresentado.
  • O campo schemes representam um arranjo de pagamento (Tipo de pagamento + Bandeira) e o Id de cada um deles são fornecidos pelo endpoint OPTIONS.
  • Todas as taxas por bandeiras devem ser informados, na ausência de algum um erro será apresentado.
  • As taxas são do tipo decimal, ou seja, você pode informar por exemplo: 1.90(1.90%) ou 2(2%).

Parar criar uma tabela para do tipo Merchant, é necessário criar uma do tipo Reseller antes e utilizá-la como base (basePlanId).

🚧

Plano base

Para preencher o campo basePlanId basta consultar os planos e pegar o Id do plano cadastrado com o valor Partner do campo type

Segue exemplo de uma requisição:

{
    "Name": "Plano tal",
    "product": "POS",
    "type": "Reseller",
    "basePlanId": 1,
    "settlementDays": 1,
    "schemes": [
        {
            "id": 1,
            "fees": [
                { "installments": 1, "rate": 0.3 }
            ]
        },
        {
            "id": 2,
            "fees": [
                { "installments": 1, "rate": 0.3 }
            ]
        },
        {
            "id": 3,
            "fees": [
                { "installments": 1, "rate": 0.3 }
            ]
        },
        {
            "id": 4,
            "fees": [
                { "installments": 1, "rate": 0.3 }
            ]
        },
        {
            "id": 5,
            "fees": [
                { "installments": 1, "rate": 0.3 }
            ]
        },
        {
            "id":6,
            "fees": [
                { "installments": 1, "rate": 3 },
                { "installments": 2, "rate": 4 },
                { "installments": 3, "rate": 5 },
                { "installments": 4, "rate": 6 },
                { "installments": 5, "rate": 7 },
                { "installments": 6, "rate": 8 },
                { "installments": 7, "rate": 9 },
                { "installments": 8, "rate": 10 },
                { "installments": 9, "rate": 11 },
                { "installments": 10, "rate": 12 },
                { "installments": 11, "rate": 13 },
                { "installments": 12, "rate": 14 },
                { "installments": 13, "rate": 15 },
                { "installments": 14, "rate": 16 },
                { "installments": 15, "rate": 17 },
                { "installments": 16, "rate": 18 },
                { "installments": 17, "rate": 19 },
                { "installments": 18, "rate": 20 }
            ]
        },
        {
            "id": 7,
            "fees": [
                { "installments": 1, "rate": 3 },
                { "installments": 2, "rate": 4 },
                { "installments": 3, "rate": 5 },
                { "installments": 4, "rate": 6 },
                { "installments": 5, "rate": 7 },
                { "installments": 6, "rate": 8 },
                { "installments": 7, "rate": 9 },
                { "installments": 8, "rate": 10 },
                { "installments": 9, "rate": 11 },
                { "installments": 10, "rate": 12 },
                { "installments": 11, "rate": 13 },
                { "installments": 12, "rate": 14 },
                { "installments": 13, "rate": 15 },
                { "installments": 14, "rate": 16 },
                { "installments": 15, "rate": 17 },
                { "installments": 16, "rate": 18 },
                { "installments": 17, "rate": 19 },
                { "installments": 18, "rate": 20 }
            ]
        },
        {
            "id": 8,
            "fees": [
                { "installments": 1, "rate": 3 },
                { "installments": 2, "rate": 4 },
                { "installments": 3, "rate": 5 },
                { "installments": 4, "rate": 6 },
                { "installments": 5, "rate": 7 },
                { "installments": 6, "rate": 8 },
                { "installments": 7, "rate": 9 },
                { "installments": 8, "rate": 10 },
                { "installments": 9, "rate": 11 },
                { "installments": 10, "rate": 12 },
                { "installments": 11, "rate": 13 },
                { "installments": 12, "rate": 14 },
                { "installments": 13, "rate": 15 },
                { "installments": 14, "rate": 16 },
                { "installments": 15, "rate": 17 },
                { "installments": 16, "rate": 18 },
                { "installments": 17, "rate": 19 },
                { "installments": 18, "rate": 20 }
            ]
        },
        {
            "id": 9,
            "fees": [
                { "installments": 1, "rate": 3 },
                { "installments": 2, "rate": 4 },
                { "installments": 3, "rate": 5 },
                { "installments": 4, "rate": 6 },
                { "installments": 5, "rate": 7 },
                { "installments": 6, "rate": 8 },
                { "installments": 7, "rate": 9 },
                { "installments": 8, "rate": 10 },
                { "installments": 9, "rate": 11 },
                { "installments": 10, "rate": 12 },
                { "installments": 11, "rate": 13 },
                { "installments": 12, "rate": 14 },
                { "installments": 13, "rate": 15 },
                { "installments": 14, "rate": 16 },
                { "installments": 15, "rate": 17 },
                { "installments": 16, "rate": 18 },
                { "installments": 17, "rate": 19 },
                { "installments": 18, "rate": 20 }
            ]
        },
        {
            "id": 10,
            "fees": [
                { "installments": 1, "rate": 3 },
                { "installments": 2, "rate": 4 },
                { "installments": 3, "rate": 5 },
                { "installments": 4, "rate": 6 },
                { "installments": 5, "rate": 7 },
                { "installments": 6, "rate": 8 },
                { "installments": 7, "rate": 9 },
                { "installments": 8, "rate": 10 },
                { "installments": 9, "rate": 11 },
                { "installments": 10, "rate": 12 },
                { "installments": 11, "rate": 13 },
                { "installments": 12, "rate": 14 },
                { "installments": 13, "rate": 15 },
                { "installments": 14, "rate": 16 },
                { "installments": 15, "rate": 17 },
                { "installments": 16, "rate": 18 },
                { "installments": 17, "rate": 19 },
                { "installments": 18, "rate": 20 }
            ]
        },
        {
            "id": 11,
            "fees": [
                { "installments": 1, "rate": 3 },
                { "installments": 2, "rate": 4 },
                { "installments": 3, "rate": 5 },
                { "installments": 4, "rate": 6 },
                { "installments": 5, "rate": 7 },
                { "installments": 6, "rate": 8 },
                { "installments": 7, "rate": 9 },
                { "installments": 8, "rate": 10 },
                { "installments": 9, "rate": 11 },
                { "installments": 10, "rate": 12 },
                { "installments": 11, "rate": 13 },
                { "installments": 12, "rate": 14 },
                { "installments": 13, "rate": 15 },
                { "installments": 14, "rate": 16 },
                { "installments": 15, "rate": 17 },
                { "installments": 16, "rate": 18 },
                { "installments": 17, "rate": 19 },
                { "installments": 18, "rate": 20 }
            ]
        }
    ]
}
Language
Click Try It! to start a request and see the response here!