API de Integração
Recebimentos

Consultar detalhe do recebimento

Consulta o detalhe de uma solicitação de crédito (venda).

GET
/receipts/detail/{CreditRequestId}

Autorização

apiToken
Api-Token<token>

Token do parceiro. Gere no painel do parceiro: Configurações > Integrações > API Token (perfil Admin ou Superadmin). Envie só este header: se Authorization também for enviado, ele tem prioridade e a requisição é recusada com 401.

Local: header

Parâmetros de Path

CreditRequestId*integer

ID da solicitação de crédito (venda).

Corpo da Resposta

application/json

application/json

application/json

curl -X GET "https://example.com/receipts/detail/0"
{  "creditRequestId": 123,  "name": "student_name",  "phone": "11912341234",  "address": "student_address",  "email": "8a567198f3@X9a4nA.com",  "productType": "MAAS",  "madeEffectiveDate": "2021-07-03",  "courses": [    {      "id": 21377,      "courseName": "course_name"    }  ],  "value": 198000,  "paidValues": 60882,  "paidValuesProvi": 0,  "TedDate": null,  "expectedTedDate": null,  "totalInstallments": 13,  "hasUpFront": true,  "faturaUrl": "",  "NFUrl": "",  "installments": [    {      "count": 1,      "originalValue": 15674,      "paidValue": 15674,      "proviComission": 784,      "receivedValue": 14890,      "status": "paid",      "dueDate": "2021-10-08",      "userPaidDate": "2021-04-08",      "agreementDate": "2021-10-08",      "delayedDays": null,      "expectedCompensationDate": null,      "compensationDate": null,      "withdrawDate": null    }  ],  "remaining_declarations": null,  "company_name": null,  "linkedin_url": null,  "startsAt": null,  "endsAt": null,  "bankslipValue": null,  "bankslipDueDate": null,  "bankslipPaidAt": null,  "bankslipStatus": null,  "chargeBack": {    "isChargeBack": false,    "data": []  },  "cancellation": {    "isCancellation": false,    "data": []  }}