Pagador e itens
Estruturas reutilizadas nos pagamentos PIX e cartão da My Gateway: dados do pagador (customer), itens e a regra de soma com desconto.
Nesta página
As estruturas desta página aparecem nos payloads de PIX e cartão. O fingerprint, também comum aos dois, está na documentação de Antifraude.
Pagador (customer)#
Atributos de customer
namestringobrigatórioNome completo. Informe ao menos nome e sobrenome.
documentstringobrigatórioCPF ou CNPJ válido, somente dígitos.
emailstringobrigatórioE-mail válido do pagador.
phoneNumberstringobrigatórioNúmero de telefone sem DDD.
phoneNumberDDDstringobrigatórioDDD do telefone, somente dígitos.
mobilePhoneNumberstringobrigatórioNúmero de celular sem DDD.
mobilePhoneNumberDDDstringobrigatórioDDD do celular, somente dígitos.
addressobjectobrigatórioEndereço de cobrança do pagador.
Atributos de address
streetstringobrigatórioLogradouro.
numberstringrecomendadoNúmero do imóvel. Use
S/Nquando aplicável.neighborhoodstringrecomendadoBairro.
zipcodestringobrigatórioCEP, de preferência só com dígitos.
citystringobrigatórioCidade.
complementstringopcionalComplemento do endereço.
statestringobrigatórioUF com duas letras, por exemplo
SP.countrystringobrigatórioCódigo ISO de duas letras, por exemplo
BR.
Exemplo de customer
{
"name": "Maria da Silva",
"document": "52998224725",
"email": "[email protected]",
"phoneNumber": "33334444",
"phoneNumberDDD": "11",
"mobilePhoneNumber": "999998888",
"mobilePhoneNumberDDD": "11",
"address": {
"street": "Rua Exemplo",
"number": "123",
"neighborhood": "Centro",
"zipcode": "01001000",
"city": "Sao Paulo",
"complement": "Apto 10",
"state": "SP",
"country": "BR"
}
}Itens (items)#
items precisa ter pelo menos um elemento.
Atributos de cada item
idUUIDobrigatórioIdentificador único do item no sistema do integrador.
namestringobrigatórioNome ou descrição do item. Não pode ser vazio.
valueintegerobrigatórioValor unitário em centavos. Maior que zero.
amountintegerobrigatórioQuantidade. Maior que zero.
Regra de soma#
Em PIX e cartão, a soma dos itens menos o desconto precisa ser igual ao valor total do pagamento:
Regra de fechamento
sum(item.value * item.amount) - discount = valor total do pagamentoExemplo: dois itens de R$ 60,00 e R$ 40,00 (6000 e 4000, com amount: 1), sem desconto, totalizam 10000.
Última atualização em
