Parcelamento no cartão

Nesta seção explicamos um pouco sobre os recursos disponível para consultar os valores das parcelas e juros para a venda na forma de pagamento em cartão de crédito

Caso o Marketplace opte por processar o cartão de crédito utilizando o Gateway de pagamento da Fast Shop, deverá utilizar este endpoint para consultar as opções de parcelamento.

Este endpoint é uma etapa obrigatória para o faturamento com cartão, isto porque ao integrar o pedido será validado se os valores informados correspondem a opção se parcelamento definido.

Endpoint

Installment Credit Card

POST https://{environmentSeller}/pvt/payments/installments

Path Parameters

Name	Type	Description
{environmentSeller}*	string	URL da API do Seller

Headers

Name	Type	Description
X-VTEX-API-AppKey*	string	{{appKey}}
X-VTEX-API-AppToken*	string	{{appToken}}
Accept*	string	application/json
Content-Type*	string	application/json

200: OK Se a notificação for realizada com sucesso

Consulte o Swagger API

400: Bad Request Se a requisição não atender os requisitos mínimos

{
  "errorCode": "string",
  "message": "string"
}

401: Unauthorized Se a requisição não for autenticada

403: Forbidden As credenciais não estão ativas para acessar o serviço

429: Too Many Requests Muitos requests simultâneos

500: Internal Server Error Se ocorrer um erro no servidor

{
  "errorCode": "string",
  "message": "string"
}

Exemplo do Request

{
    "cardsBrand": [
        "VISA"
    ],
    "items": [
        {
            "id": "SGSMS908EZBCOB",
            "quantity": 2,
            "price": 100000
        },
        {
            "id": "LOVIBE100GFT",
            "quantity": 1,
            "price": 50080
        }
    ],
    "shippingData": {
        "logisticsInfo": [
            {
                "itemIndex": 0,
                "selectedSla": "KAIVEHUB_Normal_33",
                "price": 1000
            },
            {
                "itemIndex": 1,
                "selectedSla": "KAIVEHUB_Normal_33",
                "price": 1000
            }
        ]
    },
    "totalItemsValue": 250080,
    "totalFreigthValue": 2000,
    "totalCardPaymentValue": 252080
}

Exemplo do Response (200 - OK)

{
    "consultInstallments": [
        {
            "cardInfo": {
                "cardBrand": "VISA",
                "name": "Visa",
                "interestMonth": 179,
                "interestYear": 2373
            },
            "installments": [
                {
                    "installmentNumber": 1,
                    "value": 252080,
                    "interestValue": 0,
                    "interestMonth": 0,
                    "interestYear": 0,
                    "total": 252080
                },
                {
                    "installmentNumber": 2,
                    "value": 129408,
                    "interestValue": 6735,
                    "interestMonth": 179,
                    "interestYear": 2373,
                    "total": 258815
                },
                {
                    "installmentNumber": 3,
                    "value": 87029,
                    "interestValue": 9005,
                    "interestMonth": 179,
                    "interestYear": 2373,
                    "total": 261085
                }
            ]
        }
    ]
}

Descrições dos campos consulte o "Swagger API"

A API permite até 5 requisições por segundo, caso ultrapasse esse limite será retornado status 429: Too Many Request

Preeenchimento do Request:

• Para melhorar a performa da consulta recomendamos que informe a bandeira que será simulada preenchendo o campo "cardsBrand". Lembrando que o valor deste campo deve ser os disponíveis na "Lista de Bandeira de Cartão".
• Deverá ser informado todos os itens que constam no pedido, exatamente com as mesmas informações que serão preenchido na Criação de Pedido.
• Deverá ser informado as opções de frete selecionadas no Cálculo de Frete, preenchendo exatamente igual será repassado na Criação do Pedido.
• O campo "totalItemsValue" deverá ser a soma dos items = quantity * price

• O campo "totalFreigthValue" deverá ser a soma dos logisticsInfo = price

• o Campo "totalCardPaymentValue" será o valor do pedido que será utilizado para a simulação do parcelamento, podendo ser de R$ 0,01 até o Total dos Itens + Total de Frete. Com isto poderá ser faturado o pedido inteiro no cartão ou parcial, pagamento o restante na opção de pagamento "Pontos"

Informações importantes do Response:

• Será retornado uma lista de bandeiras solicitada na consulta ou todas caso não será informado o campo "cardsBrand"

• Para cada bandeira será retornado as opções de parcelamento no cartão. A quantidade de parcelas dependerá do disponibilizado pela Fast Shop no momento da consulta podendo variar para mais ou menos comparando com o exemplo acima.

• Quando o cliente optar por uma das opções, os campos "total" e "interestValue" deverão ser capturados e repassados na Criação do Pedido na condição de pagamento "credit_card":

  • consultInstallments: installments: total ==> paymentData: payments: value

  • consultInstallments: installments: interestValue ==> paymentData: payments: interestValue