Skip to main content
POST
/
virtual-accounts
/
onboard
Onboard a customer
curl --request POST \
  --url https://api.pcxpay.com/v1/virtual-accounts/onboard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "org_id": "<string>",
  "user_id": "<string>",
  "org_name": "<string>",
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "customer_type": "individual",
  "phone": "<string>",
  "initial_balance": 123
}
'
{
  "status": "success",
  "message": "Operation completed successfully",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
org_id
string
required
​
user_id
string
required
​
org_name
string
required
​
email
string<email>
required
​
first_name
string
required
​
last_name
string
required
​
customer_type
enum<string>
required
Available options:
individual,
business
Example:

"individual"

​
phone
string
​
initial_balance
number<float>

Optional seed balance for the customer's account

Response

Customer onboarded successfully

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

"success"

​
message
string
Example:

"Operation completed successfully"

​
data
object