Listar recebimentos

Lista os recebimentos do parceiro, por solicitação de crédito. Limite: 10 requisições por segundo por IP; acima disso a resposta é 429. Datas no formato `AAAA-MM-DD`. Os filtros `status`, `productType`, `courseId`, `delayedDay`, `delayedInstallment` e `campaign` podem ser repetidos. Veja os valores aceitos em **Listar filtros de recebimentos**.

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 Query

page?string

Página (começa em 1).

limit?string

Itens por página.

CreditRequestId?string

ID da venda.

cpf?string

CPF do aluno.

email?string

E-mail do aluno.

name?string

Nome do aluno.

status?array<string>

Situação.

productType?array<string>

Tipo de produto.

courseId?array<string>

ID do curso.

delayedDay?array<string>

Dias de atraso.

delayedInstallment?array<string>

Parcelas em atraso.

campaign?array<string>

Nome da campanha.

campaignCustomIdentifier?string

Identificador próprio da campanha.

startEffectiveDate?string

Efetivação, data inicial.

endEffectiveDate?string

Efetivação, data final.

startReleaseDate?string

Liberação do curso, data inicial.

endReleaseDate?string

Liberação do curso, data final.

startPaymentDate?string

Próximo pagamento, data inicial.

endPaymentDate?string

Próximo pagamento, data final.

startAgreementDate?string

Acordo, data inicial.

endAgreementDate?string

Acordo, data final.

startExpectedTransferDate?string

Repasse previsto, data inicial.

endExpectedTransferDate?string

Repasse previsto, data final.

startTransferDate?string

Repasse realizado, data inicial.

endTransferDate?string

Repasse realizado, data final.

chargebacks?string

Só vendas com chargeback. Qualquer valor liga o filtro (inclusive false); para desligar, omita o parâmetro.

cancellations?string

Só vendas com cancelamento. Qualquer valor liga o filtro (inclusive false); para desligar, omita o parâmetro.

Corpo da Resposta

`application/json`

curl -X GET "https://example.com/receipts?page=2&limit=1"

{  "paging": {    "itemsPerPage": 1,    "nextPage": 3,    "currentPage": 2,    "previousPage": 1,    "totalPages": 10,    "totalItems": 10  },  "content": [    {      "crid": 123,      "campaignName": null,      "redirectUrl": "https://pay.provi.com.br/business_slug",      "email": "123@123.com",      "productType": "CourseFinancing",      "name": "Student name",      "phone": "11912341234",      "status": "effective",      "hostingStatus": "host_not_connected",      "nextPaymentDate": null,      "courseReleasedAt": null,      "courses": [        {          "id": 123,          "name": "Course name",          "isFullTime": false,          "modality": "remoto",          "price": 117480        }      ],      "saleValue": 117480,      "cpf": "12312312312",      "madeEffectiveDate": "2021-11-06",      "commission": {        "value": 18797,        "percentage": 16      },      "receivedValue": 98683,      "missingValue": 0,      "transferDate": "2021-12-09",      "installmentCount": {        "current": {          "upfront": 1,          "installments": 12        },        "paid": 2,        "late": null      },      "lateDays": null,      "agreementDate": null,      "installmentValue": 9305,      "address": {        "street": "Rua do aluno",        "number": "1",        "complement": "complmento como casa ou apartamento",        "district": "Bairo",        "cep": "12312312",        "city": "São Paulo",        "state": "SP"      },      "pfCount": 1,      "nextPaymentInstallmentId": 6226438,      "expectedTransferDate": "2021-12-10",      "showFullPlatformDetails": false,      "showPlatformDetails": false,      "comment": null,      "expectedTedValue": 98683,      "originalInstallmentsValue": null,      "originalNumberOfInstallments": null,      "isRenegotiated": false    }  ]}

Autorização

Parâmetros de Query

Corpo da Resposta

200application/json

401application/json

429application/json

`application/json`

`application/json`

`application/json`