Create a New Synthetic Account

post

https://sandbox.newline53.com/api/v1/synthetic_accounts

Create a new Synthetic Account in the Pool with the provided specification.

External Synthetic Accounts are counterparty records that represent accounts at external financial institutions. They contain all the necessary information to execute a payment. For specifics about each payment rail's requirements, refer to our Payment Rails guides.

Body Params

See GET /synthetic_account_types for the list of available types

external_uid

string

required

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

required

A unique name, per pool, to identify the resource

pool_uid

string

required

The unique id of the Synthetic Account's pool

synthetic_account_type_uid

string

required

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.

external_processor_token

string | null

The processor token required to create certain Synthetic Account Types.

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

201A new Synthetic Account is created

409A new Synthetic Account is NOT created if the external_uid given is present but not unique