post/api/v1/openapi/payout_requests/{id}/cancel

Cancel scheduled payout

Cancel a scheduled payout. No request body.

Path parameters

idrequired

string<uuid>

Payout request ID (`payout_requests.id`, UUID). Invalid or not under this business → `800000 Parameter error`.

Example:

Header parameters

X-Skip-Signature

string

Example: TRUE

Signature

string

Example: good

Credential

string

Example: {{credential}}

x-request-id

string

Example: {{$string.uuid}}

x-i18n-lang

string

Example: zh-CN

Content-typerequired

string

Example: application/json

Responses

Cancelled successfully

coderequired

enum<integer>

Always 200 on success

200

Example: 200

messagerequired

enum<string>

Always succeed on success

succeed

Example: succeed

object

required

object

Request · cURL

curl -X POST "https://api.wonder.app/api/v1/openapi/payout_requests/{id}/cancel" \
  -H "Content-Type: application/json" \
  -H "X-Skip-Signature: <X-Skip-Signature>" \
  -H "Signature: <Signature>" \
  -H "Credential: <Credential>" \
  -H "x-request-id: <x-request-id>"

Response 200

{
  "code": 200,
  "data": {
    "payout_request": {
      "id": "1a2b3c4d-1111-2222-3333-444455556666",
      "amount": "200.00",
      "currency": "HKD",
      "created_at": "2026-07-22T04:00:00Z",
      "cancelled_at": "2026-07-22T05:00:00Z",
      "transfer_status": "Reversed"
    }
  },
  "message": "succeed"
}

PreviousGet payout request Next List payout requests