Management API

Management API

On this page, you can find all changes in our Management API. For an overview of the changes, you can filter the release notes by version and release date.

Get updates by RSS

Filter by

3

16 Oct, 2023

New

You can now assign terminals using the POST /terminals/{terminalId}/reassign call.

You can now retrieve and update the restartHour of your payment terminal.

You can now configure the event notification button on the payment terminal screen using the parameter showButton.

You can now query the GET /companies/{companyId}/androidApps call by the packageName, packageName and the versionCode of the Android app.

You can now query the GET /companies/{companyId}/androidCertificates call by the certificateName of the Android certificate.

We added two new payment method webhooks: paymentMethodRequest.scheduledForRemoval and paymentMethodRequest.removed.

Breaking Changes

For the /merchants/{merchantId}/stores endpoint, we now validate the format of the phoneNumber parameter against E.164.

You can now provide a CNPJ number as a externalReferenceId when creating a store.

For the GET /terminals call, we replaced companyAccount parameter with companyId and removed the storeStatus parameter.

When making a POST /merchants/{merchantId}/stores call to create a store, you now get a HTTP status code 200 instead of 201.

For the /merchants/{merchantId}/paymentMethodSettings endpoint, we renamed the storeId request and response parameters to storeIds.

We removed the PaymentMethod object from the data array of the GET /merchants/{merchantId}/paymentMethodSettings call. The list of supported payment methods is now inside the data array.