Skip to main content
POST
/
virtual-accounts
/
link
Link external 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": "USD",
  "bank_name": "Chase Bank",
  "account_owner_name": "<string>",
  "account_number": "<string>",
  "sort_code": "<string>",
  "routing_number": "<string>",
  "account_type": "checking",
  "iban": "<string>",
  "bic": "<string>",
  "swift_code": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "business_name": "<string>",
  "address": {
    "street_line_1": "<string>",
    "street_line_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  }
}
'
{
  "status": "success",
  "message": "Operation completed successfully",
  "data": {
    "external_account_id": "<string>",
    "customer_id": "<string>",
    "currency": "<string>",
    "bank_name": "<string>",
    "account_owner_name": "<string>",
    "account_number": "<string>",
    "account_type": "<string>",
    "provider": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.pcxpay.com/llms.txt

Use this file to discover all available pages before exploring further.

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
Example:

"USD"

​
bank_name
string
required
Example:

"Chase Bank"

​
account_owner_name
string
required
​
account_number
string
​
sort_code
string

UK sort code (GBP accounts)

​
routing_number
string

US routing number (USD accounts)

​
account_type
enum<string>
Available options:
checking,
savings
​
iban
string

SEPA IBAN (EUR accounts)

​
bic
string

SWIFT/BIC code

​
swift_code
string
​
first_name
string
​
last_name
string
​
business_name
string
​
address
object

Response

External account linked

​
status
enum<string>
Available options:
success,
error
Example:

"success"

​
message
string
Example:

"Operation completed successfully"

​
data
object