Create fiat currency account - PCX Developer Docs

curl --request POST \ --url https://prod-api.pcxpay.com/v1/virtual-accounts/currency \ --header 'Authorization: <authorization>' \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: <x-api-key>' \ --data ' { "org_id": "<string>", "currency": "NGN", "user_id": "<string>" } '

{ "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

currency

string

required

ISO 4217 currency code (e.g. NGN, USD, GBP, EUR)

Example:

"NGN"

user_id

string | null

Response

Account created

account_id

string

org_id

string

user_id

string | null

currency

string

account_type

enum<string>

Available options:

currency_account,

internal_bank_account,

internal_crypto_account

balance

number<float>

Available (cleared) balance. Use this when checking funds for a withdrawal.

ledger_balance

number<float>

Total balance including pending transactions not yet settled.

status

enum<string>

Available options:

active,

frozen,

inactive

account_number

string | null

bank_name

string | null

created_at

string<date-time>

updated_at

string<date-time>