Virtual Reference Numbers

List Virtual Reference Numbers

Changed on

Retrieves a list of Virtual Reference Numbers (VRNs) associated with the specified Synthetic Account. Supports filtering by status and other attributes.

get/virtual_reference_numbers

Request

Query parameters

instant_payment_rail_registration_status'failed' | 'pending' | 'registered' | 'unregistered'

Registration status with Newline and Fifth Third, for RTP network acceptance.

Example:registered
status'active' | 'archived'

A value indicating the overall state of this VRN.

Example:active
synthetic_account_uidstring

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

Example:Dg1EPao8XukUpHG8
virtual_reference_numberstring

The VRN

Example:1234567890123456

Changes

    • info

      added the optional property /////// to the response with the status

    • breaking

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

    • info

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

    • info

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

    • info

      removed from the // response property allOf list for the response status