VEvelopaymentsapi
Payouts

Withdraw a Payment

Changed on

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

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

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

  • 2c03ca69ee09Revision changes
    • info

      api tag Payouts added

    • info

      api tag Payout Service removed

  • dd71433847a6Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated