How to get started with the Payment Link API

To start your integration with the Payment Link API, you will need:

1. Request the establishment number (EC) for the Link de Pagamento;
2. Configure the store settings (customization of the page and choosing payment methods);
3. Set up a notification and status change URL for your store;
4. Get the API access credentials (ClientId and Client Secret);
5. Request an access token via API using the credentials;
6. With the token, create a payment link;
7. When there is a payment attempt on the link, you will receive a notification* with all data filled in at checkout;
8. If the transaction changes status, you will receive a notification* of the status change;
9. To perform tests, use Link de Pagamento's Test Mode. Don't forget to turn off test mode when going into production.

*As long as you have configured the notification URL.

For some registrations, it will not be possible to use the Link de pagamento via API due to business rules. In these cases, the button to generate API credentials on the Cielo website will not be available. If you have any questions, please consult the Cielo support team for guidance.