Reject Payout(🚧 in development)

POST 
/payouts/reject

Rejects a payout. This operation is only applicable to payouts in the 'completed' status and can only be performed if the payout provider (identified by providerCode) supports the rejection of successfully completed payouts.

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 rejection successful

application/json

Schema

Schema

data object

payoutNumber stringrequired

Unique code identifying the specific payout.

operationType stringrequired

Possible values: [reject]

Operations type

Example (from schema)

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

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...