Cancel Payout(🚧 in development)

POST 
/payouts/cancel

Cancels an in-progress payout. This endpoint can only be used if the payout is in the in_progress status and the recipient object was not provided when the payout was initiated (meaning the payout details are to be filled on the payment page). This allows for the cancellation of the created payment page and, thereby, the payout itself.

If the recipient object was provided during payout creation, this endpoint is not applicable.

Request

application/json

Body

Payout parameters

payoutNumber stringrequired

Unique code identifying the specific payout.

shopId integerrequired

Unique identifier for the shop where the payout is being placed.

Responses

200

Payout cancellation successful

application/json

Schema

Schema

data object

payoutNumber stringrequired

Unique code identifying the specific payout.

operationType stringrequired

Possible values: [cancel]

Operations type

Example (from schema)

{
  "data": {
    "payoutNumber": "PAYOUT-123456",
    "operationType": "cancel"
  }
}

400

Error

application/json

Schema

Schema

code stringrequired

Error code

title stringrequired

Detailed error description

detail string

Additional information about the error

Example (from schema)

{
  "code": "401",
  "title": "Input data validation error",
  "detail": "Parameter AAAA is required"
}

Loading...