DVDPH-1602 PIX Cobrança

CONTEÚDO

Visão Geral
Exemplo de utilização
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

PSPs 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.

Bancos 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

Geraçã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.

{
  "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",
  "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"
  ]
}

Exemplo 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

ModalityDiscountByDay	Descrição Descontos	Valor desejado	Valor enviado via API
AmountInAdvanceCalendarDay	Valor por antecipação dia corrido	R$ 20,00	20
AmountInAdvanceBusinessDay	Valor por antecipação dia útil	R$ 20,00	20
PercentageInAdvanceCalendarDay*	Percentual por antecipação dia corrido	20%	20
PercentageInAdvanceBusinessDay*	Percentual por antecipação dia útil	20%	20

ModalityDiscount	Descrição Descontos	Valor desejado	Valor enviado via API
FixedValueUntilInformedDate	Valor Fixo até a[s] data[s] informada[s]	R$ 20,00	20
PercentageUntilTheDateInformed	Percentual até a data informada	20%	20

FineModality	Descrição Multa	Valor desejado	Valor enviado via API
FixedAmount	Valor Fixo	R$ 20,00	20
Percentage	Percentual	20%	20

InterestModality	Descrição Juro	Valor desejado	Valor enviado via API
AmountCalendarDay	Valor (dias corridos)	R$ 20,00	20
PercentagePerCalendarDay	Percentual ao dia (dias corridos)	20%	20
PercentagePerCalendarMonth	Percentual ao mês (dias corridos)	20%	20
PercentagePerCalendarYear	Percentual ao ano (dias corridos)	20%	20
AmountBusinessDay	Valor (dias úteis)	R$ 20,00	20
PercentagePerBusinessDay	Percentual ao dia (dias úteis)	20%	20
PercentagePerBusinessMonth	Percentual ao mês (dias úteis)	20%	20
PercentagePerBusinessYear	Percentual ao ano (dias úteis)	20%	20

RebateModality	Descrição Abatimento
FixedAmount	Valor Fixo
Percentage	Percentual

Árvore de páginas

DVDPH-1602 PIX Cobrança

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

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