Cyrus — Customer Payment Identity Infrastructure

API Reference · Virtual Accounts

A virtual account is a payment instrument attached to a customer identity. It is provisioned automatically — you never create one directly.

POST/v1/customersauto-provisions a VA

GET/v1/customers/{reference}

Returns the customer and its virtual account, keyed by reference — your own identifier for the customer.

Field	Meaning
accountNumber	Permanent NUBAN — the key every payment is attributed by.
accountName	Display name; updates if you rename the customer.
bankName	e.g. Nombank MFB.
status	ACTIVE SUSPENDED CLOSED

PATCH/v1/customers/{reference}/status

Set status to SUSPENDED to stop accepting credits or CLOSED to retire the account for good. Identity and transaction history are always retained; CLOSED is terminal.