Jul 10, 2023

Esta atualização apresenta várias alterações na API, incluindo modificações em vários endpoints. No endpoint das empresas, houve mudanças nas descrições dos campos "name" e "friendlyName". No endpoint das configurações, foram adicionados novos campos obrigatórios relacionados a validações de pix e desembolsos. No endpoint dos empregos, foram adicionados novos campos de descrição para salário líquido, limite por empréstimo, limite por parcela, data de contratação e salário bruto. No endpoint dos fundos, foram adicionadas descrições para os campos "name" e "document". Mudanças também foram feitas no endpoint das parcelas, notas fiscais, intenções de pagamento e produtos, com a adição, remoção ou alteração de vários campos. Por último, houve uma alteração no endpoint dos webhooks.

Companies
  • GET /v1/companies/{id}:
    • 200 response: changed name.description
    • 200 response: changed friendlyName.description
  • POST /v1/companies/{id}:
    • 200 response: changed name.description
    • 200 response: changed friendlyName.description
    • requestBody: changed name.description
    • requestBody: changed friendlyName.description
  • GET /v1/companies:
    • 200 response: changed data.items.name.description
    • 200 response: changed data.items.friendlyName.description
  • POST /v1/companies:
    • 201 response: changed name.description
    • 201 response: changed friendlyName.description
    • requestBody: changed name.description
    • requestBody: changed friendlyName.description
Configurações
  • GET /v1/settings:
    • 200 response: added validations.pix.credentials.required
    • 200 response: added disbursements.additionalProperties.required
    • 200 response: added disbursements.additionalProperties.credentials.required
  • POST /v1/settings:
    • 200 response: added validations.pix.credentials.required
    • 200 response: added disbursements.additionalProperties.required
    • 200 response: added disbursements.additionalProperties.credentials.required
    • requestBody: added validations.pix.credentials.required
    • requestBody: added disbursements.additionalProperties.required
    • requestBody: added disbursements.additionalProperties.credentials.required
Employments
  • GET /v1/employments/{id}:
    • 200 response: added netSalary.description
    • 200 response: added limitPerLoan.description
    • 200 response: added limitPerInstallment.description
    • 200 response: added hiredAt.description
    • 200 response: added grossSalary.description
  • GET /v1/employments:
    • 200 response: added data.items.netSalary.description
    • 200 response: added data.items.limitPerLoan.description
    • 200 response: added data.items.limitPerInstallment.description
    • 200 response: added data.items.hiredAt.description
    • 200 response: added data.items.grossSalary.description
  • POST /v1/employments:
    • 201 response: added netSalary.description
    • 201 response: added limitPerLoan.description
    • 201 response: added limitPerInstallment.description
    • 201 response: added hiredAt.description
    • 201 response: added grossSalary.description
    • requestBody: added netSalary.description
    • requestBody: added limitPerLoan.description
    • requestBody: added limitPerInstallment.description
    • requestBody: added hiredAt.description
    • requestBody: added grossSalary.description
Fundos
  • GET /v1/funds/{fund}:
    • 200 response: added name.description
    • 200 response: added document.description
  • POST /v1/funds/{fund}:
    • 200 response: added name.description
    • 200 response: added document.description
  • GET /v1/funds:
    • 200 response: added data.items.name.description
    • 200 response: added data.items.document.description
  • POST /v1/funds:
    • 201 response: added name.description
    • 201 response: added document.description
    • requestBody: added name.description
    • requestBody: added document.description
Installments
  • GET /v1/installments/search:
    • query query parameter: changed examples.LessThan.value
    • query query parameter: changed examples.Equal.value
    • query query parameter: changed examples.BiggerThan.value
Invoice
  • GET /v1/invoices/{invoice}/payment-intents/{payment_intent}:
    • 200 response: added support for invoice property
  • GET /v1/invoices/{invoice}/payment-intents:
    • 200 response: added support for data.items.invoice property
  • POST /v1/invoices/{invoice}/payment-intents:
    • 201 response: added support for invoice property
Payment Intents
  • POST /v1/payment-intents/{payment_intent}/pay:
    • 200 response: added support for invoice property
  • POST /v1/payment-intents/{payment_intent}/void:
    • 200 response: added support for invoice property
  • GET /v1/payment-intents/{payment_intent}:
    • 200 response: added support for invoice property
  • GET /v1/payment-intents:
    • 200 response: added support for data.items.invoice property
  • POST /v1/payment-intents:
    • 201 response: added support for invoice property
Products
  • GET /v1/products/eligibles:
    • 200 response: removed support for data.items.termsAndConditions property
    • 200 response: added data.items.metadata.description
  • POST /v1/products/{product}/offers:
    • requestBody: added metadata.description
  • GET /v1/products/{product}:
    • 200 response: removed support for termsAndConditions property
    • 200 response: added status.default
    • 200 response: added status.description
    • 200 response: added slug.description
    • 200 response: added settings.products.disbursement.description
    • 200 response: added name.description
    • 200 response: added metadata.description
    • 200 response: added description.description
  • POST /v1/products/{product}:
    • 200 response: removed support for termsAndConditions property
    • 200 response: added status.default
    • 200 response: added status.description
    • 200 response: added slug.description
    • 200 response: added settings.products.disbursement.description
    • 200 response: added name.description
    • 200 response: added metadata.description
    • 200 response: added description.description
    • requestBody: removed support for termsAndConditions property
    • requestBody: added status.default
    • requestBody: added status.description
    • requestBody: added slug.description
    • requestBody: added settings.products.disbursement.description
    • requestBody: added name.description
    • requestBody: added metadata.description
    • requestBody: added description.description
  • GET /v1/products:
    • 200 response: removed support for data.items.termsAndConditions property
    • 200 response: added data.items.status.default
    • 200 response: added data.items.status.description
    • 200 response: added data.items.slug.description
    • 200 response: added data.items.settings.products.disbursement.description
    • 200 response: added data.items.name.description
    • 200 response: added data.items.metadata.description
    • 200 response: added data.items.description.description
  • POST /v1/products:
    • 200 response: removed support for termsAndConditions property
    • 200 response: added status.default
    • 200 response: added status.description
    • 200 response: added slug.description
    • 200 response: added settings.products.disbursement.description
    • 200 response: added name.description
    • 200 response: added metadata.description
    • 200 response: added description.description
    • requestBody: removed support for termsAndConditions property
    • requestBody: added status.default
    • requestBody: added status.description
    • requestBody: added slug.description
    • requestBody: added settings.products.disbursement.description
    • requestBody: added name.description
    • requestBody: added metadata.description
    • requestBody: added description.description
Webhooks
  • POST /v1/webhooks/kobana: changed