Desativar Lista de Links de Pagamento

Dados da API

API Gateway
Esta API é utilizada para operações do gateway de pagamento:

• Produção: https://api.sopague.com.br/gateway
• Homologação: https://api-hmg.sopague.com.br/gateway
• Arquitetura: Representational State Transfer (REST)

Realizar Operação de Desativação de Link de Pagamento

Caso você queira desativar um link de pagamento, para impedir que ele seja pago, basta requisitar um POST conforme a seguir:

POST /v1/paymentlink/disable?id=<guid>

Via request Representational State Transfer (REST) com query parameters:

Dicionário de dados - Parâmetros

PROPRIEDADE	DESCRIÇÃO	TIPO	LOCAL	OBRIGATÓRIO
id	Identificador do link de pagamento a ser desativado	Guid	Path	sim
reason	Motivo da desativação do link de pagamento	String	Path	não

🟢 200

Pagamento realizado com sucesso

{ 
  "id": "aed32670-c3e5-4192-8ab0-0e96f92e3408", 
  "sucess": true, 
  "message": "Link de pagamento desabilitado com sucesso!" 
}

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO	LOCAL	OBRIGATÓRIO
id	Identificador do link de pagamento a ser desativado	Guid	Body	sim
sucess	Indica se a operação foi realizada com sucesso	Boolean	Body	sim
message	Mensagem de retorno da operação	String	Body	sim

🔴 400

[ 
    { 
      "tag": "", 
      "description": "Nenhum link de pagamento cadastrado" 
    } 
] 

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string

🔴 500

Erro interno

[ 
    { 
        "tag": "", 
        "description": "Não foi possível executar comando. Erro desconhecido." 
    } 
]

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string