Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
  3. Descrição de Modalidade de Cobranças
    1. Descontos
    2. Multa
    3. Juro
    4. Abatimento

01. VISÃO GERAL

Este serviço cria uma cobrança PIX com Vencimento através da API padrão de Cobrança PIX com Vencimento definida pelo Banco Central.  Esse tipo de cobrança PIX funciona como um boleto, é possível informar data de vencimento, quantidade de dias após o vencimento em que o pagamento poderá ser realizado, juros, multa, desconto e abatimento.

  • Juros e multa incidem em pagamentos após o vencimento
  • Desconto e abatimentos incidem em pagamentos antes do vencimento 


Dica
titlePSPs Pagadores

Os PSPs pagadores, todos têm obrigação de realizar a leitura e o pagamento de QR Code e/ou Pix Copia e Cola de Cobranças PIX Com Vencimento.

Nota
titleBancos disponíveis

Atualmente, esse serviço está disponível no Payment Core somente para recebimentos através do Banco Itaú. Novos PSPs recebedores serão integrados à medida em que disponibilizarem esse serviço.

02. EXEMPLO DE UTILIZAÇÃO


Dica
titleGeração de novo pagamento

As informações de cobrança foram incluídas no mesmo POST utilizado hoje para gerar transações sem data de expiração.

Bloco de código
languagejs
{
  "externalBusinessUnitId": "123",
  "externalTransactionId": "16543419546226",
  "amount": 10,
  "currency": "BRL",
  "customer": {
    "email": "[email protected]",
    "locale": "BRL",
    "ssn": "88646743063", //obrigatório para PIX Cobrança
    "name": "Robson Dias" //obrigatório para PIX Cobrança
  },
  "externalPosId": "1",
  "wallet": "pix",
  "expirationDate": "01/03/2021 21:58 (UTC)",
  "due": { //caso esse campo seja preenchido, pelo menos um amountDetails deverá sem preenchido (discount byday, discount, fine, interest e rebate)
    "dueDate": "20/11/2021",
    "dayValidAfterDue": 5, //esse campo está disponível para informar quantos dias, após vencimento, o PIX Cobrança ficará disponível
    "amountDetails": {
      "discountByDay": {
        "value": 1,
        "modality": "AmountInAdvanceCalendarDay"
      },
      "discount": { //só é possível usar o discount ou discountbyday, não é possível utilizar em paralelo.
        "fixedDate": [
          {
            "date": "string",
            "value": 0
          }
        ],
        "modality": "string"
      },
      "fine": {
        "value": 20, 
        "modality": "Percentage"
      },
      "interest": {
        "value": 0.1,
        "modality": "AmountCalendarDay"
      },
      "rebate": {
        "value": 2,
        "modality": "FixedAmount"
      }
    }
  },
  "expandables": [
    "string"
  ]
}
Bloco de código
languagebash
titleExemplo cUrl
curl -X POST "http://qa.raas.varejo.totvs.com.br/transacting/api/v2/payment/link" -H "accept: application/json" -H "Authorization: {{TOKEN}}" -H "Content-Type: application/json-patch+json" -d "{\"externalBusinessUnitId\":\"string\",\"externalTransactionId\":\"string\",\"amount\":0,\"currency\":\"string\",\"customer\":{\"email\":\"string\",\"locale\":\"string\",\"ssn\":\"string\",\"name\":\"string\"},\"externalPosId\":\"string\",\"wallet\":\"string\",\"expirationDate\":\"01/03/2021 21:58 (UTC)\",\"due\":{\"dueDate\":\"string\",\"dayValidAfterDue\":0,\"amountDetails\":{\"discount\":{\"fixedDate\":[{\"date\":\"string\",\"value\":0}],\"modality\":\"string\"},\"fine\":{\"value\":0,\"modality\":\"string\"},\"interest\":{\"value\":0,\"modality\":\"string\"},\"rebate\":{\"value\":0,\"modality\":\"string\"}}},\"expandables\":[\"string\"]}"



03. DESCRIÇÃO DE MODALIDADES DE COBRANÇAS


ModalityDiscountByDayDescrição DescontosValor desejadoValor enviado via API
AmountInAdvanceCalendarDayValor por antecipação dia corridoR$ 20,0020
AmountInAdvanceBusinessDayValor por antecipação dia útilR$ 20,0020
PercentageInAdvanceCalendarDay*Percentual por antecipação dia corrido20%20
PercentageInAdvanceBusinessDay*Percentual por antecipação dia útil20%20
*o percentual nesse cenário deve ser preenchido absoluto, ex: 0,2 = 20%


ModalityDiscountDescrição DescontosValor desejadoValor enviado via API
FixedValueUntilInformedDateValor Fixo até a[s] data[s] informada[s]R$ 20,0020
PercentageUntilTheDateInformedPercentual até a data informada20%20



FineModalityDescrição MultaValor desejadoValor enviado via API
FixedAmountValor FixoR$ 20,0020
PercentagePercentual20%20



InterestModalityDescrição JuroValor desejadoValor enviado via API
AmountCalendarDayValor (dias corridos)R$ 20,0020
PercentagePerCalendarDayPercentual ao dia (dias corridos)20%20
PercentagePerCalendarMonthPercentual ao mês (dias corridos)20%20
PercentagePerCalendarYearPercentual ao ano (dias corridos)20%20
AmountBusinessDayValor (dias úteis)R$ 20,0020
PercentagePerBusinessDayPercentual ao dia (dias úteis)20%20
PercentagePerBusinessMonthPercentual ao mês (dias úteis)20%20
PercentagePerBusinessYearPercentual ao ano (dias úteis)20%20



RebateModalityDescrição Abatimento
FixedAmountValor Fixo
PercentagePercentual