Yapper Docs
Api reference
POST
/processes/{processId}/cancel

Cancels a process started through the API while it hasn't been sent to the provider, usually its first few seconds, and refunds it in full. It then reads as failed with error.code cancelled, and process.failed goes to webhooks. Once the provider has accepted it, the call answers 409 conflict and the process runs to the end (a failure is refunded automatically). Canvas runs and wallet-funded runs can't be cancelled.

Authorization

bearerAuth processes:write
AuthorizationBearer <token>

In: header

Scope: processes:write

Path Parameters

processId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/processes/string/cancel"
{  "data": {    "id": "string",    "status": "failed",    "cancelled": true,    "error": {      "code": "string",      "message": "string"    },    "links": {      "self": "string"    }  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}