Create Account

Create Account through this project environment’s SafeHaven account. Uses snake_case fields and NGN minor units. Requires accounts:write.

Use with AI

Download Claude instructions Download Codex instructions All AI integration resources

Markdown

POSThttps://api.veyqo.org/api/v1/safehaven/accountsIntegration guide

Use your sandbox environment to start. Understand error codes and payment statuses before handling a live payment.

Create Account

curl --request POST "https://api.veyqo.org/api/v1/safehaven/accounts" \
  --header "Authorization: Bearer $VEYQO_SECRET_KEY" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: $OPERATION_IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "account_type": "Savings",
  "suffix": "example"
}'

{
  "success": true,
  "data": {
    "can_debit": false,
    "can_credit": false,
    "_id": "000000000000000000000001",
    "client": "example",
    "account_product": "example",
    "account_number": "0000000000",
    "account_name": "example",
    "account_type": "example",
    "currency_code": "example",
    "bvn": "example",
    "account_balance": 0,
    "book_balance": 0,
    "interest_balance": 0,
    "with_holding_tax_balance": 0,
    "status": "Created",
    "is_default": false,
    "nominal_annual_interest_rate": 0,
    "interest_compounding_period": "example",
    "interest_posting_period": "example",
    "interest_calculation_type": "example",
    "interest_calculation_days_in_year_type": "example",
    "min_required_opening_balance": 0,
    "lockin_period_frequency": 0,
    "lockin_period_frequency_type": "example",
    "allow_overdraft": false,
    "overdraft_limit": 0,
    "charge_with_holding_tax": false,
    "charge_value_added_tax": false,
    "charge_stamp_duty": false,
    "notification_settings": {
      "sms_notification": false,
      "email_notification": false,
      "email_monthly_statement": false,
      "sms_monthly_statement": false
    },
    "is_sub_account": false,
    "is_deleted": false,
    "created_at": "example",
    "updated_at": "example",
    "__v": 0,
    "cba_account_id": "000000000000000000000001",
    "operation_id": "pso_01M6EB66SC61Q3RQYAN0693DGM"
  }
}

Illustrative examples. Replace IDs and environment variables with your own values. Keep secret keys on your server.

Headers

Authorizationstringrequired: Bearer <secret-key>. This key determines your project environment and must stay on your server.
Content-Typestringrequired: application/json
Acceptstringoptional: application/json
Idempotency-Keystringoptional: Persist one key for the operation and reuse it with the unchanged body on retries. Maximum 255 characters.

Endpoint

POST https://api.veyqo.org/api/v1/safehaven/accounts

Server secret key required. Scope: accounts:write. The key determines the project and environment; no project-selection header is accepted.

For each new operation, generate and persist one OPERATION_IDEMPOTENCY_KEY. Retry the unchanged request with that same key. Do not generate a new key on every retry.

Request body

account_typestringrequired: This is the type of account you wish to create. Values: Savings, Current.
suffixstringrequired: This is the suffix to be added to the account name.
metadataobjectoptional: Maximum 20 entries.

Response fields

can_debitbooleanoptional: See the JSON example.
can_creditbooleanoptional: See the JSON example.
_idstringoptional: See the JSON example.
clientstringoptional: See the JSON example.
account_productstringoptional: See the JSON example.
account_numberstringoptional: See the JSON example.
account_namestringoptional: See the JSON example.
account_typestringoptional: See the JSON example.
currency_codestringoptional: See the JSON example.
bvnstringoptional: See the JSON example.
account_balanceintegeroptional: Amount in NGN minor units (kobo).
book_balanceintegeroptional: Amount in NGN minor units (kobo).
interest_balanceintegeroptional: Amount in NGN minor units (kobo).
with_holding_tax_balanceintegeroptional: Amount in NGN minor units (kobo).
statusstringoptional: See the JSON example.
is_defaultbooleanoptional: See the JSON example.
nominal_annual_interest_rateintegeroptional: See the JSON example.
interest_compounding_periodstringoptional: See the JSON example.
interest_posting_periodstringoptional: See the JSON example.
interest_calculation_typestringoptional: See the JSON example.
interest_calculation_days_in_year_typestringoptional: See the JSON example.
min_required_opening_balanceintegeroptional: See the JSON example.
lockin_period_frequencyintegeroptional: See the JSON example.
lockin_period_frequency_typestringoptional: See the JSON example.
allow_overdraftbooleanoptional: See the JSON example.
overdraft_limitintegeroptional: See the JSON example.
charge_with_holding_taxbooleanoptional: See the JSON example.
charge_value_added_taxbooleanoptional: See the JSON example.
charge_stamp_dutybooleanoptional: See the JSON example.
notification_settingsobjectoptional: See the JSON example.
notification_settings.sms_notificationbooleanoptional: See the JSON example.
notification_settings.email_notificationbooleanoptional: See the JSON example.
notification_settings.email_monthly_statementbooleanoptional: See the JSON example.
notification_settings.sms_monthly_statementbooleanoptional: See the JSON example.
is_sub_accountbooleanoptional: See the JSON example.
is_deletedbooleanoptional: See the JSON example.
created_atstringoptional: See the JSON example.
updated_atstringoptional: See the JSON example.
__vintegeroptional: See the JSON example.
cba_account_idstringoptional: See the JSON example.
operation_idstringoptional: Veyqo pso_ operation ID. Save it to reconcile retries and match provider_service.updated events.
merchant_referencestringoptional: Your external_reference or payment_reference, if supplied. SafeHaven receives a globally unique Veyqo reference for supported writes.

Errors and recovery

Code	HTTP	Recovery	Retry policy
VALIDATION_FAILED	422	Read error.details when present, correct the named fields and retry only after correction. Validation messages may describe state/capability errors without field details.	No automatic retry.
INVALID_API_KEY	401	Use a current kc_test_ or kc_live_ secret key on /api/v1. Use a pk_test_ or pk_live_ publishable key only on browser checkout.	After fixing credentials.
INSUFFICIENT_PERMISSION	403	Grant the required scope or use a suitably scoped key. Dashboard organization roles and staff permissions are separate.	After permission changes.
RESOURCE_NOT_FOUND	404	Check the ID, project and environment. Do not guess another project’s IDs. An inactive payment link is also not-found.	No blind retry.
PROVIDER_NOT_CONNECTED	422	Connect a provider, choose the project default, or explicitly pass provider. An account shared with another project still needs its own assignment here.	After configuration changes.
PROVIDER_AUTHENTICATION_FAILED	502	The merchant must check/rotate the provider credentials in the dashboard. Do not expose those secrets to your application users.	After credential correction; reconcile existing payment first.
PROVIDER_REQUEST_FAILED	422	Read the safe message, inspect the payment’s failure details and correct the request or provider account. Never repeatedly retry a business rejection.	Only after resolving the cause.
PROVIDER_UNAVAILABLE	503	Check the existing payment and verify its state before starting another attempt. Retry safe reads with backoff; preserve operation identity for retried writes.	Conditional: reconcile unknown outcomes first.
RATE_LIMIT_EXCEEDED	429	Honor Retry-After, use bounded exponential backoff with jitter, and reduce concurrent requests. Read X-RateLimit headers.	Yes, after Retry-After; preserve write idempotency.
IDEMPOTENCY_KEY_REUSED	409	Reuse the exact original request to recover that operation, or use a new key only for a genuinely different operation.	Do not retry a changed body with that key.
IDEMPOTENCY_IN_PROGRESS	409	Wait briefly, retry with the same key and unchanged request, then reconcile by reference if the result remains uncertain.	Back off with jitter; preserve key/body.

Complete error catalogue

Every Veyqo error code, including which surface emits it and how to recover.