ALalfredpay
Virtual Accounts

Retrieve a virtual account

Changed on

Returns one instrument and its deposit instructions.

There's no PATCH. A different configuration is a different instrument, so create a new one.

get/v1/virtual_accounts/{virtualAccountId}

Request

  • Base URL
    https://api.sandbox.alfredpay.io
  • URL
    https://api.sandbox.alfredpay.io/v1/virtual_accounts/{virtualAccountId}
  • Auth
    • HTTP bearer
    • or API key in header api-key and API key in header api-secret

Response

OK

idstring
customerIdstring
purpose'CONVERSION' | 'BALANCE' | 'PAYMENT'

On a virtual account it routes every deposit. On the customer profile (plural) it is the declared intent that gates which may be created.

currency'USD' | 'HKD' | 'CNY' | 'MXN' | 'DOP' | 'COP' | 'BRL' | 'ARS' | 'CLP' | 'PEN' | 'BOB' | 'PYG' | 'USDC' | 'USDT'

Fourteen members, reconciled to the countries a customer can be onboarded in. USDC and USDT are stablecoins and require chain.

labelstring
status'active' | 'suspended' | 'migrating' | 'closed'
createdAtstring date-time

Changes