Virtual account details

📘
Customer account is required. See onboarding customer for more information.

Once a customer has been successfully approved, a virtual account is automatically created for them.

To be notified when the virtual account becomes active, subscribe to the relevant webhook event. This ensures your system can react immediately once the account is ready for use.

Retrieve Virtual Account Details

Use the endpoint below to fetch a customer’s virtual account information, including account number, bank details, and supported payment methods.

See API reference.

curl --request GET \
  --url https://api.sandbox.keyrails.com/api/v1/customers/{customerId}/virtual-accounts \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{AccessToken}}'

Response

[
  {
    "id": "string",
    "status": "Active",
    "rails": [
      "fedwire", "swift"
    ],
    "asset": "USD",
    "bank": {
      "bankName": "string",
      "accountNumber": "string",
      "routingNumber": "string",
      "swiftCode": "string",
      "address": {
        "street1": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string"
      }
    },
    "accountOwner": {
      "name": "string",
      "address": {
        "street1": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string"
      }
    }
  }
]

Simulate a Wire Deposit (Sandbox Only)

In the sandbox environment, you can simulate a wire deposit into a customer’s virtual account. This is useful for testing deposit flows and webhook handling without initiating a real transfer.

See API reference.

curl --request GET \
  --url https://api.sandbox.keyrails.com/api/v1/customers/{customerId}/simulate-account-deposit \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{AccessToken}}' \
  --data '{ 
    "amount": 1000
  }
'