NEnewline53
Virtual Reference Numbers

Create a new Virtual Reference Number

Changed on

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

post/virtual_reference_numbers

Request

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.

type'business' | 'consumer'

The type of VRN. Defaults to business if omitted. consumer is only available if enabled for your program.

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

type'business' | 'consumer'

The type of VRN.

virtual_reference_numberstring

The VRN

Changes

  • 5f8163e29af4Revision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

  • 54f4fe726d8fRevision changes
    • breaking

      added to the request property allOf list

    • breaking

      the request property type changed from no type to string

    • breaking

      the / response's property type changed from no type to string for status

    • warning

      the request property's maxLength was set to 255

    • info

      added to the / response property allOf list for the response status