Skip to main content
POST
/
virtual-accounts
/
link
Link external bank account
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/virtual-accounts/link \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "customer_id": "<string>",
  "currency": "<string>",
  "account_number": "<string>",
  "sort_code": "<string>",
  "routing_number": "<string>",
  "iban": "<string>",
  "bic": "<string>"
}
'
{
  "external_account_id": "<string>",
  "customer_id": "<string>",
  "currency": "<string>",
  "account_number": "<string>",
  "bank_name": "<string>",
  "created_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
customer_id
string
required
currency
string
required
account_number
string | null
sort_code
string | null

GBP accounts

routing_number
string | null

USD accounts

iban
string | null

EUR accounts

bic
string | null

EUR accounts

Response

Account linked

external_account_id
string
customer_id
string
currency
string
account_number
string | null
bank_name
string | null
created_at
string<date-time>