GET
/
v1
/
dedicated_accounts
/
{id}
cURL
curl --request GET \
  --url https://api.paycashless.com/v1/dedicated_accounts/{id} \
  --header 'Request-Signature: <request-signature>' \
  --header 'Request-Timestamp: <request-timestamp>'
{
  "id": "<string>",
  "accountRequestCode": "<string>",
  "customerId": "<string>",
  "currency": "NGN",
  "accountNumber": "<string>",
  "accountName": "<string>",
  "bankName": "<string>",
  "bankId": "<string>",
  "acceptedAmountPolicy": "ACCEPTED_AMOUNT_POLICY_FIXED",
  "status": "active",
  "type": "temporary_virtual_account",
  "liveMode": true,
  "createdAt": "2023-12-25",
  "updatedAt": "2023-12-25",
  "bank": {
    "id": "<string>",
    "name": "<string>",
    "cbnCode": "<string>",
    "nibssCode": "<string>"
  }
}

Headers

Request-Signature
string
required

SHA-512 HMAC signature of the request payload using the API secret

Minimum length: 1
Example:

"5e73d044c44d733fcf819ad3409aaaddca840d421b69cb0b04e2c750fc62ece7526d36296237663ad1f06f62a730c0466516507196b3ce6567493cc52a7cf63d"

Request-Timestamp
string
required

UNIX timestamp when the request was created (in seconds)

Example:

"1712336881"

Path Parameters

id
string
required
Example:

"va_ff0c3z37zi40pvc82g74bgsm4q7fubbw"

Response

200 - application/json

Dedicated account retrieved

id
string
required
accountRequestCode
string | null
required
customerId
string | null
required
currency
enum<string>
required
Available options:
NGN,
USD
accountNumber
string
required
accountName
string
required
bankName
string
required
bankId
string
required
acceptedAmountPolicy
enum<string>
required
Available options:
ACCEPTED_AMOUNT_POLICY_FIXED,
ACCEPTED_AMOUNT_POLICY_ALLOW_PARTIAL,
ACCEPTED_AMOUNT_POLICY_ALLOW_EXCESS,
ACCEPTED_AMOUNT_POLICY_ALLOW_ANY
status
enum<string>
required
Available options:
active,
expired,
no_post_no_debit
type
enum<string>
required
Available options:
temporary_virtual_account,
dedicated_virtual_account,
invoice_payment_account,
dedicated_business_account,
virtual_terminal_account
liveMode
boolean
required
createdAt
string<date>
required
updatedAt
string<date>
required
bank
object
required