Sign in
Payout Service

Withdraw a Payment

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'
post/v1/payments/{paymentId}/withdraw

Path parameters

paymentIdstring uuid required

Id of the Payment

Request body

reasonstring required

Reason for withdrawal

Example request

{
  "reason": "Payment submitted in error"
}

Response

The payment was withdrawn

Changes