Request Bank Slip Cancellation

API data

Conciliation & Bank Slips API
These APIs are used for additional features such as bank slip issuance and management:

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

This endpoint requests the cancellation of an issued bank slip. After the request is submitted, an internal routine will process it and either complete the cancellation or return a failure status with the reason.

POST /api/billissuer/request-cancellation?accountNumber={accountNumber}&integrationBillIssuedId={integrationBillIssuedId}

Receives the bank slip ID to cancel and returns a message confirming the request status.

Request

{
  "accountNumber": "long",
  "integrationBillIssuedId": "string"
}

Data dictionary - Parameters

PARAMETER	DESCRIPTION	TYPE	SIZE	NOTES
accountNumber	Account number that issued the bank slip	long	-	-
integrationBillIssuedId	Issued bank slip identifier	String	-	-

🟢 200

Response

{
  "message": "string"
}

Data dictionary - Response

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
message	Operation result message	String	-	-