CRIANDO UM BOLETO
Utilize este método para gerar boletos. A Nix trabalha atualmente com boletos da Caixa Econômica Federal.
DICA: Caso o estabelecimento opte em enviar boleto para o seu cliente, existem as opções de envio automático e manual.
Envio automático: Será necessário acessar as configurações do EC/aba boleto e habilitar o envio de boletos por e-mail, no body da transação deverá ser preenchido o campo e-mail com o e-mail do cliente, dessa forma ao fazer a transação o cliente irá receber o e-mail com o boleto.
Envio manual: Nesse caso não existe a necessidade de configurar previamente, esse método permite enviar a qualquer momento o boleto para o cliente. Para a opção de envio manual ACESSE AQUI.
Tipo de Operação: POST
/Orders/BoletoPayments/Issue
HEADER REQUEST:
BODY:
Body Request Modelo:
boletoPayment
{
"expirationDate": "2016-08-29T13:09:44.810Z",
"closePayment": "2022-09-30T13:35:40.100Z",
"demonstrative": [ "string" ],
"instructions": [ "string" ],
"merchantOrderId": "string",
"customer": {
"tag": "string",
"name": "string",
"identity": "string",
"identityType": "string",
"email": "string",
"birthdate": "string",
"address": {
"country": "string",
"zipCode": "string",
"number": "string",
"street": "string",
"complement": "string",
"city": "string",
"state": "string",
"neighborhood": "string"
}
},
"discount": {
"code": 1,
"date": "2020-12-01",
"value": 45
},
"fine": {
"code": 1,
"date": "2020-12-01",
"value": 2000
},
"interest": {
"code": 1,
"date": "2020-12-01",
"value": 300
},
"amount": 0,
"recurrence": {
"merchantPlanId": "string",
"startDate": "2016-08-29T13:09:44.811Z",
"endDate": "2016-08-29T13:09:44.811Z"
}
}
Status do boleto Status do boleto (paymentStatus) ao finalizar a requisição:
Indefinido - 0
Pago - 1
Em aberto - 2
Visualizado - 3
Cancelado - 5
Baixa/Baixado - 6
Vencido - 9
Aguardando registro - 11
Response Body/Callback Body:
{
"payment": {
"paymentStatus": 0,
"boleto": {
"amount": 0,
"expirationDate": "2016-08-29T13:09:44.856Z",
"boletoNumber": "string",
"digitableLine": "string"
},
"received": [{
"amount": 0,
"processedDate": "2016-08-29T13:09:44.856Z"
}],
"paymentToken": "string",
"recurrencePlan": {
"merchantPlanId": "string",
"name": "string",
"description": "string",
"interval": 1,
"amount": 0
},
"customer": {
"tag": "string",
"name": "string",
"identity": "string",
"identityType": "string",
"email": "string",
"birthdate": "string",
"address": {
"country": "string",
"zipCode": "string",
"number": "string",
"street": "string",
"complement": "string",
"city": "string",
"state": "string"
}
},
"invoice": {}
},
"merchantOrderId": "string" }