Cancel a Scheduled Payout

POST 
https://api.cleverhub.co/api/v2/payouts/cancel_scheduled

You can cancel a payout payment scheduled to run in the future.

Request

application/json

Body

uuidstringrequired
Payout payment UUID
Example: OHXTEF9M

Responses

200

OK

application/json

Schema

Schema

statusstring

Example (auto)

{
  "status": "OK"
}

400

Bad Request

401

Unauthorized

application/json

Schema

Schema

errors object
codestring
messagestring

Example (auto)

{
  "errors": {
    "code": "string",
    "message": "string"
  }
}

Example

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

422

Unprocessable Entity

application/json

Schema

Schema

errors object
statusstring

Example (auto)

{
  "errors": {
    "status": "string"
  }
}

Example

{
  "errors": {
    "status": "Invalid status. Payouts must be scheduled status"
  }
}

Authorization: app-id

name: app-idtype: apiKeydescription: The app-id is registered and secured inside Hello Clever system and only required when client has initiated or in the middle of the transaction.in: header

name: secret-keytype: apiKeydescription: The secret-key is our client's secret of the source. Required if a publishable key is used to retrieve the source.in: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.cleverhub.co/api/v2/payouts/cancel_scheduled");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("app-id", "<app-id>");
request.Headers.Add("secret-key", "<app-id>");
var content = new StringContent("{\n  \"uuid\": \"OHXTEF9M\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cleverhub.co/api

Auth

app-id

secret-key

Body

{
  "uuid": "OHXTEF9M"
}

ResponseClear

Click the Send API Request button above and see the response here!