account_reference (the unique ID you defined at creation) or by the customer’s email address. Both methods return an identical virtual account object.
Replace
sandbox.lyseis-pay.com with live.lyseis-pay.com when moving to production.Headers (both endpoints)
Method 1 — Look Up by Reference
account_reference you assigned when the account was created.
Path Parameters
string
required
The unique reference you assigned to the virtual account at creation (e.g.
customer_123).Example Request
Example Response
Method 2 — Look Up by Email
account_reference available.
Request Body
string
required
The email address of the customer whose virtual account(s) you want to retrieve.
Example Request
Example Response
Virtual Account Object Fields
string
The virtual bank account number to share with the customer for inbound transfers.
string
The name of the partner bank or institution that issued the virtual account.
string
The CBN-assigned sort code or bank code for the issuing bank.
string
The merchant-defined unique reference for this virtual account.
string
Paylink’s internal reference for the account reservation.
string
Current activation state of the account. Typical values:
active, inactive, frozen.string
Full name of the customer associated with the account.
string
Email address of the customer associated with the account.
string
ISO 4217 currency code for the account (e.g.
NGN).object
Metadata key-value pairs attached to the account at creation.
string
ISO 8601 timestamp when the virtual account was provisioned.