Endpoint utilizado:
Tipo de Operação: GET
/Orders/BolePixPayments/{paymentToken}/email
Utilize este método para enviar bolepix por e-mail.
Dica: Caso o estabelecimento deseje o envio automático do bolepix por e-mail , o mesmo deverá habilitar na tela de configuração/aba boleto a opção de envio de boleto/bolepix por e-mail.
{
"mailTo": [
"string"
]
}
Indefinido - 0
Pago - 1
Em aberto - 2
Visualizado - 3
Cancelado - 5
Vencido - 9
Baixa - 6
Aguardando registro - 11
{
"merchantOrderId": "string",
"payment": {
"paymentToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recurrencePlan": {
"merchantPlanId": "RTMNj-ZseM_xSD_HLW5U9nVHkDy3WSj-JwxU",
"name": "string",
"description": "string",
"interval": 1,
"amount": 2147483647,
"items": [
{
"itemToken": "string",
"merchantOrderId": "string",
"merchantId": "string",
"recurrenceToken": "string",
"amount": 0,
"description": "string",
"closeDate": "2025-11-06T14:18:41.233Z",
"status": "string",
"isRecurrent": "string",
"quantity": 0,
"referenceId": "string",
"totalInstallments": 0,
"installmentNumber": 0
}
],
"created": "2025-11-06T14:18:41.233Z",
"active": true,
"isAutoRenewable": true,
"isAutoStarted": true,
"nextRecurrency": "2025-11-06T14:18:41.233Z"
},
"customer": {
"tag": "string",
"name": "string",
"identity": "string",
"identityType": "stri",
"email": "user@example.com",
"birthdate": "string",
"address": {
"country": "string",
"zipCode": "09292320",
"number": "string",
"street": "string",
"complement": "string",
"city": "string",
"state": "st",
"neighborhood": "string"
},
"dateOfBirth": "2025-11-06T14:18:41.233Z"
},
"writtenOffPayment": {
"paymentToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"descriptive": "string",
"transactionType": 1,
"writeOffStatus": "string",
"identifier": "string",
"writeOffDate": "2025-11-06T14:18:41.233Z"
},
"conciliationId": "string",
"merchantId": 0,
"amount": 0,
"referenceId": "string",
"paymentStatus": 0,
"bolePix": {
"amount": 0,
"expirationDate": "2025-11-06T14:18:41.233Z",
"emissionDate": "2025-11-06T14:18:41.233Z",
"boletoNumber": "string",
"document": "string",
"digitableLine": "string",
"hybridInstruction": [
{
"code": "string",
"status": 0,
"type": "string",
"date": "2025-11-06T14:18:41.233Z",
"value": "string"
}
],
"demonstrative": "string",
"qrCode": "string",
"decodedQrCode": "string",
"conciliationId": "string",
"txid": "string",
"location": "string",
"emv": "string",
"bankAgreement": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"bankCode": "string",
"branch": "string",
"accountNumber": "string"
}
},
"received": [
{
"amount": 0,
"abatement": 0,
"discount": 0,
"additions": 0,
"processedDate": "2025-11-06T14:18:41.233Z",
"creditDate": "2025-11-06T14:18:41.233Z",
"type": "string"
}
]
}
}