Withdraw a Payment

v1.0.0

withdraw a payment

There are a variety of reasons why this can fail

the payment must be in a state of 'accepted' or 'unfunded'
the payout must not be in a state of 'instructed'

Input

{
  "type": "object",
  "properties": {
    "paymentId": {
      "type": "string",
      "format": "uuid"
    },
    "reason": {
      "type": "string",
      "description": "Reason for withdrawal"
    }
  },
  "required": [
    "paymentId",
    "reason"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}