Skip to main content
POST
/
virtual-accounts
/
withdraw
Withdraw funds
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/virtual-accounts/withdraw \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "account_id": "<string>",
  "amount": 123,
  "currency": "<string>",
  "external_account_id": "<string>",
  "bank_code": "<string>",
  "beneficiary_account_number": "<string>"
}
'
{
  "status": "<string>",
  "data": {
    "transaction_id": "<string>",
    "account_id": "<string>",
    "amount": 123,
    "currency": "<string>",
    "payment_rail": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Headers

​
Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

​
X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Body

application/json
​
account_id
string
required
​
amount
number<float>
required
​
currency
string
required
​
external_account_id
string | null

Pre-linked external bank account ID as the withdrawal destination.

​
bank_code
string | null

Bank code (required if not using external_account_id)

​
beneficiary_account_number
string | null

Response

Withdrawal initiated

​
status
string
​
data
object