Withdraw a Payment

Velo Payments Sandbox for testing

https://api.sandbox.velopayments.com/

POST

/v1/payments/{paymentId}/withdraw

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'

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.sandbox.velopayments.com//v1/payments//withdraw' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "Payment submitted in error"
}'

Response Example

204 - Example 1

{}

Request

Path Params

Body Params application/json

Examples

Responses

🟢204The payment was withdrawn

application/json

Body

🟠400Invalid request. See Error message payload for details of failure

🟠401Invalid access token. May be expired or invalid

🟠403The 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

🟠404The resource was not found or is no longer available

Modified at 2022-09-11 21:50:18

List Supported Countries

Submit Payout