Sign in
latestOpenAPI 3.0.22026-08-21530310.0 KB

54f4fe726d8f

Virtual Reference Numbers

Create a new Virtual Reference Number

Creates a new Virtual Reference Number (VRN) for the specified Synthetic Account.

post/virtual_reference_numbers

Request body

external_uidExternalUid — unresolved $ref
nameName — unresolved $ref
synthetic_account_uidstring required

A unique id referring to the mapped, general Synthetic Account.

routing_numberstring required

The ABA routing number associated with this VRN.

Response

A single registered Virtual Reference Number is returned

archived_atstring

The DateTime at which this VRN was archived. This value will be present if the status is archived. If in another state, the value will be null.

created_atstring

The DateTime at which this VRN was created

custodial_account_uidstring

A unique id referring to the mapped, Custodial Account.

external_uidExternalUid — unresolved $ref
instant_payment_rail_registration_statusSchema — unresolved $ref
locked_atstring

The DateTime at which this VRN was locked. This value will be present if the status is locked. If in another state, the value will be null.

lock_reason'admin' | 'customer_request'

Provided reason for locking the VRN.

nameName — unresolved $ref
routing_numberstring

The ABA routing number (if any) associated with this VRN.

statusSchema — unresolved $ref
synthetic_account_uidSchema — unresolved $ref
uidstring

Unique identifier for the VRN

virtual_reference_number_last_fourstring

Last 4 digits of the VRN

virtual_reference_numberstring

The VRN