Skip to main content
POST
/
pms
/
api
/
external
/
request
/
virtual-cards
/
{card_id}
/
withdraw
/
Withdraw from a Card
curl --request POST \
  --url https://api.payvessel.com/pms/api/external/request/virtual-cards/{card_id}/withdraw/ \
  --header 'Content-Type: <content-type>' \
  --header 'api-key: <api-key>' \
  --header 'api-secret: <api-secret>' \
  --data '
{
  "amount": "5.00"
}
'
import requests

url = "https://api.payvessel.com/pms/api/external/request/virtual-cards/{card_id}/withdraw/"

payload = { "amount": "5.00" }
headers = {
"api-key": "<api-key>",
"api-secret": "<api-secret>",
"Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'api-key': '<api-key>',
'api-secret': '<api-secret>',
'Content-Type': '<content-type>'
},
body: JSON.stringify({amount: '5.00'})
};

fetch('https://api.payvessel.com/pms/api/external/request/virtual-cards/{card_id}/withdraw/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.payvessel.com/pms/api/external/request/virtual-cards/{card_id}/withdraw/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => '5.00'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: <content-type>",
"api-key: <api-key>",
"api-secret: <api-secret>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.payvessel.com/pms/api/external/request/virtual-cards/{card_id}/withdraw/"

payload := strings.NewReader("{\n \"amount\": \"5.00\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("api-key", "<api-key>")
req.Header.Add("api-secret", "<api-secret>")
req.Header.Add("Content-Type", "<content-type>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.payvessel.com/pms/api/external/request/virtual-cards/{card_id}/withdraw/")
.header("api-key", "<api-key>")
.header("api-secret", "<api-secret>")
.header("Content-Type", "<content-type>")
.body("{\n \"amount\": \"5.00\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.payvessel.com/pms/api/external/request/virtual-cards/{card_id}/withdraw/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["api-secret"] = '<api-secret>'
request["Content-Type"] = '<content-type>'
request.body = "{\n \"amount\": \"5.00\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": true,
  "message": "Virtual card creation started",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "kind": "<string>",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_name": "<string>",
    "card_name": "<string>",
    "masked_pan": "<string>",
    "currency": "<string>",
    "brand": "<string>",
    "balance": "<string>",
    "expiry": "<string>",
    "card_number": "<string>",
    "cvv": "<string>",
    "created_datetime": "2023-11-07T05:31:56Z",
    "updated_datetime": "2023-11-07T05:31:56Z"
  }
}
{
"error": 401,
"message": "Unauthorized. Please check your API key."
}
{
"error": 123,
"message": "<string>"
}
{
"error": 123,
"message": "<string>"
}
{
"error": 123,
"message": "<string>"
}

Headers

api-key
string
required

Your Payvessel public API key

api-secret
string
required

Your Payvessel secret

Content-Type
enum<string>
required

Request content type

Available options:
application/json

Path Parameters

card_id
string<uuid>
required

PayVessel card ID

Body

application/json
amount
string
required

USD amount (e.g. 25.00). Withdraw minimum 3.00

Example:

"25.00"

Response

Withdrawal successful

status
boolean
required

Indicates whether the request succeeded

message
string
required

Human-readable result message

Example:

"Virtual card creation started"

data
object
required

Issued card details