Gerenciamento de URLs de callback
Para facilitar o cadastro e edição de URLs de callback usadas pelo ControlPay pelas automações comerciais, foram criados endpoints pra que as próprias automações possam cadastrar seus callbacks.
Importante!O gerenciamento é feito com base na chave de integração usada. Ou seja: o usuário da chave de integração só pode criar callbacks para si mesmo.
Tipos de callback
| ID | Nome | Significado |
|---|---|---|
| 1 | UrlRetorno | URL de callback para vendas |
| 2 | UrlConsulta | URL de callback para consultas de vendas |
| 3 | UrlRetornoImpressao | URL de callback para impressões |
POST Callback/Insert
Esta API é usada para a criação de callbacks para o usuário da chave utilizada na chamada da API.
Atenção!Esta API realiza apenas a inserção de uma URLs de callback. Para modificação de uma já existente, utilize a API de Update.
{{Url}}/Callback/Insert/?key={{Key}}Variáveis:
{{Url}}/Callback/Insert/?key={{Key}}V: endereço do ambiente atual. "}}>Url: endereço do ambiente a: chave de acesso.
{
“callbackTipo”: 1,
“urlCallback”: “https://suaUrlDeCallback.com.br/”
}• callbackTipo: [int] tipo do callback desejado (venda, consulta, impressão);
• urlCallback: [string] URL de callback a ser cadastrada. Este valor pode ter até 500 caracteres;
Exemplo: Callback/Insert
{
“callbackTipo”: 1,
“urlCallback”: “https://suaUrlDeCallback.com.br/”
}{
"data": "27/02/2026 11:50:15.7139",
"callback": {
"callbackTipo": {
"id": 1,
"nome": "UrlRetorno"
},
"urlCallback": "https://suaUrlDeCallback.com.br/",
"pessoa": {
"id": 1234,
"nome": "NomeDaPessoa",
"sobrenomeNomeFantasia": "Loja da Esquina"
}
}
}GET Callback/GetRegistered
Esta API é usada para recuperar a URL do tipo desejado cadastrada anteriormente para o dono da chave de integração usada na chamada da API.
Atenção!Esta API realiza a leitura das URLs de callback previamente criadas. Para a criação de uma nova URL, utilize a API de Insert.
{{Url}}/Callback/GetRegistered/?key={{Key}}Variáveis:
{{Url}}/Callback/GetRegistered/?key={{Key}}V: endereço do ambiente atual. "}}>Url: endereço do ambiente a: chave de acesso.
(Esta API é apenas um GET, sem body).
Exemplo: Callback/GetRegistered
{
"data": "27/02/2026 11:59:20.5408",
"callback": {
"callbackTipo": {
"id": 1,
"nome": "UrlRetorno"
},
"urlCallback": "https://suaUrlDeCallback.com.br/",
"pessoa": {
"id": 1234,
"nome": "NomeDaPessoa",
"sobrenomeNomeFantasia": "Loja da Esquina"
}
}
}POST Callback/Update
Esta API é usada para modificar uma URL previamente cadastrada.
Atenção!Esta API realiza apenas modificação de URLs de callback previamente criadas. Para a criação de uma nova URL, utilize a API de Insert.
{{Url}}/Callback/Update/?key={{Key}}Variáveis:
{{Url}}/Callback/Update/?key={{Key}}V: endereço do ambiente atual. "}}>Url: endereço do ambiente a: chave de acesso.
{
“callbackTipo”: 1,
“urlCallback”: “https://suaUrlDeCallback.com.br/”
}• callbackTipo: [int] tipo do callback desejado (venda, consulta, impressão);
• urlCallback: [string] URL de callback a ser modificada. Este valor pode ter até 500 caracteres;
Exemplo: Callback/Update
{
“callbackTipo”: 1,
“urlCallback”: “https://suaUrlDeCallbackNova.com.br/”
}{
"data": "27/02/2026 12:00:17.1285",
"callback": {
"callbackTipo": {
"id": 1,
"nome": "UrlRetorno"
},
"urlCallback": "https://suaUrlDeCallbackNova.com.br/",
"pessoa": {
"id": 1234,
"nome": "NomeDaPessoa",
"sobrenomeNomeFantasia": "Loja da Esquina"
}
}
}DELETE Callback/Delete
Esta API é usada para deletar callbacks previamente cadastradas.
{{Url}}/Callback/Delete/?key={{Key}}Variáveis:
{{Url}}/Callback/Delete/?key={{Key}}V: endereço do ambiente atual. "}}>Url: endereço do ambiente a: chave de acesso.
{
“callbackTipo”: 1
}• callbackTipo: [int] tipo do callback desejado (venda, consulta, impressão);
Atenção!Caso não seja enviado um body para essa requisição, o ControlPay assumirá como uma requisição para o tipo UrlRetorno.
Exemplo: Callback/Delete
{
“callbackTipo”: 1
}{
"data": "27/02/2026 12:00:37.4872",
"callback": {
"callbackTipo": {
"id": 1,
"nome": "UrlRetorno"
},
"urlCallback": "https://www.postb.in/1770215647337-6262078641446",
"pessoa": {
"id": 1234,
"nome": "NomeDaPessoa",
"sobrenomeNomeFantasia": "Loja da Esquina"
}
}
}O ControlPay retornará as informações da chave que foi deletada, apenas para conferência.
Updated 1 day ago