Skip to main content

Cancel a Payin

Cancel a Payin by ID.

warning

This API spec is a Work in Progress and is subject to change during Q2 2025.

To perform this operation, the Payin must be in the PENDING status; if the activity SETTLE_INCOMING_TRANSFER exists, it must be in the PENDING status and the status_code must not be CANCELED. Otherwise, the operation will fail.

Endpoint​

PATCH /v1/payins/:id/cancel
Scope​

payins:cancel

Request​

Request Body​

An empty body or an empty JSON object ({}) is required. Either is accepted.

{}

Response​

{
  "output": {
    "id": "84203386-d88a-92cb-b5fe-61c328euffhueif49",
    "msg": "Process to cancel the payin has been started"
  },
  "code": "OK",
}

Test the endpoint​

curl -X PATCH 'https://api.minteo.finance/v1/payins/{payin_id}/cancel' \
-H 'Authorization: Bearer <your-api-key>'