Update the Synthetic Account metadata

put

https://sandbox.newline53.com/api/v1/synthetic_accounts/{uid}

Enables changes to the Synthetic Account fields, including the Master Synthetic Account. The Master Synthetic Account remains identifiable by the master_account flag stored with the Synthetic Account record.

Path Params

uid

string

required

Newline-generated unique id resource specific to the current endpoint

Body Params

external_uid

string

length between 1 and 255

A unique identifier the Client supplies. It must be unique within the resource type. If the same value is given, no new resource will be created.

name

string

A unique name, per pool, to identify the resource

pool_uid

string

The unique id of the Synthetic Account's pool

synthetic_account_type_uid

string

A unique id referring to the Synthetic Account's type.

routing_number

string | null

The ABA routing number (if any) associated with this account. Some Synthetic Account Types require this field to be submitted along with the POST request. For example, any Synthetic Account Type from the ach_external or the wire_external category will require a routing_number. Submitting a routing_number with a Synthetic Account Type that does not require one will result in the routing number being ignored.

account_number

string | null

The account number (if any) associated with this account. Some Synthetic Account Types require this field to be submitted along with the POST request. For example, any Synthetic Account Type from the ach_external or the wire_external category will require an account_number. Submitting an account_number with a Synthetic Account Type that does not require one will result in the account number being ignored.

note

string

A reason for the Synthetic Account metadata change

ach

object

Contains ACH-specific information. Only populated if the Synthetic Account is in the ach_external category.

instant_payment

object

Contains Instant Payment-specific information. Only populated if the Synthetic Account is in the instant_payments_external category.

wire

object

Contains wire-specific information. Only populated if the Synthetic Account is in the wire_external category.

Headers

x-trace-id

string

required

A unique identifier provided for each request. Duplicate values submitted in requests within 7 days of each other will cause the request to be rejected.

Responses

200The updated Synthetic Account resource is returned

400A Synthetic Account is not updated if a required parameter is missing