{"info":{"_postman_id":"1d669616-507d-4978-ad7a-ff4b84a77915","name":"API Provi","description":"

For documentation regarding previous and deprecated endpoints resources, please visit this page.

Overview

Provi API is based on REST principles. Data resources are accessed via standard HTTPS requests. Where possible, our API uses appropriate HTTP verbs for each action.

For any questions, suggestions or feedback about our APIs please contact us at tech-support@provi.com.br or suporte-tecnologia@provi.com.br

We will get back to you as soon as possible.

Base URL

The API is accessed using a base URL that changes according to the environment you want to use.

Environment subdomain:

Development environment is: ms-checkout-staging
Production environment is: ms-checkout

base_url is: https://{{environment_subdomain}}.provi.com.br

URL path must begin with the API version followed by API resource. All API calls should be made over HTTPS.

The complete URL will have the following structure:

https://{{environment_subdomain}}.provi.com.br/{{api_version}}/{{resource}}.

Authentication

All requests to the API are authenticated by providing your API key. The API key should be provided as an HTTP header named Api-Token

curl -H \"Api-Token: YOUR_TOKEN\" https://ms-checkout.provi.com.br/v4/...

Where to find the api-token

Access https://painel.provi.com.br/ using an account with administrator permission.
Go to \"desenvolvimento\" at the left sidebar menu.
Click on the generate button and then on the copy button to copy the api-token to your clipboard

Guidance

Use v4 as {{api_version}}. Resources and routes not documented here have been deprecated and will no longer be mantained.
For documentation regarding previous and deprecated endpoints resources, please visit this page.
Email us at tech-support@provi.com.br or suporte-tecnologia@provi.com.br if you have any issue.

Status explained

Statuses represent the flow of the credit request, from the start of the purchase to the fulfillment of the payment.

Sales funil status

You will find those status on Panel Dashboard or received webhooks:

not_logged: a checkout was created for a given student, but the student has not yet logged in.
basic_info_incomplete: the user logged into the platform, but their basic info is incomplete.
basic_info_review: the user's basic info is being reviewed by our team.
document_info_incomplete: the user still needs to send us some documents.
document_info_review: all documents have been sent and are under review. We will run an automatic credit check on the user, which will determine if they need to indicate a guarantor for the financing process.
analysis: the financing couldn’t be automatically approved, so it was sent to be analysed by Provi’s credit team.
guarantor_needed: the user needs to indicate a person to be their guarantor.
guarantor_incomplete: a guarantor was indicated, but they haven’t completed the required steps on Provi’s Guarantor platform yet.
guarantor_review: the guarantor information is being analysed by our team.
approved_by_provi: the ISA credit request was approved by Provi, but still needs the partner’s approval.
not_approved_by_provi: the ISA credit request was not fully approved or was reproved by Provi, but the partner is yet to analyse it.
waiting_signature: student and guarantor, if applicable, have received the contract via email and need to sign it.
abandonment_before_signed: the student reached the document signing stage, but did not proceed.
isa_abandonment_after_signed: a ISA student did not proceed after signing the contract.
abandonment_after_signed: the student signed the contract but did not make the first payment.
approved: the credit request has been approved.
abandonment_after_upfront: the student made the first payment, but decided not to proceed with the process.
abandonment_after_settled: the credit request was canceled after the partner received the payment from Provi.
link_inactive: the partner canceled the checkout before the user accessed Provi's platform.
expired: the user’s checkout expired before the user logged in.
denied: Provi was unable to approve the user’s financing.
waiting_payment: the student made the purchase using a credit card and their funding information was accepted, but is undergoing a process of risk analysis to authorize the payment, or the student made the purchase with a bank billet, which can take up to three working days to be confirmed by the bank after it was paid.
made_effective: the credit request was consolidated and the student is active.
isa_default: Provi's team identified the ISA student as irregular.
logged: the user logged into the platform.

Snapshot explained

Every exclusive-sale and webhook contains a snapshot. In order to interpret it, you need to understand the checkout process within the Provi system.

The user journey inside Provi’s platform is:

log into Provi’s platform.
\n
fill in the user’s basic_info - email, full name, birth date, phone number, level of schooling, income, etc. After this is done, we will run an automatic credit check, which will determine if the user needs to indicate a guarantor for the financing process. If a guarantor is needed, the guarantor_status shown on the snapshot will be updated to needed and the user will need to indicate a person to be their guarantor after filling the documents. After a guarantor is indicated, they will need to access Provi’s Guarantor platform and provide their basic info and documents as well. The checkout cannot be approved before this happens. If a guarantor is not needed, the default guarantor_status on the snapshot will be unneeded and the checkout will be approvable after the user sent their documents to Provi.
\n
send the required documents (selfie, personal ID, proof of address). After this is done, there is a fork on the user flow: if the user has guarantor_status = needed, they will be asked to indicate a guarantor; if the user’s guarantor_status = unneeded, the checkout request will be either automatically approved (if the documentation is correctly filled and successfully interpreted by our machine learning model), or sent to be manually analyzed by Provi’s credit team.
\n
the user that needs a guarantor will only be analysed by Provi’s credit team after their indicated guarantor completed the required steps on Provi’s Guarantor platform.
\n
after the checkout goes to analysis, it will either be approved (a financing contract will be sent to the user), denied (Provi was unable to approve the user’s financing) or canceled (the user has decided not to go on with the checkout and financing process).
\n
if the user is approved, they will receive a DocuSign contract on their email. Once the user (and the guarantor if it is the case) signs the contract, the checkout will be considered signed and there will be a signed_date.
\n
after the contract is signed, the user will be able to access Provi’s User Dashboard to view the active financing and to download their bank slips. Once the first installment is paid, there will be a first_installment_paid_date.
\n
when Provi asks the bank to wire transfer the payment to the partner, the date of the request will be recorded on the transferred_at field.
\n
when the bank confirms that the payment Provi sent to the partner was successful, the date will be recorded on the settled_at field.
\n

Snapshot’s status:

not_logged – the user has not yet logged in
\n
expired – the user’s checkout has expired before the user logged in
\n
incomplete – the user or their guarantor has not yet finished to fill in all the mandatory information
\n
analysis – Provi’s credit team is analyzing the credit request
\n
canceled – the user decided not to go on with the checkout
\n
canceled_by_partner – the partner canceled the checkout before the user logged in
\n
canceled_after_signed – the checkout was canceled after the user signed the contract with Provi
\n
canceled_after_settled – the checkout was canceled after the partner received the money from Provi
\n
denied – Provi was unable to approve the user’s checkout
\n
approved – Provi has approved the user’s checkout
\n
waiting_contract – the user’s contract is being generated by DocuSign
\n
waiting_signature – user and guarantor, if applicable, have received the contract via email, but not yet signed
\n
signed – user and guarantor, if applicable, have signed the contract
\n
transferred – Provi has sent the partner the wire transfer regarding the checkout
\n
settled – the partner has successfully received Provi’s transfer regarding the checkout
\n

The basic_info_status can be:

incomplete – the user has not yet filled their information
\n
review – the user needs to correct their information
\n
analysis – Provi is analyzing the user's information
\n
approved – Provi has approved the user's information
\n

The document_status can be:

incomplete – the user has not yet provided the documents
\n
review – the user needs to resend one or more documents
\n
analysis – Provi is analyzing the user's documents
\n
approved – Provi has approved the user's documents
\n

The guarantor_status can be:

unneeded – the user does not need to indicate a guarantor
needed – the user needs to indicate a guarantor, but hasn't yet
incomplete – the indicated guarantor hasn't filled in their information yet
review – the indicated guarantor needs to correct their information
analysis – Provi is analyzing the guarantor's information
approved – Provi has approved the guarantor

The signed_date can be:

null
date in which the financing contract was signed by both the user and guarantor, if applicable

The first_installment_paid_date can be:

null
date in which the first installment from the financing was paid by the user

The transferred_at can be:

null
date in which Provi asked the bank to wire transfer the payment to the partner

The settled_at can be:

null
date in which the payment transfer to the partner was confirmed by the bank

The snapshot is a picture of the checkout from a student at any given time.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Status explained","slug":"status-explained"},{"content":"Snapshot explained","slug":"snapshot-explained"}],"owner":"12316037","collectionId":"1d669616-507d-4978-ad7a-ff4b84a77915","publishedId":"T1LLDSk8","public":true,"customColor":{"top-bar":"FFF","right-sidebar":"01163E","highlight":"DE0C4B"},"publishDate":"2020-08-10T18:08:12.000Z"},"item":[{"name":"Courses","item":[{"name":"Create a new course","id":"6ff041c5-5266-4b26-b506-99546e941b5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"MicroAreaId\": 14,\n \"description\": \"A cool course description to be visible to student\",\n \"hasSelectionProcess\": false,\n \"name\": \"Curso de Janeiro\",\n \"price\": 2000,\n \"visible\": true,\n \"workload\": 200,\n \"internalPartnerProductId\": \"courseSKU\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/courses","description":"

To create a course, you must know to which MicroArea it belongs to. To get this information, please refer to the \"Avaiable Areas\" section.

Please notice that all the parameters, with the exception of InternalPartnerProductId, are mandatory. Though it is optional, we highly recommend you register this information if the course you're creating corresponds to a specific product in your database.

\n","urlObject":{"path":["{{api_version}}","courses"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"dcace1e8-0da2-4fd9-8a81-313fd0a1cf52","name":"Create a new course","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"MicroAreaId\": 14,\n \"description\": \"A cool course description to be visible to student\",\n \"hasSelectionProcess\": false,\n \"name\": \"Curso de Teste\",\n \"priceInCents\": 200000,\n \"visible\": true,\n \"workload\": 200,\n \"internalPartnerProductId\": \"courseSKU\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/courses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"content\": {\n \"priceInCents\": 200000,\n \"ProductType\": \"CourseFinancing\",\n \"id\": 123,\n \"name\": \"Curso de Teste\",\n \"description\": \"A cool course description to be visible to student\",\n \"active\": true,\n \"showOnWebsite\": true,\n \"MicroAreaId\": 14,\n \"workload\": 200,\n \"creator\": \"employee_email@email.com\",\n \"hasSelectionProcess\": false,\n \"paymentMethod\": null,\n \"internalPartnerProductId\": \"courseSKU\",\n \"CourseClasses\": []\n }\n}"},{"id":"e8637109-10bd-410b-9b09-ad00d4f6120b","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"MacroAreaId\": 2,\n \"MicroAreaId\": 14,\n \"description\": \"A cool course description to be visible to student\",\n \"hasSelectionProcess\": false,\n \"name\": \"Curso de Janeiro\",\n \"price\": 2000,\n \"visible\": true,\n \"workload\": 200\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"BodyPropertyError\",\n \"message\": \"Course already exist.\",\n \"stack\": \"Error\\n at new BodyPropertyError (/app/src/app/errors/bodyPropertyError/index.js:12:18)\\n at Object.create (/app/src/app/services/courseService/v2/create/index.js:29:13)\\n at runMicrotasks ()\\n at processTicksAndRejections (internal/process/task_queues.js:97:5)\"\n }\n}"}],"_postman_id":"6ff041c5-5266-4b26-b506-99546e941b5b"},{"name":"Delete course","id":"029756a9-c68d-4d2b-857c-c158eb2d9d2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/courses/:id","description":"

Delete a specifict course by ID

\n","urlObject":{"path":["{{api_version}}","courses",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"db10b8b8-e278-4803-87ce-8f38a376abc7","type":"any","value":null,"key":"id"}]}},"response":[{"id":"cc20c5f7-f847-4b7f-9a38-38434d9682b2","name":"Delete course","originalRequest":{"method":"DELETE","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{base_url}}/{{api_version}}/courses/:id","host":["{{base_url}}"],"path":["{{api_version}}","courses",":id"],"variable":[{"key":"id","value":null}]}},"status":"No Content","code":204,"_postman_previewlanguage":"","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"029756a9-c68d-4d2b-857c-c158eb2d9d2e"},{"name":"Update Course","id":"16444d9b-5c57-45c9-aa48-22112ee6387e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"visible\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/courses/:id","description":"

Change one specific course to visible or invisible.

\n","urlObject":{"path":["{{api_version}}","courses",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"7c8f9ccd-4f99-47e1-bacf-df1472135f40","type":"any","value":null,"key":"id"}]}},"response":[{"id":"833edafc-64b1-4833-bbe7-c5695fafd208","name":"Update Course","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"visible\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/{{api_version}}/courses/:id","host":["{{base_url}}"],"path":["{{api_version}}","courses",":id"],"variable":[{"key":"id","value":null}]}},"status":"No Content","code":204,"_postman_previewlanguage":"","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"16444d9b-5c57-45c9-aa48-22112ee6387e"},{"name":"List all Courses","id":"7c49a3ed-c597-47fb-a16a-141f1b653009","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/courses?page=1&itemsPerPage=50","description":"

Lists all the partner's courses

\n","urlObject":{"path":["{{api_version}}","courses"],"host":["{{base_url}}"],"query":[{"key":"page","value":"1"},{"key":"itemsPerPage","value":"50"}],"variable":[]}},"response":[{"id":"bf050d4c-daff-4640-8c5e-20571bf85066","name":"List all Courses","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{base_url}}/{{api_version}}/courses?page=1&itemsPerPage=50","host":["{{base_url}}"],"path":["{{api_version}}","courses"],"query":[{"key":"page","value":"1"},{"key":"itemsPerPage","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"paging\": {\n \"itemsPerPage\": 1,\n \"nextPage\": null,\n \"currentPage\": 1,\n \"previousPage\": null,\n \"totalPages\": 1,\n \"totalItems\": 1\n },\n \"metadata\": {\n \"redirect_url\": \"https://pay.provi.com.br/courses/school-name\"\n },\n \"content\": [\n {\n \"priceInCents\": 20000,\n \"id\": 123,\n \"name\": \"Curso Teste\",\n \"active\": true,\n \"showOnWebsite\": true,\n \"paymentMethod\": null,\n \"description\": \"A cool course description to be visible to student\",\n \"workload\": 200,\n \"hasSelectionProcess\": false,\n \"creator\": \"partner_employee@email.com\",\n \"internalPartnerProductId\": null,\n \"ProductType\": \"CourseFinancing\",\n \"gracePeriod\": 0,\n \"createdAt\": \"2022-01-22T23:07:52.139Z\",\n \"updatedAt\": \"2022-01-22T23:07:52.140Z\",\n \"MicroArea\": {\n \"id\": 14,\n \"name\": \"Gerenciamento de Projetos\"\n },\n \"CourseClasses\": []\n }\n ]\n}"}],"_postman_id":"7c49a3ed-c597-47fb-a16a-141f1b653009"},{"name":"Find course","id":"e2b72c5a-22b3-4f25-bc7c-079554f8506a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/courses/:id","description":"

Find a specific course by ID.

\n","urlObject":{"path":["{{api_version}}","courses",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"a5dfb30c-6279-440f-a46f-79987c4cee68","type":"any","value":null,"key":"id"}]}},"response":[{"id":"40160d68-56ca-4939-8796-dc8b012ec2e3","name":"Find course","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{base_url}}/{{api_version}}/courses/:id","host":["{{base_url}}"],"path":["{{api_version}}","courses",":id"],"variable":[{"key":"id","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"metadata\": {\n \"sales\": {\n \"waiting_payment\": 0,\n \"waiting_signature\": 0\n },\n \"receipts\": {\n \"made_effective\": 0,\n \"canceled\": 0\n },\n \"redirect_url\": \"https://pay.provi.com.br/courses/school-name\"\n },\n \"content\": {\n \"priceInCents\": 20000,\n \"id\": 33954,\n \"name\": \"Curso Teste\",\n \"active\": true,\n \"showOnWebsite\": true,\n \"obsolete\": false,\n \"paymentMethod\": null,\n \"description\": \"A cool course description to be visible to student\",\n \"workload\": 200,\n \"hasSelectionProcess\": false,\n \"creator\": \"partner_employee@email.com\",\n \"internalPartnerProductId\": null,\n \"ProductType\": \"CourseFinancing\",\n \"createdAt\": \"2022-01-22T23:07:52.139Z\",\n \"updatedAt\": \"2022-01-22T23:07:52.140Z\",\n \"CourseClasses\": [],\n \"gracePeriodDays\": 7,\n \"MicroArea\": {\n \"id\": 14,\n \"name\": \"Gerenciamento de Projetos\"\n },\n \"MacroArea\": {\n \"id\": 2,\n \"name\": \"Negócios, Vendas e Finanças\"\n }\n }\n}"}],"_postman_id":"e2b72c5a-22b3-4f25-bc7c-079554f8506a"}],"id":"ad3f8e3e-8f86-4924-ab47-df3703766160","description":"

A course is considered an asset that represents the essence of what will be sold, not what will actually be sold. Therefore, when creating a course you define only essential data such as name, maximum price and description.

Any data referring to variations of this course, such as lower prices, different schedules, or different subscription plans, must be configured as a classes, which is further detailed in the course-classes endpoint.

\n","_postman_id":"ad3f8e3e-8f86-4924-ab47-df3703766160"},{"name":"Course-Classes","item":[{"name":"Create Course-Class","id":"aa4a95bd-df9a-43a7-a20d-4c121483f56a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CourseClassAttendTypeId\": 2,\n \"CourseClassModalityId\": 1,\n \"CourseClassTypeId\": 1,\n \"CourseId\": \"33954\",\n \"endsAt\": \"2022-06-23\",\n \"expiresAt\": \"2022-02-27T00:00:00.000Z\",\n \"gracePeriodDays\": 7,\n \"name\": \"Turma teste Inicio programado\",\n \"visible\": true,\n \"priceInCents\": 18000,\n \"startsAt\": \"2022-02-23\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/course-classes","description":"

A class allows for many variations, which comes with a somewhat complex set of rules.

There are a few parameters that are mandatory at all times:

- CourseId
- name
- visible
- CourseClassTypeId
- CourseClassModalityId
- CourseClassAttendTypeId

The last three of those parameters will dictate which of the others parameters are necessary, but it is easier to think in terms of what each of them represents. You can refer to the table above for a relation of available properties and its meanings.

First, you must decide the type of the class. Will it be available for a closed period (CourseClassTypeId 1) or will it be a subscription (CourseClassTypeId 2)? If it is a closed period type of class, you must provide a startAt date and endsAt date. If it is a subscription type of class, you must provide the duration of the subscription (durationTime and CourseClassDurationId). If the subscription offers life time access (CourseClassDurationId 5), there is no need to send a durationTime.

Then you need to decide the modality of the class. Will it be offered remotly (CourseClassModalityId 1), in person (CourseClassModalityId 3) or in a hybrid way (CourseClassModalityId 3)? And how will the classes be attended? Will they be live (CourseClassAttendTypeId 1), on-demand (CourseClassAttendTypeId 2) or a mix of both (CourseClassAttendTypeId 3)?

If they must be partially or totally attended in person, you must provide the CampusId of a previously registered campus, and inform if the classes are fulltime (CourseClassPeriodId 1) or part-time (CourseClassPeriodId 2). If they are part time, you must also inform the time of the day (CourseClassTimeId) in which the classes will be offered - at morning (CourseClassTimeId 1), afternoon (CourseClassTimeId 2) or night (CourseClassTimeId 3).

To sumarize, the following parameters may be mandatory depending on the type and modality of the class:

- startAt
- endsAt
- CourseClassDurationId
- durationTime
- CampusId
- CourseClassPeriodId- CourseClassTimeId

There are also other completely optional parameters:

- priceInCents
- gracePeriodDays
- expiresAt
- partnerSKU

If the priceInCents is not provided, it will be the same as the course's price, but if it is provided, it cannot surpass the course's value or be lower than R$ 30,00 (3000 cents). In the same way, the gracePeriodDays can never be less than the course's grace period or the partner's default grace period, if the course doesn't have one. If it is not provided, it will be the same as the course's or partner's grace period.

The expiresAt determines a date at which the class will automatically become invisible, that is, no longer be shown at Provi's website.

And finally, the partnerSKU is available for you to inform the key by which the class is known in your own database. We highly recommend you provide it.

\n","urlObject":{"path":["{{api_version}}","course-classes"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9877311c-1459-4aeb-9bc4-88c4c7e1d393","name":"Create Course-Class","originalRequest":{"method":"POST","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CourseClassAttendTypeId\": 2,\n \"CourseClassModalityId\": 1,\n \"CourseClassTypeId\": 1,\n \"CourseId\": \"33954\",\n \"endsAt\": \"2022-06-23\",\n \"expiresAt\": \"2022-02-27T00:00:00.000Z\",\n \"gracePeriodDays\": 7,\n \"name\": \"Turma teste\",\n \"priceInCents\": 18000,\n \"startsAt\": \"2022-02-23\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/course-classes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"content\": {\n \"createdAt\": \"2022-02-23T00:34:13.015Z\",\n \"updatedAt\": \"2022-02-23T00:34:13.015Z\",\n \"active\": true,\n \"visible\": true,\n \"id\": 123,\n \"CourseId\": 123,\n \"CourseClassDurationId\": null,\n \"CourseClassTypeId\": 1,\n \"CourseClassModalityId\": 1,\n \"CourseClassAttendTypeId\": 2,\n \"CourseClassPeriodId\": null,\n \"CourseClassTimeId\": null,\n \"CampusId\": null,\n \"name\": \"Turma teste\",\n \"partnerSKU\": null,\n \"durationTime\": null,\n \"priceInCents\": 18000,\n \"gracePeriodDays\": 7,\n \"startsAt\": \"2022-02-23\",\n \"endsAt\": \"2022-06-23\",\n \"expiresAt\": \"2022-02-27T00:00:00.000Z\"\n }\n}"},{"id":"bd3e26d0-d7bc-4aa3-bdfc-a4f33aa70509","name":"Create Course-Class Presencial","originalRequest":{"method":"POST","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CampusId\": 123,\n \"CourseClassAttendTypeId\": 1,\n \"CourseClassDurationId\": 5,\n \"CourseClassModalityId\": 3,\n \"CourseClassPeriodId\": 1,\n \"CourseClassTimeId\": 3,\n \"CourseClassTypeId\": 2,\n \"CourseId\": \"33954\",\n \"gracePeriodDays\": 7,\n \"name\": \"Turma Presencial\",\n \"priceInCents\": 20000\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/course-classes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\"content\":\n{\"createdAt\":\"2022-01-23T06:07:29.992Z\",\n\"updatedAt\":\"2022-01-23T06:07:29.992Z\",\n\"active\":true,\n\"visible\":true,\n\"id\":123,\n\"CourseId\":123,\n\"CourseClassDurationId\":5,\n\"CourseClassTypeId\":2,\n\"CourseClassModalityId\":3,\n\"CourseClassAttendTypeId\":1,\n\"CourseClassPeriodId\":1,\n\"CourseClassTimeId\":3,\n\"CampusId\":123,\n\"name\":\"Turma Presencial\",\n\"partnerSKU\":null,\n\"durationTime\":null,\n\"priceInCents\":20000,\n\"gracePeriodDays\":7,\n\"startsAt\":null,\n\"endsAt\":null,\n\"expiresAt\":null\n}\n}"}],"_postman_id":"aa4a95bd-df9a-43a7-a20d-4c121483f56a"},{"name":"List all Course-Classes","id":"58d08021-4c71-486e-a2c1-311a0240e01b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/course-classes?CourseId=123","description":"

It lists all the classes related to a specific course, whose id must be provided. Additionaly, you can filter the classes by visibility, and choose the pagination parameters.

\n","urlObject":{"path":["{{api_version}}","course-classes"],"host":["{{base_url}}"],"query":[{"key":"CourseId","value":"123"},{"disabled":true,"key":"visible","value":"true"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"itemsPerPage","value":"50"}],"variable":[]}},"response":[{"id":"87b1689b-6b0d-4d58-b61c-d18ec8337f32","name":"List all Course-Classes","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{api_version}}/course-classes?CourseId=123","host":["{{base_url}}"],"path":["{{api_version}}","course-classes"],"query":[{"key":"CourseId","value":"123"},{"key":"visible","value":"true","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"paging\": null,\n \"content\": [\n {\n \"id\": 1,\n \"active\": true,\n \"visible\": true,\n \"name\": \"Turma teste 1\",\n \"startsAt\": null,\n \"endsAt\": null,\n \"expiresAt\": null,\n \"durationTime\": null,\n \"priceInCents\": 185000,\n \"gracePeriodDays\": 0,\n \"partnerSKU\": null,\n \"createdAt\": \"2021-10-06T19:16:12.383Z\",\n \"updatedAt\": \"2021-10-06T19:16:12.383Z\",\n \"CourseClassType\": null,\n \"CourseClassDuration\": null,\n \"CourseClassAttendType\": null,\n \"CourseClassModality\": {\n \"id\": 1,\n \"name\": \"online\"\n },\n \"CourseClassPeriod\": {\n \"id\": 2,\n \"name\": \"integral\"\n },\n \"CourseClassTime\": null,\n \"Campus\": null,\n \"Course\": {\n \"id\": 123,\n \"name\": \"Curso teste\"\n }\n },\n {\n \"id\": 2,\n \"active\": true,\n \"visible\": true,\n \"name\": \"Turma teste 2\",\n \"startsAt\": null,\n \"endsAt\": null,\n \"expiresAt\": null,\n \"durationTime\": 1,\n \"priceInCents\": 185000,\n \"gracePeriodDays\": 7,\n \"partnerSKU\": null,\n \"createdAt\": \"2022-02-07T23:40:53.118Z\",\n \"updatedAt\": \"2022-02-07T23:40:53.118Z\",\n \"CourseClassType\": {\n \"id\": 2,\n \"name\": \"plano\"\n },\n \"CourseClassDuration\": {\n \"id\": 4,\n \"name\": \"ano(s)\"\n },\n \"CourseClassAttendType\": {\n \"id\": 2,\n \"name\": \"sob demanda\"\n },\n \"CourseClassModality\": {\n \"id\": 1,\n \"name\": \"online\"\n },\n \"CourseClassPeriod\": null,\n \"CourseClassTime\": null,\n \"Campus\": null,\n \"Course\": {\n \"id\": 123,\n \"name\": \"Curso teste\"\n }\n }\n ]\n}"}],"_postman_id":"58d08021-4c71-486e-a2c1-311a0240e01b"},{"name":"Find Course-Class","id":"5bf4b110-74a3-43f0-8a69-46bebaacf450","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/course-classes/:id","urlObject":{"path":["{{api_version}}","course-classes",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"9ba0b5d0-a88b-4231-894a-0692f2689913","type":"any","value":"1","key":"id"}]}},"response":[{"id":"7efc450f-f5bf-42c8-aba5-6bfafdbe034a","name":"Find Course-Classes","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{base_url}}/{{api_version}}/course-classes/:id","host":["{{base_url}}"],"path":["{{api_version}}","course-classes",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"metadata\": {\n \"sales\": {\n \"waiting_payment\": 0,\n \"waiting_signature\": 0\n },\n \"receipts\": {\n \"made_effective\": 0,\n \"canceled\": 0\n },\n \"redirect_url\": \"https://pay.provi.com.br/checkout/school-name?courses=%5B123%5D\"\n },\n \"content\": {\n \"id\": 1,\n \"active\": true,\n \"visible\": true,\n \"name\": \"Turma teste\",\n \"startsAt\": null,\n \"endsAt\": null,\n \"expiresAt\": null,\n \"durationTime\": null,\n \"priceInCents\": 185000,\n \"gracePeriodDays\": 0,\n \"partnerSKU\": null,\n \"createdAt\": \"2021-10-06T19:16:12.383Z\",\n \"updatedAt\": \"2021-10-06T19:16:12.383Z\",\n \"CourseClassType\": null,\n \"CourseClassDuration\": null,\n \"CourseClassAttendType\": null,\n \"CourseClassModality\": {\n \"id\": 1,\n \"name\": \"online\"\n },\n \"CourseClassPeriod\": {\n \"id\": 2,\n \"name\": \"integral\"\n },\n \"CourseClassTime\": null,\n \"Campus\": null,\n \"Course\": {\n \"id\": 123,\n \"name\": \"Curso teste\"\n }\n }\n}"}],"_postman_id":"5bf4b110-74a3-43f0-8a69-46bebaacf450"},{"name":"Update Course-Classes","id":"f606fc87-0961-4ac6-8e34-3a066d337815","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"visible\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/course-classes/:id","description":"

It edits the \"visible\" property of a specifict course class, identified by ID.

Please notice that the class will only be visible if the course it belongs to is also visible.

\n","urlObject":{"path":["{{api_version}}","course-classes",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"4e725b5d-8fd7-4fc9-9f94-960bece5bd6d","type":"any","value":"123","key":"id"}]}},"response":[{"id":"e8b0507f-98fa-48d8-88f8-3e9e9253c524","name":"Update Course-Classes","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"visible\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/{{api_version}}/course-classes/:id","host":["{{base_url}}"],"path":["{{api_version}}","course-classes",":id"],"variable":[{"key":"id","value":null}]}},"status":"No Content","code":204,"_postman_previewlanguage":"","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"f606fc87-0961-4ac6-8e34-3a066d337815"},{"name":"Delete Course-Classes","id":"3df52ec7-9cae-417d-9ebb-ee16cd716e07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/course-classes/:id","description":"

It deletes a specfic course class by its ID.

\n","urlObject":{"path":["{{api_version}}","course-classes",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"6c4688b6-6ecb-4989-9b51-06bf7373623d","type":"any","value":"123","key":"id"}]}},"response":[{"id":"31184b94-a055-438d-b0c0-6dfdc4ced668","name":"Delete Course-Classes","originalRequest":{"method":"DELETE","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{base_url}}/{{api_version}}/course-classes/:id","host":["{{base_url}}"],"path":["{{api_version}}","course-classes",":id"],"variable":[{"key":"id","value":"123"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"3df52ec7-9cae-417d-9ebb-ee16cd716e07"}],"id":"2c33f93c-235b-493d-87b9-503d82932a16","description":"

Course-Classes are classes. Classes are the entity that will be available for sale on the Provi platforms. A class is always vinculated to a course, and allows you to create variations of it according to your needs.

The same course may have differente classes with diffent prices, subscription plans, periods or attend types. For instance, one remote class and one in person, each with a different price and start date.

Options to use with required properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property _ _ _ _ _ _ _ _ _ _ _ _ _	Values (IDs to use)	Descriptions _ _
CourseClassDurationId	1	dia(s)
CourseClassDurationId	2	semana(s)
CourseClassDurationId	3	Mês(meses)
CourseClassDurationId	4	ano(s)
CourseClassDurationId	5	vitalício

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property _ _ _ _ _ _ _ _ _ _ _ _ _	Values (IDs to use)	Descriptions _ _
CourseClassTypeId	1	período fechado
CourseClassTypeId	2	plano

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property _ _ _ _ _ _ _ _ _ _ _ _ _	Values (IDs to use)	Descriptions _ _
CourseClassModalityId	1	Online
CourseClassModalityId	2	semi presencial
CourseClassModalityId	3	presencial

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property _ _ _ _ _ _ _ _ _ _ _ _ _	Values (IDs to use)	Descriptions _ _
CourseClassAttendTypeId	1	ao vivo
CourseClassAttendTypeId	2	sob demanda
CourseClassAttendTypeId	3	misto

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property _ _ _ _ _ _ _ _ _ _ _ _ _	Values (IDs to use)	Descriptions _ _
CourseClassPeriodId	1	meio período
CourseClassPeriodId	2	integral

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property _ _ _ _ _ _ _ _ _ _ _ _ _	Values (IDs to use)	Descriptions _ _
CourseClassTimeId	1	manhã
CourseClassTimeId	2	tarde
CourseClassTimeId	3	noite

","_postman_id":"2c33f93c-235b-493d-87b9-503d82932a16"},{"name":"Sales","item":[{"name":"Exclusive sale","item":[{"name":"Create exclusive sale","id":"74da9713-a382-4458-ada6-7ddb62d8316d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"cpf\": \"11111111111\",\n\t\"checkout_price_in_cents\": 150000,\n\t\"courses\": [\n {\n \"id\": 1,\n\t \"courseClassId\": 1\n }\n ],\n \"upfront_amount_in_cents\": 15000,\n\t\"consultant_id\": \"seller@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/sales/exclusive-sale","description":"

In order to create an exclusive sale you must possess the ids of the courses and respective course classes that will form it. You must also inform the CPF of the student for whom the sale is intended and the final price of the sale. The other parameters are optional.

Please notice that the upfront amount of the sale, if provided, cannot be lower than the default upfront amount of the course, or the default upfront amount of the partner if the course doesn't have one. If there is more than one course with a default upfront amount, the biggest upfront will be taken as reference.

The total price of the sale must also be lower than the sum of the courses prices.

\n","urlObject":{"path":["{{api_version}}","sales","exclusive-sale"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"687d9e54-71b9-4c31-b056-6f816313e314","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"cpf\": \"11111111111\",\n\t\"checkout_price_in_cents\": 150000,\n\t\"courses\": [\n {\n \"id\": 1,\n\t \"courseClassId\": 1\n }\n ],\n \"upfront_amount_in_cents\": 15000,\n\t\"consultant_id\": \"seller@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{checkout_base_url}}/v4/sales"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"id\": 1,\n \"cpf\": \"11111111111\",\n \"fullName\": \"Maria Silva\",\n \"webhook\": \"not_logged\",\n \"redirect_url\": \"url\",\n \"checkout_price_in_cents\": 150000,\n \"running_days_to_expire\": 3,\n \"courses\": [\n {\n \"id\": 1,\n \"name\": \"Course Name\",\n \"price\": 200000,\n \"modality\": \"remote\",\n \"isFullTime\": false,\n \"courseClassIds\": [\n 1\n ]\n }\n ],\n \"snapshot\": {\n \"status\": \"not_logged\",\n \"basic_info_status\": \"incomplete\",\n \"document_status\": \"incomplete\",\n \"guarantor_status\": \"unneeded\",\n \"signed_date\": null,\n \"first_installment_paid_date\": null\n },\n \"logs\": [],\n \"consultant_id\": \"consultant@email.com\",\n \"creator\": \"SYSTEM\",\n \"version\": 2,\n \"createdAt\": \"2022-02-10\",\n \"updatedAt\": \"2022-02-10\"\n }\n}"},{"id":"2398e7a1-1e35-45c7-9eee-f9f5b159cda3","name":"Bad request 1","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"cpf\": \"11111111111\",\n\t\"checkout_price_in_cents\": false,\n\t\"courses\": [\n {\n \"id\": 1,\n\t \"courseClassId\": 1\n }\n ],\n \"upfront_amount_in_cents\": 15000,\n\t\"consultant_id\": \"seller@email.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"name\": \"ValidationError\",\n \"errors\": [\n {\n \"name\": \"bodyPropertyError: checkout_price_in_cents\",\n \"message\": \"Propriedade inválida: checkout_price_in_cents.\"\n }\n ]\n}"},{"id":"7a81af1f-34fe-4829-81f9-4b935d7d5cfd","name":"Bad request 2","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"cpf\": \"11111111111\",\n\t\"checkout_price_in_cents\": 150000,\n \"upfront_amount_in_cents\": 15000,\n\t\"consultant_id\": \"seller@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{checkout_base_url}}/v4/sales"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"BodyPropertyError\",\n \"message\": \"The request is missing one or more of the mandatory params: courses.\",\n \"stack\": \"Error\\n at new BodyPropertyError (/app/src/app/errors/bodyPropertyError/index.js:12:18)\\n at treatCoursesV4 (/app/src/app/middlewares/treatCourses/v4/index.js:15:13)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at /app/src/app/middlewares/validatorMiddleware/index.js:39:14\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at handleAdminToken (/app/src/app/middlewares/authMiddleware/handleAuthMethods/handleAdminToken.js:30:10)\\n at async authMiddleware (/app/src/app/middlewares/authMiddleware/index.js:39:5)\"\n }\n}"},{"id":"bb58c121-8bd4-464b-9716-8a51259a7326","name":"Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"cpf\": \"11111111111\",\n\t\"checkout_price_in_cents\": 150000,\n\t\"courses\": [\n {\n \"id\": 1,\n\t \"courseClassId\": 1\n }\n ],\n \"upfront_amount_in_cents\": 15000,\n\t\"consultant_id\": \"seller@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{checkout_base_url}}/v4/sales"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotAuthorizedError\",\n \"message\": \"Invalid authorization token\",\n \"stack\": \"Error\\n at new NotAuthorizedError (/app/src/app/errors/notAuthorizedError/index.js:8:18)\\n at Object.decodeToken (/app/src/app/services/authService/decodeToken/index.js:21:11)\\n at handleDefaultToken (/app/src/app/middlewares/authMiddleware/handleAuthMethods/handleDefaultToken.js:18:31)\\n at authMiddleware (/app/src/app/middlewares/authMiddleware/index.js:39:11)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at Route.dispatch (/app/node_modules/express/lib/router/route.js:112:3)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at /app/node_modules/express/lib/router/index.js:281:22\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\\n at router (/app/node_modules/express/lib/router/index.js:47:12)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at trim_prefix (/app/node_modules/express/lib/router/index.js:317:13)\\n at /app/node_modules/express/lib/router/index.js:284:7\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\"\n }\n}"},{"id":"2f495acf-972e-4012-b0cd-41218152d24e","name":"Not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"cpf\": \"11111111111\",\n\t\"checkout_price_in_cents\": 150000,\n\t\"courses\": [\n {\n \"id\": 0,\n\t \"courseClassId\": 1\n }\n ],\n \"upfront_amount_in_cents\": 15000,\n\t\"consultant_id\": \"seller@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{checkout_base_url}}/v4/sales"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotFoundError\",\n \"message\": \"Course(s) not found: 0.\",\n \"stack\": \"Error\\n at new NotFoundError (/app/src/app/errors/notFoundError/index.js:8:18)\\n at Object.updateCampaign [as update] (/app/src/app/services/campaignService/v4/update/index.js:10:11)\\n at runMicrotasks ()\\n at processTicksAndRejections (internal/process/task_queues.js:97:5)\\n at async updateCampaign (/app/src/app/controllers/campaignController/v4/update/index.js:19:5)\"\n }\n}"}],"_postman_id":"74da9713-a382-4458-ada6-7ddb62d8316d"},{"name":"Find exclusive sale","id":"f3009cbc-e074-47e5-915f-7455dfe8a0e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/sales/exclusive-sale/:id","description":"

Finds one specific exclusive sale by ID.

Please notice that regular sales are not shown here, but on the general sales index, which accepts the sale ID as one of its search parameters. As so, if ID provided to this endpoint exists in our database, but belongs to a regular sale, we will return are 400 error.

\n","urlObject":{"path":["{{api_version}}","sales","exclusive-sale",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"1d2e5f8c-5f2c-41f5-a6a7-5c1d5de45301","type":"any","value":"1","key":"id"}]}},"response":[{"id":"cc7a9557-d0d7-408c-829c-c7fdad55ed9e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{checkout_base_url}}/v4/sales/exclusive-sale/:id","host":["{{checkout_base_url}}"],"path":["v4","sales","exclusive-sale",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"id\": 1,\n \"cpf\": \"11111111111\",\n \"fullName\": \"Maria Silva\",\n \"webhook\": \"not_logged\",\n \"redirect_url\": \"url\",\n \"checkout_price_in_cents\": 150000,\n \"running_days_to_expire\": 3,\n \"courses\": [\n {\n \"id\": 1,\n \"name\": \"Course Name\",\n \"price\": 200000,\n \"modality\": \"remote\",\n \"isFullTime\": false,\n \"courseClassIds\": [\n 1\n ]\n }\n ],\n \"snapshot\": {\n \"status\": \"not_logged\",\n \"basic_info_status\": \"incomplete\",\n \"document_status\": \"incomplete\",\n \"guarantor_status\": \"unneeded\",\n \"signed_date\": null,\n \"first_installment_paid_date\": null\n },\n \"logs\": [],\n \"consultant_id\": \"consultant@email.com\",\n \"creator\": \"SYSTEM\",\n \"version\": 2,\n \"createdAt\": \"2022-02-10\",\n \"updatedAt\": \"2022-02-10\"\n }\n}"},{"id":"e6b1c3b3-cd96-4952-8f9a-f833b4f4e6c9","name":"Bad request 1","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{checkout_base_url}}/v4/sales/exclusive-sale/:id","host":["{{checkout_base_url}}"],"path":["v4","sales","exclusive-sale",":id"],"variable":[{"key":"id","value":"string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"name\": \"ValidationError\",\n \"errors\": [\n {\n \"name\": \"paramsPropertyError: id\",\n \"message\": \"Propriedade inválida: id.\"\n }\n ]\n}"},{"id":"c1d8dc25-d56c-4545-9376-518ddbb65894","name":"Bad request 2","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{checkout_base_url}}/v4/sales/exclusive-sale/:id","host":["{{checkout_base_url}}"],"path":["v4","sales","exclusive-sale",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"BodyPropertyError\",\n \"message\": \"The request associated with the provided ID is not an exclusive sale\",\n \"stack\": \"Error\\n at new BodyPropertyError (/app/src/app/errors/bodyPropertyError/index.js:12:18)\\n at showExclusiveSale (/app/src/app/services/salesService/showExclusiveSale/index.js:16:32)\\n at runMicrotasks ()\\n at processTicksAndRejections (internal/process/task_queues.js:97:5)\\n at async showOne (/app/src/app/controllers/salesController/exclusive-sale/show/index.js:22:41)\"\n }\n}"},{"id":"78257319-6b51-476b-bb09-26edbb44a0c6","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{checkout_base_url}}/v4/sales/exclusive-sale/:id","host":["{{checkout_base_url}}"],"path":["v4","sales","exclusive-sale",":id"],"variable":[{"key":"id","value":"1"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotAuthorizedError\",\n \"message\": \"Invalid authorization token\",\n \"stack\": \"Error\\n at new NotAuthorizedError (/app/src/app/errors/notAuthorizedError/index.js:8:18)\\n at Object.decodeToken (/app/src/app/services/authService/decodeToken/index.js:21:11)\\n at handleDefaultToken (/app/src/app/middlewares/authMiddleware/handleAuthMethods/handleDefaultToken.js:18:31)\\n at authMiddleware (/app/src/app/middlewares/authMiddleware/index.js:39:11)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at Route.dispatch (/app/node_modules/express/lib/router/route.js:112:3)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at /app/node_modules/express/lib/router/index.js:281:22\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\\n at router (/app/node_modules/express/lib/router/index.js:47:12)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at trim_prefix (/app/node_modules/express/lib/router/index.js:317:13)\\n at /app/node_modules/express/lib/router/index.js:284:7\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\"\n }\n}"},{"id":"c674e029-8af1-436a-a1f2-31fbdfedf9b4","name":"Not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{checkout_base_url}}/v4/sales/exclusive-sale/:id","host":["{{checkout_base_url}}"],"path":["v4","sales","exclusive-sale",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotFoundError\",\n \"message\": \"Exclusive sale(s) not found: 57060.\",\n \"stack\": \"Error\\n at new NotFoundError (/app/src/app/errors/notFoundError/index.js:8:18)\\n at showExclusiveSale (/app/src/app/services/salesService/showExclusiveSale/index.js:12:28)\\n at async showOne (/app/src/app/controllers/salesController/exclusive-sale/show/index.js:22:41)\"\n }\n}"}],"_postman_id":"f3009cbc-e074-47e5-915f-7455dfe8a0e6"},{"name":"Cancel exclusive sale","id":"8dbe723e-b54b-4b1b-ba9c-05ffc042cc80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/sales/exclusive-sale/cancel/:id","description":"

This endpoint receives a sale ID (CreditRequestId) in the request body and cancels it, meaning that the porter of the CPF to which the exclusive sale was linked will no longer be able to access it if they haven't yet logged in.

\n","urlObject":{"path":["{{api_version}}","sales","exclusive-sale","cancel",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"9247838b-7fe0-46a6-a600-3d2cce1de11c","type":"any","value":null,"key":"id"}]}},"response":[{"id":"ae2dfe6e-49f5-4eca-bfca-4bda854723db","name":"Success","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"{{checkout_base_url}}/v4/sales/exclusive-sale/cancel/:id","host":["{{checkout_base_url}}"],"path":["v4","sales","exclusive-sale","cancel",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"73973f81-8201-493f-8233-32cc01c87e4c","name":"Bad request","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"{{checkout_base_url}}/v4/sales/exclusive-sale/cancel/:id","host":["{{checkout_base_url}}"],"path":["v4","sales","exclusive-sale","cancel",":id"],"variable":[{"key":"id","value":"string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"name\": \"ValidationError\",\n \"errors\": [\n {\n \"name\": \"paramsPropertyError: id\",\n \"message\": \"Propriedade inválida: id.\"\n }\n ]\n}"},{"id":"1a279606-4e3a-4c7d-ab31-b1deac200932","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"{{checkout_base_url}}/v4/sales/exclusive-sale/cancel/:id","host":["{{checkout_base_url}}"],"path":["v4","sales","exclusive-sale","cancel",":id"],"variable":[{"key":"id","value":null}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotAuthorizedError\",\n \"message\": \"Invalid authorization token\",\n \"stack\": \"Error\\n at new NotAuthorizedError (/app/src/app/errors/notAuthorizedError/index.js:8:18)\\n at Object.decodeToken (/app/src/app/services/authService/decodeToken/index.js:21:11)\\n at handleDefaultToken (/app/src/app/middlewares/authMiddleware/handleAuthMethods/handleDefaultToken.js:18:31)\\n at authMiddleware (/app/src/app/middlewares/authMiddleware/index.js:39:11)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at Route.dispatch (/app/node_modules/express/lib/router/route.js:112:3)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at /app/node_modules/express/lib/router/index.js:281:22\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\\n at router (/app/node_modules/express/lib/router/index.js:47:12)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at trim_prefix (/app/node_modules/express/lib/router/index.js:317:13)\\n at /app/node_modules/express/lib/router/index.js:284:7\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\"\n }\n}"},{"id":"54be31c6-d83f-4093-b1bd-99923c4bfbfc","name":"Not found","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"{{checkout_base_url}}/v4/sales/exclusive-sale/cancel/:id","host":["{{checkout_base_url}}"],"path":["v4","sales","exclusive-sale","cancel",":id"],"variable":[{"key":"id","value":"0"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotFoundError\",\n \"message\": \"Exclusive sale(s) not found: 57060.\",\n \"stack\": \"Error\\n at new NotFoundError (/app/src/app/errors/notFoundError/index.js:8:18)\\n at cancelExclusiveSale (/app/src/app/services/salesService/cancelExclusiveSale/index.js:12:28)\\n at async cancelOne (/app/src/app/controllers/salesController/exclusive-sale/cancel/index.js:23:5)\"\n }\n}"}],"_postman_id":"8dbe723e-b54b-4b1b-ba9c-05ffc042cc80"}],"id":"97791194-e0f7-4063-aa99-c2899049529c","description":"

An exclusive sale is a sale with special conditions tied to a specific CPF. It will expire after three days if the porter of the CPF doesn't log into our platform, and after a couple more days if they log in, but don't complete the purchase.

\n","_postman_id":"97791194-e0f7-4063-aa99-c2899049529c"},{"name":"List all sales","id":"8ab8da4b-6322-47ea-ab2c-bc4885a2bbe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/sales?page=1&limit=50","description":"

Lists all sales, exclusive or otherwise. It may be used to find one specific sale by passing using the CreditRequestId param.

Please notice that if a param is incorrect in name or type, it will be ignored, and that if only a stard date is passed, it will also be used as the equivalent end date.

The params status, cridOrigin, courseId, productType, creator and campaign may be passed more than once.

\n","urlObject":{"path":["{{api_version}}","sales"],"host":["{{base_url}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"disabled":true,"key":"CreditRequestId","value":"1"},{"disabled":true,"key":"cpf","value":"11111111111"},{"disabled":true,"key":"email","value":"email!@email.com"},{"disabled":true,"key":"name","value":"Maria Silva"},{"disabled":true,"key":"status","value":"made_effective"},{"disabled":true,"key":"cridOrigin","value":"CHECKOUT"},{"disabled":true,"key":"courseId","value":"1"},{"disabled":true,"key":"productType","value":"CourseFinancing"},{"disabled":true,"key":"creator","value":"dev@email.com"},{"disabled":true,"key":"campaign","value":"campaign-name"},{"disabled":true,"key":"startDate","value":"2022-01-01"},{"disabled":true,"key":"endDate","value":"2022-01-02"},{"disabled":true,"key":"startEffectiveDate","value":"2022-01-01"},{"disabled":true,"key":"endEffectiveDate","value":"2022-01-02"},{"disabled":true,"key":"startExpectedPaymentDate","value":"2022-01-01"},{"disabled":true,"key":"endExpectedPaymentDate","value":"2022-01-02"},{"disabled":true,"key":"startNextPaymentDate","value":"2022-02-01"},{"disabled":true,"key":"endNextPaymentDate","value":"2022-02-02"},{"disabled":true,"key":"startReleasedDate","value":"2022-01-01"},{"disabled":true,"key":"endReleasedDate","value":"2022-01-02"},{"disabled":true,"key":"campaignCustomIdentifier","value":"campaign_custom_identifier_code"}],"variable":[]}},"response":[{"id":"04487906-93b5-46e1-95af-ead28452bdbb","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{checkout_base_url}}/v4/sales?page=1&limit=1","host":["{{checkout_base_url}}"],"path":["v4","sales"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"1"},{"key":"CreditRequestId","value":"1","type":"text","disabled":true},{"key":"cpf","value":"11111111111","type":"text","disabled":true},{"key":"email","value":"email!@email.com","type":"text","disabled":true},{"key":"name","value":"Maria Silva","type":"text","disabled":true},{"key":"status","value":"made_effective","type":"text","disabled":true},{"key":"cridOrigin","value":"CHECKOUT","type":"text","disabled":true},{"key":"courseId","value":"1","type":"text","disabled":true},{"key":"productType","value":"CourseFinancing","type":"text","disabled":true},{"key":"creator","value":"dev@email.com","type":"text","disabled":true},{"key":"campaign","value":"campaign-name","type":"text","disabled":true},{"key":"startDate","value":"2022-01-01","type":"text","disabled":true},{"key":"endDate","value":"2022-01-02","type":"text","disabled":true},{"key":"startEffectiveDate","value":"2022-01-01","type":"text","disabled":true},{"key":"endEffectiveDate","value":"2022-01-02","type":"text","disabled":true},{"key":"startExpectedPaymentDate","value":"2022-01-01","type":"text","disabled":true},{"key":"endExpectedPaymentDate","value":"2022-01-02","type":"text","disabled":true},{"key":"startNextPaymentDate","value":"2022-02-01","type":"text","disabled":true},{"key":"endNextPaymentDate","value":"2022-02-02","type":"text","disabled":true},{"key":"startReleasedDate","value":"2022-01-01","type":"text","disabled":true},{"key":"endReleasedDate","value":"2022-01-02","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"paging\": {\n \"itemsPerPage\": 1,\n \"nextPage\": 2,\n \"currentPage\": 1,\n \"previousPage\": null,\n \"totalPages\": 100,\n \"totalItems\": 100\n },\n \"content\": [\n {\n \"id\": 1,\n \"campaignName\": \"campaign-name\",\n \"redirectUrl\": \"url\",\n \"courseReleasedAt\": \"2021-11-11\",\n \"signedDate\": \"2021-11-06\",\n \"createdAt\": \"2021-11-05\",\n \"updatedAt\": \"2022-01-07\",\n \"lastUpdateHasComments\": true,\n \"firstInstallmentPaid\": true,\n \"resumeStatus\": \"abandonment_after_settled\",\n \"CPF\": \"111111111111\",\n \"email\": \"student@email.com\",\n \"phone\": \"41984975139\",\n \"address\": {\n \"zipcode\": \"00000000\",\n \"state\": \"SP\",\n \"city\": \"São Paulo\",\n \"district\": \"District name\",\n \"street\": \"Street name\",\n \"number\": \"100\",\n \"complement\": \"Apto 1\"\n },\n \"installmentsToApply\": 12,\n \"totalValue\": 150000,\n \"upfrontValue\": 15000,\n \"madeEffectiveDate\": \"2021-11-06\",\n \"origin\": \"PROVI_PAY\",\n \"ProductType\": \"CourseFinancing\",\n \"fullName\": \"Maria Silva\",\n \"courses\": [\n {\n \"id\": 1,\n \"name\": \"Course name\",\n \"price\": 150000,\n \"modality\": \"remote\",\n \"isFullTime\": true\n }\n ],\n \"expirationDate\": \"2021-11-08\",\n \"minDueDate\": \"2021-11-08\",\n \"nextPaymentDate\": \"2021-12-08\",\n \"hasUpfrontPayment\": true,\n \"proviComission\": 10.55,\n \"expectedTEDValue\": 100000,\n \"amountOfTEDPerformed\": 150000,\n \"expectedPaymentDate\": \"2021-12-10\",\n \"transferDate\": \"2021-12-09\",\n \"loanOptionComments\": null,\n \"creator\": \"SYSTEM\"\n }\n ]\n}"},{"id":"9a70e9d0-5d7e-4b2e-90f8-5aa19db4169d","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{checkout_base_url}}/v4/sales?page=1&limit=50","host":["{{checkout_base_url}}"],"path":["v4","sales"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"CreditRequestId","value":"1","type":"text","disabled":true},{"key":"cpf","value":"11111111111","type":"text","disabled":true},{"key":"email","value":"email!@email.com","type":"text","disabled":true},{"key":"name","value":"Maria Silva","type":"text","disabled":true},{"key":"status","value":"made_effective","type":"text","disabled":true},{"key":"cridOrigin","value":"CHECKOUT","type":"text","disabled":true},{"key":"courseId","value":"1","type":"text","disabled":true},{"key":"productType","value":"CourseFinancing","type":"text","disabled":true},{"key":"creator","value":"dev@email.com","type":"text","disabled":true},{"key":"campaign","value":"campaign-name","type":"text","disabled":true},{"key":"startDate","value":"2022-01-01","type":"text","disabled":true},{"key":"endDate","value":"2022-01-02","type":"text","disabled":true},{"key":"startEffectiveDate","value":"2022-01-01","type":"text","disabled":true},{"key":"endEffectiveDate","value":"2022-01-02","type":"text","disabled":true},{"key":"startExpectedPaymentDate","value":"2022-01-01","type":"text","disabled":true},{"key":"endExpectedPaymentDate","value":"2022-01-02","type":"text","disabled":true},{"key":"startNextPaymentDate","value":"2022-02-01","type":"text","disabled":true},{"key":"endNextPaymentDate","value":"2022-02-02","type":"text","disabled":true},{"key":"startReleasedDate","value":"2022-01-01","type":"text","disabled":true},{"key":"endReleasedDate","value":"2022-01-02","type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8ab8da4b-6322-47ea-ab2c-bc4885a2bbe8"},{"name":"List available filters","id":"23c51448-c25c-44fc-a690-6fc379bdc9b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/sales/available-filters","description":"

Lists the filters and values that may be used to search through the sales index.

\n","urlObject":{"path":["{{api_version}}","sales","available-filters"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7803a33f-0e0b-412a-871b-c3e08b661351","name":"Available filters","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/sales/available-filters"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"status\": [\n \"made_effective\",\n \"not_logged\"\n ],\n \"origin\": [\n \"CAMPAIGN\",\n \"PROVI_PAY\"\n ],\n \"courses\": [\n {\n \"id\": 123,\n \"name\": \"courseName\"\n }\n ],\n \"productType\": [\n \"CourseFinancing\",\n \"MAAS\",\n \"CreditCard\",\n \"Boleto\",\n \"ProviPay\"\n ],\n \"creator\": [\n \"seler@domain.com\"\n ],\n \"campaign\": [\n \"campaignName\"\n ]\n }\n}"}],"_postman_id":"23c51448-c25c-44fc-a690-6fc379bdc9b5"}],"id":"ac3259a6-a0e2-4eef-a8f6-545afaa233e6","description":"

A sale discloses products, status and payment information of any purchases or intended purchases registered in our system. This means that it is possible to monitor the state of general and exclusive sales from the moment a student chooses a product.

\n","_postman_id":"ac3259a6-a0e2-4eef-a8f6-545afaa233e6"},{"name":"Campaigns","item":[{"name":"Create campaign","id":"1a14913c-9d27-4026-b0b2-338789a40834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"checkout_price_in_cents\": 10000,\n\t\"name\": \"campaign-name\",\n\t\"courses\": [\n {\n \"id\": 1,\n\t \"courseClassId\": 1\n }\n ],\n\t\"startsAt\": \"2050-01-01T12:00:00.000Z\",\n\t\"endsAt\": \"2050-02-01T12:00:00.000Z\",\n \"customIdentifier\": \"custom_identifier_code\",\n\t\"payment_methods\": [\"CourseFinancing\", \"Boleto\", \"CreditCard\"],\n\t\"consultant_id\": \"consultant@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/campaigns","description":"

In order to create a campaign you must possess the ids of the courses and respective course classes that will form it. You must also inform a unique name and the final price of the sale in cents. The rest of the parameters are optional.

Please notice that the price cannot be bigger than the sum of the courses price.

The campaign will start immediately if a start date is not informed, and will not be automatically inactivated unless a end date is provided.

\n","urlObject":{"path":["{{api_version}}","campaigns"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1ea60b8c-defe-44a9-891a-bc4ac2db557c","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"checkout_price_in_cents\": 10000,\n\t\"name\": \"campaign-name\",\n\t\"courses\": [\n {\n \"id\": 1,\n\t \"courseClassId\": 1\n }\n ],\n\t\"startsAt\": \"2050-01-01T12:00:00.000Z\",\n\t\"endsAt\": \"2050-02-01T12:00:00.000Z\",\n\t\"payment_methods\": [\"CourseFinancing\", \"Boleto\", \"CreditCard\"],\n\t\"consultant_id\": \"consultant@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{checkout_base_url}}/v4/campaigns"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"id\": \"62040e573aafe90023d4143d\",\n \"name\": \"campaign name\",\n \"slug\": \"campaign-name\",\n \"redirect_url\": \"url\",\n \"running_days_to_expire\": 3,\n \"checkout_price_in_cents\": 100000,\n \"courses\": [\n {\n \"id\": 1,\n \"name\": \"Course name\",\n \"price\": 150000,\n \"modality\": \"hybrid\",\n \"courseClassIds\": [\n 1\n ]\n }\n ],\n \"customIdentifier\": \"custom_identifier_code\",\n \"startsAt\": \"2050-01-01T12:00:00.000Z\",\n \"endsAt\": \"2050-02-01T12:00:00.000Z\",\n \"payment_methods\": [\n \"CreditCard\",\n \"Boleto\",\n \"CourseFinancing\"\n ],\n \"consultant_id\": \"consultant@email.com\",\n \"active\": false,\n \"createdAt\": \"2022-02-09T18:56:23.078Z\",\n \"updatedAt\": \"2022-02-09T18:56:23.078Z\"\n }\n}"},{"id":"73a56456-5fb9-4d32-b857-219203579235","name":"Bad request 1","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"checkout_price_in_cents\": false,\n\t\"name\": \"campaign-name\",\n\t\"courses\": [\n {\n \"id\": 1,\n\t \"courseClassId\": 1\n }\n ],\n\t\"startsAt\": \"2050-01-01T12:00:00.000Z\",\n\t\"endsAt\": \"2050-02-01T12:00:00.000Z\",\n\t\"payment_methods\": [\"CourseFinancing\", \"Boleto\", \"CreditCard\"],\n\t\"consultant_id\": \"consultant@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{checkout_base_url}}/v4/campaigns"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"name\": \"ValidationError\",\n \"errors\": [\n {\n \"name\": \"bodyPropertyError: checkout_price_in_cents\",\n \"message\": \"Propriedade inválida: checkout_price_in_cents.\"\n }\n ]\n}"},{"id":"91a11fdb-d16f-4411-924c-ea221c3a90bf","name":"Bad request 2","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"checkout_price_in_cents\": 10000,\n\t\"name\": \"campaign-name\",\n\t\"startsAt\": \"2050-01-01T12:00:00.000Z\",\n\t\"endsAt\": \"2050-02-01T12:00:00.000Z\",\n\t\"payment_methods\": [\"CourseFinancing\", \"Boleto\", \"CreditCard\"],\n\t\"consultant_id\": \"consultant@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{checkout_base_url}}/v4/campaigns"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"BodyPropertyError\",\n \"message\": \"The request is missing one or more of the mandatory params: courses.\",\n \"stack\": \"Error\\n at new BodyPropertyError (/app/src/app/errors/bodyPropertyError/index.js:12:18)\\n at treatCoursesV4 (/app/src/app/middlewares/treatCourses/v4/index.js:15:13)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at /app/src/app/middlewares/validatorMiddleware/index.js:39:14\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at handleAdminToken (/app/src/app/middlewares/authMiddleware/handleAuthMethods/handleAdminToken.js:30:10)\\n at async authMiddleware (/app/src/app/middlewares/authMiddleware/index.js:39:5)\"\n }\n}"},{"id":"cfd16f1d-3b52-4add-ab01-4bde199dcbde","name":"Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"checkout_price_in_cents\": 10000,\n\t\"name\": \"campaign-name\",\n\t\"courses\": [\n {\n \"id\": 1,\n\t \"courseClassId\": 1\n }\n ],\n\t\"startsAt\": \"2050-01-01T12:00:00.000Z\",\n\t\"endsAt\": \"2050-02-01T12:00:00.000Z\",\n\t\"payment_methods\": [\"CourseFinancing\", \"Boleto\", \"CreditCard\"],\n\t\"consultant_id\": \"consultant@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{checkout_base_url}}/v4/campaigns"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotAuthorizedError\",\n \"message\": \"Invalid authorization token\",\n \"stack\": \"Error\\n at new NotAuthorizedError (/app/src/app/errors/notAuthorizedError/index.js:8:18)\\n at Object.decodeToken (/app/src/app/services/authService/decodeToken/index.js:21:11)\\n at handleDefaultToken (/app/src/app/middlewares/authMiddleware/handleAuthMethods/handleDefaultToken.js:18:31)\\n at authMiddleware (/app/src/app/middlewares/authMiddleware/index.js:39:11)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at Route.dispatch (/app/node_modules/express/lib/router/route.js:112:3)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at /app/node_modules/express/lib/router/index.js:281:22\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\\n at router (/app/node_modules/express/lib/router/index.js:47:12)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at trim_prefix (/app/node_modules/express/lib/router/index.js:317:13)\\n at /app/node_modules/express/lib/router/index.js:284:7\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\"\n }\n}"},{"id":"f3438efc-ec29-4215-9f16-1cf2d71c5894","name":"Not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"checkout_price_in_cents\": 10000,\n\t\"name\": \"campaign-name\",\n\t\"courses\": [\n {\n \"id\": 0,\n\t \"courseClassId\": 1\n }\n ],\n\t\"startsAt\": \"2050-01-01T12:00:00.000Z\",\n\t\"endsAt\": \"2050-02-01T12:00:00.000Z\",\n\t\"payment_methods\": [\"CourseFinancing\", \"Boleto\", \"CreditCard\"],\n\t\"consultant_id\": \"consultant@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{checkout_base_url}}/v4/campaigns"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotFoundError\",\n \"message\": \"Course(s) not found: 0.\",\n \"stack\": \"Error\\n at new NotFoundError (/app/src/app/errors/notFoundError/index.js:8:18)\\n at treatCoursesV4 (/app/src/app/middlewares/treatCourses/v4/index.js:37:13)\"\n }\n}"}],"_postman_id":"1a14913c-9d27-4026-b0b2-338789a40834"},{"name":"List all campaigns","id":"baddff1f-2106-4176-96c4-196c422ae9f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/{{api_version}}/campaigns?page=1&limit=1&customIdentifier=custom_identifier_code","description":"

Lists all campaigns, active or otherwise.

\n","urlObject":{"path":["{{api_version}}","campaigns"],"host":["{{base_url}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"1"},{"key":"customIdentifier","value":"custom_identifier_code"}],"variable":[]}},"response":[{"id":"6ca6427d-0dc5-48e2-8bab-7a428e2b6bb6","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":{"raw":"{{checkout_base_url}}/v4/campaigns?page=1&limit=1","host":["{{checkout_base_url}}"],"path":["v4","campaigns"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"paging\": {\n \"itemsPerPage\": 1,\n \"nextPage\": 2,\n \"currentPage\": 1,\n \"previousPage\": null,\n \"totalPages\": 3,\n \"totalItems\": 3\n },\n \"content\": [\n {\n \"id\": \"MongoDBObjectId\",\n \"name\": \"campaign-name\",\n \"slug\": \"campaign-name\",\n \"redirect_url\": \"url\",\n \"running_days_to_expire\": 3,\n \"checkout_price_in_cents\": 100000,\n \"courses\": [\n {\n \"id\": 251179,\n \"name\": \"Course name\",\n \"price\": 150000,\n \"modality\": \"hybrid\",\n \"courseClassIds\": [\n 1\n ]\n }\n ],\n \"startsAt\": \"2022-02-09T18:56:22.641Z\",\n \"payment_methods\": [\n \"CreditCard\",\n \"Boleto\",\n \"CourseFinancing\"\n ],\n \"consultant_id\": \"seller@email.com\",\n \"active\": true,\n \"createdAt\": \"2022-02-09T18:56:23.078Z\",\n \"updatedAt\": \"2022-02-09T18:56:23.078Z\"\n }\n ]\n}"},{"id":"b5f2e9fe-98f2-4690-9a38-8fb2dd55e7ea","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":{"raw":"{{checkout_base_url}}/v4/campaigns?page=1&limit=50","host":["{{checkout_base_url}}"],"path":["v4","campaigns"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotAuthorizedError\",\n \"message\": \"Invalid authorization token\",\n \"stack\": \"Error\\n at new NotAuthorizedError (/app/src/app/errors/notAuthorizedError/index.js:8:18)\\n at Object.decodeToken (/app/src/app/services/authService/decodeToken/index.js:21:11)\\n at handleDefaultToken (/app/src/app/middlewares/authMiddleware/handleAuthMethods/handleDefaultToken.js:18:31)\\n at authMiddleware (/app/src/app/middlewares/authMiddleware/index.js:39:11)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at Route.dispatch (/app/node_modules/express/lib/router/route.js:112:3)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at /app/node_modules/express/lib/router/index.js:281:22\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\\n at router (/app/node_modules/express/lib/router/index.js:47:12)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at trim_prefix (/app/node_modules/express/lib/router/index.js:317:13)\\n at /app/node_modules/express/lib/router/index.js:284:7\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\"\n }\n}"}],"_postman_id":"baddff1f-2106-4176-96c4-196c422ae9f6"},{"name":"Find campaign","id":"27f12686-f57d-407c-bc9e-0bc251589968","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/campaigns/:id","description":"

Find one specific campaign by id.

\n","urlObject":{"path":["{{api_version}}","campaigns",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"ec6cd47b-1acf-4d4d-adc6-28c16018d167","type":"any","value":"62040e573aafe90023d4143d","key":"id"}]}},"response":[{"id":"b0a0e43f-9e94-4a83-a8a8-af0364128f8f","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{checkout_base_url}}/v4/campaigns/:id","host":["{{checkout_base_url}}"],"path":["v4","campaigns",":id"],"variable":[{"key":"id","value":"62040e573aafe90023d4143d"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"id\": \"62040e573aafe90023d4143d\",\n \"name\": \"campaign-name\",\n \"slug\": \"campaign-name\",\n \"redirect_url\": \"url\",\n \"running_days_to_expire\": 3,\n \"checkout_price_in_cents\": 100000,\n \"courses\": [\n {\n \"id\": 251179,\n \"name\": \"Course name\",\n \"price\": 150000,\n \"modality\": \"hybrid\",\n \"courseClassIds\": [\n 1\n ]\n }\n ],\n \"startsAt\": \"2022-02-09T18:56:22.641Z\",\n \"payment_methods\": [\n \"CreditCard\",\n \"Boleto\",\n \"CourseFinancing\"\n ],\n \"consultant_id\": \"seller@email.com\",\n \"active\": true,\n \"customIdentifier\": \"custom_identifier_code\",\n \"createdAt\": \"2022-02-09T18:56:23.078Z\",\n \"updatedAt\": \"2022-02-09T18:56:23.078Z\"\n }\n}"},{"id":"93278e8e-cc12-4ddf-8d5e-dfdc23e11fd8","name":"Bad request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{checkout_base_url}}/v4/campaigns/:id","host":["{{checkout_base_url}}"],"path":["v4","campaigns",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"ParamPropertyError\",\n \"message\": \"Type error on property id. Expected type: MongoDB ObjectId.\",\n \"stack\": \"Error\\n at new ParamPropertyError (/app/src/app/errors/paramPropertyError/index.js:12:18)\\n at showCampaign (/app/src/app/controllers/campaignController/v4/show/index.js:15:45)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at handleAdminToken (/app/src/app/middlewares/authMiddleware/handleAuthMethods/handleAdminToken.js:30:10)\\n at async authMiddleware (/app/src/app/middlewares/authMiddleware/index.js:39:5)\"\n }\n}"},{"id":"a439c785-6361-47ce-a476-16fc0e456422","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{checkout_base_url}}/v4/campaigns/:id","host":["{{checkout_base_url}}"],"path":["v4","campaigns",":id"],"variable":[{"key":"id","value":"62040e573aafe90023d4143d"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"ParamPropertyError\",\n \"message\": \"Type error on property id. Expected type: MongoDB ObjectId.\",\n \"stack\": \"Error\\n at new ParamPropertyError (/app/src/app/errors/paramPropertyError/index.js:12:18)\\n at showCampaign (/app/src/app/controllers/campaignController/v4/show/index.js:15:45)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at handleAdminToken (/app/src/app/middlewares/authMiddleware/handleAuthMethods/handleAdminToken.js:30:10)\\n at async authMiddleware (/app/src/app/middlewares/authMiddleware/index.js:39:5)\"\n }\n}"},{"id":"41746c33-f446-4c56-b5b7-a8276a44682d","name":"Not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{checkout_base_url}}/v4/campaigns/:id","host":["{{checkout_base_url}}"],"path":["v4","campaigns",":id"],"variable":[{"key":"id","value":"62040e573aafe90023d4143d"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotFoundError\",\n \"message\": \"Campaign(s) not found: 62040e573aafe90023d4143d.\",\n \"stack\": \"Error\\n at new NotFoundError (/app/src/app/errors/notFoundError/index.js:8:18)\\n at Object.updateCampaign [as update] (/app/src/app/services/campaignService/v4/update/index.js:10:11)\\n at runMicrotasks ()\\n at processTicksAndRejections (internal/process/task_queues.js:97:5)\\n at async updateCampaign (/app/src/app/controllers/campaignController/v4/update/index.js:19:5)\"\n }\n}"}],"_postman_id":"27f12686-f57d-407c-bc9e-0bc251589968"},{"name":"Update campaign","id":"bc848b45-41a9-4681-9776-2a4f6e3584d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"active\": false,\n \"customIdentifier\": \"custom_identifier_code\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/campaigns/active/:id","description":"

Activates or inactivates one specific campaign.

\n","urlObject":{"path":["{{api_version}}","campaigns","active",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"4e6fbe87-b24e-462e-ae32-5947e2964900","type":"any","value":"","key":"id"}]}},"response":[{"id":"653be395-e394-4e4c-8360-290671d954c9","name":"Success","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"active\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{checkout_base_url}}/v4/campaigns/active/:id","host":["{{checkout_base_url}}"],"path":["v4","campaigns","active",":id"],"variable":[{"key":"id","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"601cbf26-37ab-4472-9240-8c715718faee","name":"Bad request","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"active\": 14\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{checkout_base_url}}/v4/campaigns/active/:id","host":["{{checkout_base_url}}"],"path":["v4","campaigns","active",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"name\": \"ValidationError\",\n \"errors\": [\n {\n \"name\": \"bodyPropertyError: active\",\n \"message\": \"Propriedade inválida: active.\"\n }\n ]\n}"},{"id":"b6857e9a-2f1a-49c2-877b-4ee7c7b5e6e8","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"active\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{checkout_base_url}}/v4/campaigns/active/:id","host":["{{checkout_base_url}}"],"path":["v4","campaigns","active",":id"],"variable":[{"key":"id","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotAuthorizedError\",\n \"message\": \"Invalid authorization token\",\n \"stack\": \"Error\\n at new NotAuthorizedError (/app/src/app/errors/notAuthorizedError/index.js:8:18)\\n at Object.decodeToken (/app/src/app/services/authService/decodeToken/index.js:21:11)\\n at handleDefaultToken (/app/src/app/middlewares/authMiddleware/handleAuthMethods/handleDefaultToken.js:18:31)\\n at authMiddleware (/app/src/app/middlewares/authMiddleware/index.js:39:11)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at next (/app/node_modules/express/lib/router/route.js:137:13)\\n at Route.dispatch (/app/node_modules/express/lib/router/route.js:112:3)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at /app/node_modules/express/lib/router/index.js:281:22\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\\n at router (/app/node_modules/express/lib/router/index.js:47:12)\\n at newFn (/app/node_modules/express-async-errors/index.js:16:20)\\n at Layer.handle [as handle_request] (/app/node_modules/express/lib/router/layer.js:95:5)\\n at trim_prefix (/app/node_modules/express/lib/router/index.js:317:13)\\n at /app/node_modules/express/lib/router/index.js:284:7\\n at Function.process_params (/app/node_modules/express/lib/router/index.js:335:12)\\n at next (/app/node_modules/express/lib/router/index.js:275:10)\\n at Function.handle (/app/node_modules/express/lib/router/index.js:174:3)\"\n }\n}"},{"id":"94c01b10-46ff-4532-9f8d-e8d7385c8366","name":"Not found","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"active\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{checkout_base_url}}/v4/campaigns/active/:id","host":["{{checkout_base_url}}"],"path":["v4","campaigns","active",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"NotFoundError\",\n \"message\": \"Campaign(s) not found: 5e8507eb14279900177964ea.\",\n \"stack\": \"Error\\n at new NotFoundError (/app/src/app/errors/notFoundError/index.js:8:18)\\n at Object.updateCampaign [as update] (/app/src/app/services/campaignService/v4/update/index.js:10:11)\\n at runMicrotasks ()\\n at processTicksAndRejections (internal/process/task_queues.js:97:5)\\n at async updateCampaign (/app/src/app/controllers/campaignController/v4/update/index.js:19:5)\"\n }\n}"}],"_postman_id":"bc848b45-41a9-4681-9776-2a4f6e3584d0"}],"id":"1d49c83c-30a1-4f4a-b1d3-25413290e65f","description":"

A campaign generates a link to a sale of one or more products with special conditions that can be accessed by anyone in possetion of the link. It may be, for instance, a combo with a special price or a discount for early buyers or for a specific payment method.

\n","event":[{"listen":"prerequest","script":{"id":"f80a2bf3-c4d7-400d-8fbc-ae75da777a76","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"66e7428d-73e3-4cd9-bd17-ba66b99ffd46","type":"text/javascript","exec":[""]}}],"_postman_id":"1d49c83c-30a1-4f4a-b1d3-25413290e65f"},{"name":"Receipts","item":[{"name":"Update a receipt","id":"7ec8cb13-af41-495b-96d7-66bc82d1cdf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"date\": \"2022-02-19\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/receipts/:creditRequestId","description":"

Set the date when access to the product was granted to the student.

\n","urlObject":{"path":["{{api_version}}","receipts",":creditRequestId"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"123","key":"creditRequestId"},{"type":"any","value":"7513","key":"id"}]}},"response":[{"id":"efa1faf8-8f6d-4ed5-b63a-c0505e0cbae7","name":"Update","originalRequest":{"method":"PUT","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"date\": \"2022-02-19\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/{{api_version}}/receipts/:creditRequestId","host":["{{base_url}}"],"path":["{{api_version}}","receipts",":creditRequestId"],"variable":[{"key":"creditRequestId","value":"123"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"data\": {\n \"expireDate\": null,\n \"formatedStatus\": \"made_effective\",\n \"id\": 123,\n \"CPFId\": 123,\n \"UserId\": 123,\n \"PartnerId\": 123,\n \"minDaysToPayment\": null,\n \"daysToUpfrontPayment\": null,\n \"status\": \"settled\",\n \"basicInfoStatus\": \"approved\",\n \"documentStatus\": \"approved\",\n \"guarantorStatus\": \"unneeded\",\n \"firstInstallmentPaid\": true,\n \"signedDate\": \"2022-02-17T22:49:02.105Z\",\n \"firstInstallmentPaidDate\": \"2022-02-18T13:45:34.278Z\",\n \"isCheckout\": false,\n \"daysToExpire\": null,\n \"ProductType\": \"CourseFinancing\",\n \"courseReleasedAt\": \"2022-02-19T19:31:53.000Z\",\n \"isMaas\": false,\n \"Origin\": \"CAMPAIGN\",\n \"creator\": null,\n \"PartnerClassId\": 123,\n \"createdAt\": \"2022-02-16T20:58:54.220Z\",\n \"updatedAt\": \"2022-02-28T19:31:53.461Z\"\n }\n}"}],"_postman_id":"7ec8cb13-af41-495b-96d7-66bc82d1cdf5"},{"name":"List available filters","id":"4829057b-a66a-4d79-868f-326e6145a2db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/receipts/available-filters","urlObject":{"path":["{{api_version}}","receipts","available-filters"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"8ef89e9b-1686-43cc-9a42-f633b7876ce7","name":"Get Receipts Available Filters","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{base_url}}/{{api_version}}/receipts/available-filters","host":["{{base_url}}"],"path":["{{api_version}}","receipts","available-filters"],"query":[{"key":"","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"status\": [\n \"made_effective\",\n \"negativated\"\n ],\n \"courses\": [\n {\n \"id\": 123,\n \"name\": \"courseName\"\n }\n ],\n \"productType\": [\n \"CourseFinancing\",\n \"MAAS\",\n \"CreditCard\",\n \"Boleto\"\n ],\n \"delayedDays\": [\n 0,\n 12\n ],\n \"delayedInstallments\": [\n 0,\n 1\n ],\n \"campaigns\": [\n \"campaignName\"\n ]\n }\n}"}],"_postman_id":"4829057b-a66a-4d79-868f-326e6145a2db"},{"name":"List all receipts","id":"b9de81ba-573a-460f-968e-e70b9813b0ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/receipts?page=2&limit=1","urlObject":{"path":["{{api_version}}","receipts"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"CreditRequestId","value":"0"},{"disabled":true,"key":"cpf","value":"12312312311"},{"disabled":true,"key":"email","value":"123@123.com"},{"disabled":true,"key":"name","value":"user"},{"disabled":true,"key":"cridOrigin","value":"campaign"},{"disabled":true,"key":"courseId","value":"123"},{"disabled":true,"key":"productType","value":"Boleto"},{"disabled":true,"key":"status","value":"late"},{"disabled":true,"key":"delayedDay","value":"2"},{"disabled":true,"key":"startReleaseDate","value":"2021-08-01"},{"disabled":true,"key":"endReleaseDate","value":"2021-09-01"},{"disabled":true,"key":"CreditRequestId","value":"2"},{"disabled":true,"key":"startEffectiveDate","value":"2021-08-01"},{"disabled":true,"key":"endEffectiveDate","value":"2021-09-01"},{"disabled":true,"key":"startPaymentDate","value":"2021-08-01"},{"disabled":true,"key":"endPaymentDate","value":"2021-09-01"},{"disabled":true,"key":"startTransferDate","value":"2021-08-01"},{"disabled":true,"key":"endTransferDate","value":"2021-09-01"},{"disabled":true,"key":"startAgreementDate","value":"2021-08-01"},{"disabled":true,"key":"endAgreementDate","value":"2021-09-01"},{"disabled":true,"key":"delayedInstallment","value":"2"},{"disabled":true,"key":"status","value":"made_effective"},{"key":"page","value":"2"},{"key":"limit","value":"1"},{"disabled":true,"key":"campaignCustomIdentifier","value":"campaign_custom_identifier_code"}],"variable":[]}},"response":[{"id":"b720d6c4-6126-4d31-bcdb-00ecc1ad868a","name":"List","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{base_url}}/{{api_version}}/receipts?page=2&limit=1","host":["{{base_url}}"],"path":["{{api_version}}","receipts"],"query":[{"key":"CreditRequestId","value":"0","type":"text","disabled":true},{"key":"cpf","value":"12312312311","type":"text","disabled":true},{"key":"email","value":"123@123.com","type":"text","disabled":true},{"key":"name","value":"user","type":"text","disabled":true},{"key":"cridOrigin","value":"campaign","type":"text","disabled":true},{"key":"courseId","value":"123","type":"text","disabled":true},{"key":"productType","value":"Boleto","type":"text","disabled":true},{"key":"status","value":"late","type":"text","disabled":true},{"key":"delayedDay","value":"2","type":"text","disabled":true},{"key":"startReleaseDate","value":"2021-08-01","type":"text","disabled":true},{"key":"endReleaseDate","value":"2021-09-01","type":"text","disabled":true},{"key":"CreditRequestId","value":"2","type":"text","disabled":true},{"key":"startEffectiveDate","value":"2021-08-01","type":"text","disabled":true},{"key":"endEffectiveDate","value":"2021-09-01","type":"text","disabled":true},{"key":"startPaymentDate","value":"2021-08-01","type":"text","disabled":true},{"key":"endPaymentDate","value":"2021-09-01","type":"text","disabled":true},{"key":"startTransferDate","value":"2021-08-01","type":"text","disabled":true},{"key":"endTransferDate","value":"2021-09-01","type":"text","disabled":true},{"key":"startAgreementDate","value":"2021-08-01","type":"text","disabled":true},{"key":"endAgreementDate","value":"2021-09-01","type":"text","disabled":true},{"key":"delayedInstallment","value":"2","type":"text","disabled":true},{"key":"status","value":"made_effective","type":"text","disabled":true},{"key":"page","value":"2"},{"key":"limit","value":"1"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"paging\": {\n \"itemsPerPage\": 1,\n \"nextPage\": 3,\n \"currentPage\": 2,\n \"previousPage\": 1,\n \"totalPages\": 10,\n \"totalItems\": 10\n },\n \"content\": [\n {\n \"crid\": 123,\n \"campaignName\": null,\n \"redirectUrl\": \"https://pay.provi.com.br/business_slug\",\n \"email\": \"123@123.com\",\n \"productType\": \"CourseFinancing\",\n \"name\": \"Student name\",\n \"phone\": \"11912341234\",\n \"status\": \"effective\",\n \"hostingStatus\": \"host_not_connected\",\n \"nextPaymentDate\": null,\n \"courseReleasedAt\": null,\n \"courses\": [\n {\n \"id\": 123,\n \"name\": \"Course name\",\n \"isFullTime\": false,\n \"modality\": \"remoto\",\n \"price\": 117480\n }\n ],\n \"saleValue\": 117480,\n \"cpf\": \"12312312312\",\n \"madeEffectiveDate\": \"2021-11-06\",\n \"commission\": {\n \"value\": 18797,\n \"percentage\": 16\n },\n \"receivedValue\": 98683,\n \"missingValue\": 0,\n \"transferDate\": \"2021-12-09\",\n \"installmentCount\": {\n \"current\": {\n \"upfront\": 1,\n \"installments\": 12\n },\n \"paid\": 2,\n \"late\": null\n },\n \"lateDays\": null,\n \"agreementDate\": null,\n \"installmentValue\": 9305,\n \"address\": {\n \"street\": \"Rua do aluno\",\n \"number\": \"1\",\n \"complement\": \"complmento como casa ou apartamento\",\n \"district\": \"Bairo\",\n \"cep\": \"12312312\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\"\n },\n \"pfCount\": 1,\n \"nextPaymentInstallmentId\": 6226438,\n \"expectedTransferDate\": \"2021-12-10\",\n \"showFullPlatformDetails\": false,\n \"showPlatformDetails\": false,\n \"comment\": null,\n \"expectedTedValue\": 98683,\n \"originalInstallmentsValue\": null,\n \"originalNumberOfInstallments\": null,\n \"isRenegotiated\": false\n }\n ]\n}"}],"_postman_id":"b9de81ba-573a-460f-968e-e70b9813b0ba"},{"name":"Find CreditRequest Detail","id":"55d0a471-11f6-4955-b768-9ef09a1b8072","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/receipts/detail/:CreditRequestId","urlObject":{"path":["{{api_version}}","receipts","detail",":CreditRequestId"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"225a064e-31cc-4b0c-b051-ad34d76b6c4a","type":"any","value":"123","key":"CreditRequestId"}]}},"response":[{"id":"22228cd9-9bb9-4699-afc9-7a0cb9348434","name":"CreditRequest Detail","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{base_url}}/{{api_version}}/receipts/detail/:CreditRequestId","host":["{{base_url}}"],"path":["{{api_version}}","receipts","detail",":CreditRequestId"],"variable":[{"key":"CreditRequestId","value":null}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"creditRequestId\": 123,\n \"name\": \"student_name\",\n \"phone\": \"11912341234\",\n \"address\": \"student_address\",\n \"email\": \"8a567198f3@X9a4nA.com\",\n \"productType\": \"MAAS\",\n \"madeEffectiveDate\": \"2021-07-03\",\n \"courses\": [\n {\n \"id\": 21377,\n \"courseName\": \"course_name\"\n }\n ],\n \"value\": 198000,\n \"paidValues\": 60882,\n \"paidValuesProvi\": 0,\n \"TedDate\": null,\n \"expectedTedDate\": null,\n \"totalInstallments\": 13,\n \"hasUpFront\": true,\n \"faturaUrl\": \"\",\n \"NFUrl\": \"\",\n \"installments\": [\n {\n \"count\": 1,\n \"originalValue\": 15674,\n \"paidValue\": 15674,\n \"proviComission\": 784,\n \"receivedValue\": 14890,\n \"status\": \"paid\",\n \"dueDate\": \"2021-10-08\",\n \"userPaidDate\": \"2021-04-08\",\n \"agreementDate\": \"2021-10-08\",\n \"delayedDays\": null,\n \"expectedCompensationDate\": null,\n \"compensationDate\": null,\n \"withdrawDate\": null\n }\n ],\n \"remaining_declarations\": null,\n \"company_name\": null,\n \"linkedin_url\": null,\n \"startsAt\": null,\n \"endsAt\": null,\n \"bankslipValue\": null,\n \"bankslipDueDate\": null,\n \"bankslipPaidAt\": null,\n \"bankslipStatus\": null,\n \"chargeBack\": {\n \"isChargeBack\": false,\n \"data\": []\n },\n \"cancellation\": {\n \"isCancellation\": false,\n \"data\": []\n }\n}"}],"_postman_id":"55d0a471-11f6-4955-b768-9ef09a1b8072"}],"id":"eee452bc-0022-4ef4-917b-426311049fb8","description":"

Receiving module.

\n","event":[{"listen":"prerequest","script":{"id":"2fb12d18-9ddb-4017-963a-683297655be2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"16043f8d-e63d-457b-a8b2-55a96ff0ce63","type":"text/javascript","exec":[""]}}],"_postman_id":"eee452bc-0022-4ef4-917b-426311049fb8"},{"name":"Financial","item":[{"name":"List Maas Financial Movement","id":"afb82df4-e00c-46e7-814a-1b3ee7dade6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/financial/maas?page=2&limit=10","urlObject":{"path":["{{api_version}}","financial","maas"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"name","value":"maria"},{"disabled":true,"key":"email","value":"1e19f2d083@X9a4nA.com"},{"disabled":true,"key":"CreditRequestId","value":"330810"},{"disabled":true,"key":"cpf","value":"15135604766"},{"disabled":true,"key":"courseId","value":"10145"},{"disabled":true,"key":"paymentMethod","value":"Boleto"},{"key":"page","value":"2"},{"key":"limit","value":"10"},{"disabled":true,"key":"startTransferDate","value":"2020-10-26"},{"disabled":true,"key":"endTransferDate","value":"2020-11-26"},{"disabled":true,"key":"startExpectedTransferDate","value":"2021-10-07"},{"disabled":true,"key":"endExpectedTransferDate","value":"2021-10-11"}],"variable":[]}},"response":[{"id":"37fb09e4-cb24-47c2-8ab5-ad2e561a7e5b","name":"List Maas Financial Movement","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{base_url}}/{{api_version}}/financial/maas?page=2&limit=10","host":["{{base_url}}"],"path":["{{api_version}}","financial","maas"],"query":[{"key":"name","value":"maria","type":"text","disabled":true},{"key":"email","value":"1e19f2d083@X9a4nA.com","type":"text","disabled":true},{"key":"CreditRequestId","value":"330810","type":"text","disabled":true},{"key":"cpf","value":"15135604766","type":"text","disabled":true},{"key":"courseId","value":"10145","type":"text","disabled":true},{"key":"paymentMethod","value":"Boleto","type":"text","disabled":true},{"key":"page","value":"2"},{"key":"limit","value":"10"},{"key":"startTransferDate","value":"2020-10-26","type":"text","disabled":true},{"key":"endTransferDate","value":"2020-11-26","type":"text","disabled":true},{"key":"startExpectedTransferDate","value":"2021-10-07","type":"text","disabled":true},{"key":"endExpectedTransferDate","value":"2021-10-11","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"paging\": {\n \"itemsPerPage\": 1,\n \"nextPage\": 3,\n \"currentPage\": 2,\n \"previousPage\": 1,\n \"totalPages\": 10,\n \"totalItems\": 10\n },\n \"content\": [\n {\n \"crid\": 123,\n \"partnerId\": 123,\n \"productType\": \"MAAS\",\n \"status\": \"paid\",\n \"cpf\": \"12312312312\",\n \"phone\": \"11912341234\",\n \"name\": \"Student name\",\n \"email\": \"123@123.com\",\n \"courses\": [\n {\n \"id\": 123,\n \"name\": \"Course name\",\n \"isFullTime\": false,\n \"modality\": \"remoto\",\n \"price\": 198000\n }\n ],\n \"installmentType\": \"4 / 12\",\n \"paidWith\": \"Boleto\",\n \"installmentValue\": 15676,\n \"studentPaidValue\": 16302,\n \"commission\": {\n \"value\": 815,\n \"percentage\": 5\n },\n \"receivedValue\": 15495,\n \"dueDate\": \"2021-11-09\",\n \"paidAt\": \"2022-01-22\",\n \"transferType\": null,\n \"madeEffectiveDate\": \"2021-07-03\",\n \"expectedTransferDate\": \"2022-01-24\",\n \"transferDate\": null,\n \"installmentData\": {\n \"4\": \"false\"\n },\n \"address\": {\n \"street\": \"Rua do aluno\",\n \"number\": \"1\",\n \"complement\": \"casa ou apartamento\",\n \"district\": \"Bairro\",\n \"zipCode\": \"12312312\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\"\n }\n }\n ]\n}"}],"_postman_id":"afb82df4-e00c-46e7-814a-1b3ee7dade6d"},{"name":"List available filters","id":"f9c52851-7f2b-4869-bbce-ab99208d8b98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/financial/maas/available-filters","urlObject":{"path":["{{api_version}}","financial","maas","available-filters"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fe7116f6-7e68-45e2-b484-9933375df730","name":"Available Filters","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/financial/maas/available-filters"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"courses\": [\n {\n \"id\": 123,\n \"name\": \"CourseName\"\n }\n ],\n \"paymentMethod\": [\n \"Boleto\",\n \"CreditCard\",\n \"TED\",\n \"tax_compensation_transfer\"\n ]\n }\n}"}],"_postman_id":"f9c52851-7f2b-4869-bbce-ab99208d8b98"}],"id":"e64c571e-a34a-43cd-bbaa-252d4afe759b","_postman_id":"e64c571e-a34a-43cd-bbaa-252d4afe759b","description":""},{"name":"Webhook","item":[{"name":"Webhook Preferences","item":[{"name":"List all preferences","id":"760c6d9f-6330-4294-8c09-dd40c568e390","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/webhook/preferences","description":"

List all webhooks endpoint.

\n","urlObject":{"path":["{{api_version}}","webhook","preferences"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

Preferences id

\n","type":"text/plain"},"key":"id","value":"123"}],"variable":[]}},"response":[{"id":"dd661b81-7c4a-40aa-bdcc-7e20f1b61120","name":"List all preferences","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/webhook/preferences"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"paging\": {\n \"itemsPerPage\": 1,\n \"nextPage\": null,\n \"currentPage\": 1,\n \"previousPage\": null,\n \"totalPages\": 1,\n \"totalItems\": 1\n },\n \"content\": [\n {\n \"id\": 1,\n \"url\": \"https://example.com.br/webhook_provi\",\n \"status\": \"enabled\",\n \"enabledEvents\": [\n \"*\"\n ],\n \"enabledCourses\": [\n \"*\"\n ],\n \"signature\": \"55385646-2789-4575-9775-16b67362a787\"\n }\n ]\n}"}],"_postman_id":"760c6d9f-6330-4294-8c09-dd40c568e390"},{"name":"regenerate signature","id":"8b5d0749-3326-40be-a246-bc1933b8d2e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 123,\n \"replaceCurrentSignature\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/webhook/preference/regenerate-signature","description":"

regenerate webhook token signature what will be sent in headers

\n","urlObject":{"path":["{{api_version}}","webhook","preference","regenerate-signature"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a57c8674-a3dc-4a05-8219-1487fa03de01","name":"regenerate signature","originalRequest":{"method":"PATCH","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 123,\n \"replaceCurrentSignature\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/webhook/preference/regenerate-signature"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Signature updated\",\n \"data\": {\n \"id\": 123,\n \"url\": \"https://www.example.com/slug\",\n \"signature\": \"4bbe472a-53f1-47d3-aa06-a337852f9389\"\n }\n}"}],"_postman_id":"8b5d0749-3326-40be-a246-bc1933b8d2e5"},{"name":"Update preference","id":"ebb31ba0-8e85-4299-9e93-9d697b97465f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"API-Token","name":"Content-Type","value":"{{api_token}}","type":"text"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 123,\n \"enabledEvents\": [\"made_effective\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/webhook-endpoint","description":"

Update webhook details such as what webhook you would like do receive and the URL.

\n","urlObject":{"path":["{{api_version}}","webhook-endpoint"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d7ab2746-609c-48c2-98d2-e86942e7abaa","name":"Update preference","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 123,\n \"enabledEvents\": [\"made_effective\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/webhook-endpoint"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Endpoint updated\",\n \"data\": {\n \"id\": 123,\n \"url\": \"https://www.example.com/slug\",\n \"status\": \"enabled\",\n \"enabledEvents\": [\n \"made_effective\"\n ],\n \"enabledCourses\": [\n \"*\"\n ]\n }\n}"}],"_postman_id":"ebb31ba0-8e85-4299-9e93-9d697b97465f"},{"name":"Create new preference","id":"6aa55bd3-ea76-44b7-95b6-17de9d1757ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-Token","name":"Content-Type","value":"{{api_token}}","type":"text"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"url\": \"https://www.example.com/slug\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/webhook/preference","description":"

Add a webhook endpoint

testando como fica com parágrafo

\n","urlObject":{"path":["{{api_version}}","webhook","preference"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6d26680e-cce2-4bbc-8da6-a3c40efb7a70","name":"Create new preference","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"url\": \"https://www.example.com/slug\"\n}","options":{"raw":{"language":"json"}}},"url":"{{checkout_base_url}}/webhook-endpoint"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Url created\",\n \"data\": {\n \"id\": 1,\n \"url\": \"https://www.example.com/slug\",\n \"status\": \"enabled\",\n \"enabledEvents\": [\n \"*\"\n ],\n \"enabledCourses\": [\n \"*\"\n ],\n \"signature\": \"55385646-2789-4575-9775-16b67362a787\"\n }\n}"}],"_postman_id":"6aa55bd3-ea76-44b7-95b6-17de9d1757ad"},{"name":"Delete preference","id":"2567f78a-333e-4b50-8831-1fc2d04d3df2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/webhook/preference/:id","description":"

Delete a webhook endpoint.

\n","urlObject":{"path":["{{api_version}}","webhook","preference",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"269f3ec3-235d-4f3c-b17f-1cedd9858d6d","name":"Delete preference","originalRequest":{"method":"DELETE","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{base_url}}/{{api_version}}/webhook/preference/:id","host":["{{base_url}}"],"path":["{{api_version}}","webhook","preference",":id"],"variable":[{"id":"90759c32-e07f-4ec0-9440-f9259fd4d337","key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Endpoint deleted\",\n \"data\": {\n \"id\": \"27\",\n \"url\": \"https://www.example.com/slug\",\n \"deleted\": true\n }\n}"}],"_postman_id":"2567f78a-333e-4b50-8831-1fc2d04d3df2"}],"id":"10ed1f0e-9b36-4b14-b3a4-320943611e7b","description":"

Create and configure your webhooks trigger preferences.

\n","_postman_id":"10ed1f0e-9b36-4b14-b3a4-320943611e7b"},{"name":"Webhook History","item":[{"name":"List all webhooks","id":"c4506e8a-cd7f-4d2c-9e30-11d6df8439ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/webhooks?limit=10&page=1","urlObject":{"path":["{{api_version}}","webhooks"],"host":["{{base_url}}"],"query":[{"key":"limit","value":"10"},{"key":"page","value":"1"},{"disabled":true,"key":"sort","value":"asc"},{"disabled":true,"key":"requestStatus","value":"200"},{"disabled":true,"key":"requestStatusNe","value":"200"},{"disabled":true,"key":"startDate","value":"2021-07-01"},{"disabled":true,"key":"endDate","value":"2021-07-10"},{"disabled":true,"key":"webhookStatus","value":"paid"},{"disabled":true,"key":"creditRequest","value":"123"},{"disabled":true,"key":"campaignCustomIdentifier","value":"campaign_custom_identifier_code"}],"variable":[]}},"response":[],"_postman_id":"c4506e8a-cd7f-4d2c-9e30-11d6df8439ec"}],"id":"649a1d0d-b88f-4017-8955-69266f5efbd7","description":"

Check the history of triggered webhooks and their status.

\n","_postman_id":"649a1d0d-b88f-4017-8955-69266f5efbd7"},{"name":"Send Test Webhook","id":"f3bd5b54-9c73-4176-bba1-ed5f47d5f421","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://www.yourdomain.com/provi_webhook\",\n \"event\": \"made_effective\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/webhook/dispatch-test","description":"

You can test two webhook events

'made_effective'
'denied'

IMPORTANT:
A test webbook with fictitious data will be sent

PAYLOAD Example:
This is a sent webhook payload that you can receive.

{\n    id: 127497,\n    is_maas: false,\n    is_provi_pay: true,\n    external_id: null,\n    notification_url: 'https://www.domain.com/webook_handler',\n    webhook: 'made_effective',\n    cpf: '12312312312312',\n    checkout_price_in_cents: 10000,\n    redirect_url: 'https://pay.provi.com.br/your_company_name',\n    courses: [\n      {\n        proviId: 12210,\n        partnerId: null,\n        is_full_time: false,\n        modality: 'remoto',\n        name: 'Course name',\n        price_in_cents: 10000,\n        end_date: null,\n        courseClass: {\n            id: 123,\n            name: 'nome da turma',\n            priceInCents: 123,\n            visible: true\n        }\n      }\n    ],\n    logs: [\n      {\n        webhook: 'made_effective',\n        createdAt: '2020-12-09T19:14:27.828Z'\n      },\n      {\n        webhook: 'logged',\n        createdAt: '2020-12-09T19:11:55.804Z'\n      }\n    ],\n    snapshot: {\n      status: 'settled',\n      basic_info_status: 'incomplete',\n      document_status: 'incomplete',\n      guarantor_status: 'unneeded',\n      signed_date: null,\n      first_installment_paid_date: '2020-12-09T19:14:38.623Z',\n      transferred_at: null,\n      settled_at: '2020-12-09T19:14:38.638Z',\n      installments: 5\n    },\n    userInfo: {\n      name: faker.name.findName(),\n      birthDate: faker.date.recent(),\n      email: faker.internet.email(),\n      phone: '+55-11-91234-1234',\n      address: {\n        zipCode: '12123-123',\n        state: 'SP',\n        city: 'São Paulo',\n        district: 'Bairro de SP',\n        street: 'Rua de SP',\n        number: 868,\n        complement: null\n      }\n    },\n    consultant_id: null,\n    createdAt: '2020-12-09T19:11:54.420Z',\n    updatedAt: '2020-12-09T19:14:38.623Z',\n    product_type: 'provi_pay',\n    payment_method: 'credit_card'\n  }\n\n

\n","urlObject":{"path":["{{api_version}}","webhook","dispatch-test"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fcf24aa1-ca54-47fb-8236-de81e6cad290","name":"Send Test Webhook","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://www.yourdomain.com/provi_webhook\",\n \"event\": \"made_effective\"\n}","options":{"raw":{"language":"json"}}},"url":"{{checkout_base_url}}/v4/webhook/dispatch-test"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"statusText\": \"OK\"\n}"}],"_postman_id":"f3bd5b54-9c73-4176-bba1-ed5f47d5f421"},{"name":"Manual webhook resend","id":"97a4c152-d2e2-491b-adaf-42abe0bd2ca0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookIds\": [\"123abs\", \"456def\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/webhook/dispatch-retry","description":"

This will only work with webhooks that have a status other than 200. You will only be able to perform 4 manual resends for each webhook.

\n","urlObject":{"path":["{{api_version}}","webhook","dispatch-retry"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b98628ec-7aae-4a39-aa5d-992d7dd13070","name":"Manual webhook resend","originalRequest":{"method":"POST","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookIds\": [\"123abs\", \"456def\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{api_version}}/webhook/dispatch-retry"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Done!\"\n}"}],"_postman_id":"97a4c152-d2e2-491b-adaf-42abe0bd2ca0"}],"id":"6defd9bc-0f23-45ec-80ed-6f9e3cab231c","description":"

We only send sales funnel related webhooks. Webhooks are sent according to the status of each credit order step during this sales funnel.

To check the status of the sales funnel stages, check out the sales status section.

You can create and configure your webhooks trigger preferences, as well as consult the history of triggered webhooks and their status.

Webhooks Retry Policy

Automatic resend:

Will only be sent to http response code other than 200
It will only be resent 4 times, or until the status returns 200.
Each sending attempt will have a 30 minute interval.

Manual resend:

You will only be able to resend webbook that has http response code other than 200
You can only resend 4 times, or until the status returns 200.

\n","event":[{"listen":"prerequest","script":{"id":"746ec60b-4836-41bc-a648-fde70a25bcfc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7fc2c6f8-7c2a-4f4f-bf8d-3fc6fd08e14c","type":"text/javascript","exec":[""]}}],"_postman_id":"6defd9bc-0f23-45ec-80ed-6f9e3cab231c"},{"name":"Available Areas","item":[{"name":"List all Macro Areas","id":"b2f737bd-f3d3-4697-9445-1c919a161ce5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/areas/macro","urlObject":{"path":["{{api_version}}","areas","macro"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cecf886d-3534-4499-8cfe-8d088edb8204","name":"List all Macro Areas","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/areas/macro"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"paging\": null,\n \"metadata\": {\n \"defaultMacroAreaId\": 1\n },\n \"content\": [\n {\n \"id\": 1,\n \"name\": \"Digital Skills\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:49.331Z\",\n \"updatedAt\": \"2020-06-11T18:22:35.411Z\"\n },\n {\n \"id\": 2,\n \"name\": \"Negócios, Vendas e Finanças\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:49.723Z\",\n \"updatedAt\": \"2020-06-11T18:22:35.737Z\"\n },\n {\n \"id\": 3,\n \"name\": \"Humanas\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:50.092Z\",\n \"updatedAt\": \"2020-06-11T18:22:36.050Z\"\n },\n {\n \"id\": 4,\n \"name\": \"Saúde, Estética e Healthcare\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:50.464Z\",\n \"updatedAt\": \"2020-06-11T18:22:36.366Z\"\n },\n {\n \"id\": 5,\n \"name\": \"Outros\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:50.858Z\",\n \"updatedAt\": \"2020-06-11T18:22:36.711Z\"\n }\n ]\n}"}],"_postman_id":"b2f737bd-f3d3-4697-9445-1c919a161ce5"},{"name":"List Micro Area Group","id":"e908f0d7-b171-47f0-89d2-59848943fa57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/areas/micro-area-group/:MacroAreaId","urlObject":{"path":["{{api_version}}","areas","micro-area-group",":MacroAreaId"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"301f03bb-6139-4002-ba60-e7a2ab11f33d","type":"any","value":"1","key":"MacroAreaId"}]}},"response":[{"id":"707ebb7f-6cab-4234-91e6-54cae56857b6","name":"List Micro Area Group","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{base_url}}/{{api_version}}/areas/micro-area-group/:MacroAreaId","host":["{{base_url}}"],"path":["{{api_version}}","areas","micro-area-group",":MacroAreaId"],"variable":[{"key":"MacroAreaId","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"paging\": null,\n \"metadata\": {\n \"skills\": []\n },\n \"content\": [\n {\n \"id\": 1,\n \"name\": \"Programação\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:52.773Z\",\n \"updatedAt\": \"2020-06-11T18:22:37.635Z\"\n },\n {\n \"id\": 2,\n \"name\": \"Produto Digital\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:53.148Z\",\n \"updatedAt\": \"2020-06-11T18:22:37.958Z\"\n },\n {\n \"id\": 3,\n \"name\": \"Inovação\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:53.542Z\",\n \"updatedAt\": \"2020-06-11T18:22:38.273Z\"\n },\n {\n \"id\": 4,\n \"name\": \"Marketing\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:53.930Z\",\n \"updatedAt\": \"2020-06-11T18:22:38.590Z\"\n },\n {\n \"id\": 8,\n \"name\": \"Audiovisual\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:55.547Z\",\n \"updatedAt\": \"2020-06-11T18:22:39.855Z\"\n },\n {\n \"id\": 9,\n \"name\": \"Business Inteligence\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:55.939Z\",\n \"updatedAt\": \"2020-06-11T18:22:40.182Z\"\n },\n {\n \"id\": 5,\n \"name\": \"Design e UI/UX\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:54.333Z\",\n \"updatedAt\": \"2020-06-11T18:22:38.908Z\"\n },\n {\n \"id\": 6,\n \"name\": \"Data\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:54.804Z\",\n \"updatedAt\": \"2020-06-11T18:22:39.221Z\"\n },\n {\n \"id\": 10,\n \"name\": \"Outros em Digital Skills\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:56.299Z\",\n \"updatedAt\": \"2020-06-11T18:22:40.517Z\"\n },\n {\n \"id\": 7,\n \"name\": \"Software em geral\",\n \"active\": true,\n \"createdAt\": \"2020-03-19T01:48:55.171Z\",\n \"updatedAt\": \"2020-06-11T18:22:39.537Z\"\n }\n ]\n}"}],"_postman_id":"e908f0d7-b171-47f0-89d2-59848943fa57"}],"id":"a7b94663-c279-4eb5-88d0-74601372f784","_postman_id":"a7b94663-c279-4eb5-88d0-74601372f784","description":""},{"name":"Campus","item":[{"name":"List all campus","id":"31fca1ba-4f80-4cdb-ad88-3226166682db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/campus","urlObject":{"path":["{{api_version}}","campus"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"af93879c-a4ac-474d-975f-f457412a5570","name":"List all campus","originalRequest":{"method":"GET","header":[{"key":"API-Token","value":"{{api_token}}","type":"text"}],"url":"{{base_url}}/{{api_version}}/campus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"count\": 1,\n \"rows\": [\n {\n \"id\": 123,\n \"name\": \"Provi\",\n \"AddressId\": 123,\n \"creator\": \"partner_employee@email.com\",\n \"active\": true,\n \"createdAt\": \"2021-08-06T11:59:58.702Z\",\n \"updatedAt\": \"2021-08-06T11:59:58.702Z\"\n }\n ]\n}"}],"_postman_id":"31fca1ba-4f80-4cdb-ad88-3226166682db"}],"id":"b0bd4db2-f86d-4ad2-a813-d318c9ce4ffe","_postman_id":"b0bd4db2-f86d-4ad2-a813-d318c9ce4ffe","description":""}],"event":[{"listen":"prerequest","script":{"id":"6b200bd1-ad0d-46d5-b552-0c1b57eb0dbe","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ad5633ea-c85a-4b32-9465-057982b2ac90","type":"text/javascript","exec":[""]}}]}