Skip to main content
GET
Get inbound transfer simulation options for a Virtual Account

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Path Parameters

virtualAccountId
string
required

Virtual Account ID (va_ prefix).

Response

The request has succeeded.

Response for GET /virtual-accounts/{id}/simulate/inbound-transfer: what a POST to the same path would accept for this Virtual Account right now.

virtualAccountId
string
required

The Virtual Account described (va_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
available
enum<boolean>
required

Always true on this shape.

Available options:
true
methods
(US bank account method · object | International bank account method · object)[]
required

The methods a POST accepts. Never empty.

Minimum array length: 1

A bankUs method: one of the US networks.

maximumAmount
string
required

The largest amount a POST accepts (inclusive).