Disable Payment Link

API data

API Gateway
This API is used for payment gateway operations:

• Production: https://api.sopague.com.br/gateway
• Sandbox: https://api-hmg.sopague.com.br/gateway
• Architecture: Representational State Transfer (REST)

Disable a payment link

If you want to disable a payment link (to prevent it from being paid), send a POST request as shown below.

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

Via REST request with query parameters.

Data dictionary - Parameters

PROPERTY	DESCRIPTION	TYPE	LOCATION	REQUIRED
id	Identifier of the payment link to disable	Guid	query	yes
reason	Reason for disabling the payment link	String	query	no

🟢 200

Link disabled successfully

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

Data dictionary - Response

PROPERTY	DESCRIPTION	TYPE	LOCATION	REQUIRED
id	Identifier of the disabled payment link	Guid	Body	yes
sucess	Indicates whether the operation succeeded	Boolean	Body	yes
message	Operation response message	String	Body	yes

🔴 400

Request error

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

Data dictionary - Response

PROPERTY	DESCRIPTION	TYPE
tag	Error tag	string
description	Error description	string

🔴 500

Internal error

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

Data dictionary - Response

PROPERTY	DESCRIPTION	TYPE
tag	Error tag	string
description	Error description	string