Skip to main content
POST
/
virtual-accounts
/
onboard
Onboard a customer
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/virtual-accounts/onboard \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "org_id": "<string>",
  "user_id": "<string>",
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>",
  "initial_balance": 123
}
'
{
  "status": "<string>",
  "data": {
    "account_id": "<string>",
    "org_id": "<string>",
    "user_id": "<string>",
    "currency": "<string>",
    "balance": 123,
    "ledger_balance": 123,
    "account_number": "<string>",
    "bank_name": "<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
org_id
string
required
user_id
string
required
email
string<email>
required
first_name
string
last_name
string
phone
string
initial_balance
number<float> | null

Response

Customer onboarded

status
string
data
object