Endpoints

This content aims to help developers with regard to integration with other languages in which we do not yet offer a library, or those who wish to integrate with our API without using any of our available SDKs, for that we provide the Collection Postman Gerencainet API Charges.

Method	Endpoint	Description	Details
POST	/v1/charge/one-step	Create new transaction with assigned payer	Vide link
POST	/v1/charge	Create new transaction	Vide link
GET	/v1/charge/:id	Return existing transaction information	Vide link
PUT	/v1/charge/:id/metadata	Include information like "notification_url" and "custom_id" in an existing transaction	Vide link
PUT	/v1/charge/:id/billet	Change due date of an existing transaction	Vide link
PUT	/v1/charge/:id/cancel	Cancel an existing transaction	Vide link
POST	/v1/charge/:id/pay	Associates payment method with an already created transaction	Vide link
POST	/v1/charge/:id/billet/resend	Resending the boleto bancário to the desired email	Vide link
POST	/v1/charge/:id/history	Add description to transaction history	Vide link
POST	/v1/charge/:id/link	Returns a link to a Gerencianet payment screen	Vide link
PUT	/v1/charge/:id/link	Change certain parameters/attributes of an existing payment link	Vide link
POST	/v1/charge/:id/balance-sheet	Defines that the transaction will be of the boleto balancete type	Vide link
PUT	/v1/charge/:id/settle	Allows you to mark as paid (manual download) a certain transaction	Vide link

Endpoints: Carnês

Method	Endpoint	Description	Details
POST	/v1/carnet	Create one carnê	Vide link
GET	/v1/carnet/:id	Returns existing carnet information	Vide link
PUT	/v1/carnet/:id/metadata	Include information like "notification_url" and "custom_id" in an existing carnet	Vide link
PUT	v1/carnet/:id/parcel/:parcel	Change the due date of a specific installment of a carnê	Vide link
PUT	/v1/carnet/:id/cancel	Cancel a certain carnê	Vide link
PUT	v1/carnet/:id/parcel/:parcel/cancel	Cancellation of a specific installment of an existing carnê	Vide link
POST	/v1/carnet/:id/resend	Resend carnê by email	Vide link
POST	/v1/carnet/:id/parcel/:parcel/resend	Resend by e-mail a certain portion of a carnê	Vide link
POST	/v1/carnet/:id/history	Add information to the history of a carnet	Vide link
PUT	/v1/carnet:id/parcel/:parcel/settle	Allows you to mark as paid (manual write-off) a certain installment of a carnê	Vide link

Endpoints: Notifications

Method	Endpoint	Description	Details
GET	/v1/notification/:token	Retorna o histórico de notificações enviadas a uma determinada transação	Vide link

Endpoints: Assinaturas

Method	Endpoint	Description	Details
POST	/v1/plan	Create the subscription plan	Vide link
GET	/v1/plans	Returns information for a plan	Vide link
PUT	/v1/plan/:id	Allows changing (editing) the name of a pre-existing subscription plan	Vide link
DELETE	/v1/plan/:id	Cancel a subscription plan	Vide link
POST	/v1/plan/:id/subscription	Create subscriptions to link to plans	Vide link
GET	/v1/subscription/:id	Returns information for a subscription linked to a plan	Vide link
PUT	/v1/subscription/:idcancel	Cancel active subscriptions to a subscription plan	Vide link
PUT	/v1/subscription/:id/metadata	Change notification URL ("notification_url") and/or "custom_id" in an existing subscription	Vide link
POST	/v1/subscription/:id/pay	Associate Payment Method with an already created subscription	Vide link
POST	/v1/subscription/:id/history	Adds Description to the history of a subscription	Vide link

Endpoints: Others

Method	Endpoint	Description	Details
GET	/v1/installments	List installments, according to the credit card brand. Available flags:	Vide link

Relationship between endpoints (Playground) with the name of the functions used by the SDKs

Next, the relationship between the endpoints (Playground) with the name of the functions used by our SDKs in the PHP, NodeJS, Ruby, Python, .NET and Java languages is available.

The files available are in .pdf format and are intended to allow you to identify the name of the functions used by our SDK, according to the endpoints you used and knew in the test environment.

So, after you have explored our Playground well and have known the payment mechanism and flow, it will be easier to proceed with your integration activities. Check, according to your language: