---
title: "Withdraw a Payment"
method: POST
path: "/v1/payments/{paymentId}/withdraw"
tags: ["Payouts"]
---

# Withdraw a Payment

`POST /v1/payments/{paymentId}/withdraw`

## Request

- Base URL: `https://api.sandbox.velopayments.com`
- URL: `https://api.sandbox.velopayments.com/v1/payments/{paymentId}/withdraw`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.sandbox.velopayments.com/v1/login`

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'

## Path parameters

- `paymentId` string, uuid, required

## Request body

- WithdrawPaymentRequest
  - `reason` string, required: Reason for withdrawal

## Response `204`

The payment was withdrawn

## Other responses

- `400`: Invalid request. See Error message payload for details of failure
- `401`: Invalid access token. May be expired or invalid
- `403`: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions
- `404`: The resource was not found or is no longer available

## Changes

- **2022-12-22** `2c03ca69ee09`: 2 info
  - api tag `Payouts` added
  - api tag `Payout Service` removed
- **2020-10-30** `dd71433847a6`: 4 breaking, 24 info
  - the `errors/items/` response's property type changed from no type to `object` for status `400`
  - the `errors/items/` response's property type changed from no type to `object` for status `401`
  - the `errors/items/` response's property type changed from no type to `object` for status `403`
  - the `errors/items/` response's property type changed from no type to `object` for status `404`
  - …24 more
- **2020-06-24** `aded220b0d7b`: 2 breaking, 2 info
  - the response's body type changed from `object` to no type for status `404`
  - the `errors/items/` response's property type changed from `object` to no type for status `404`
  - api tag `Payout Service` added
  - api tag `Withdraw Payment` removed
- **2020-03-19** `10644a139f81`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v1/payments/:paymentId/withdraw/post.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) - [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/revisions/05c3f09fc50a?raw)