Initiate a Transfer

post

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

Attempt to initiate a Transfer between two Synthetic Accounts. Before the Transfer will be initiated, several checks will be performed to ensure there is sufficient balance in the source account and that the initiating Customer has all the necessary access to both Synthetic Accounts.

The Synthetic Accounts allowed in a Transfer request are listed below

between a liability Synthetic Account in the general category and a Synthetic Account in the ach_external, wire_external, or instant_payments_external category
between two liability Synthetic Accounts in the general category that are also owned by the same Customer.

Note Please note that if utilizing the Transmitter information, the initiator type should be set to transmitter. If not set, the field defaults to customer and any data provided in that field will be ignored.

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.

source_synthetic_account_uid

string

required

Synthetic Account where the assets should be debited. Must be an active liability or external-type account. Cannot be equal to destination_synthetic_account_uid.

destination_synthetic_account_uid

string

required

Synthetic Account where the assets should be credited. Must be an active liability or external-type account. Cannot be equal to source_synthetic_account_uid.

initiating_customer_uid

string

required

Customer that initiated the Transfer, when initiator_type is customer. The Customer and Synthetic Accounts supplied in the Transfer request must relate to the same Pool for the Transfer to be accepted.

destination_customer_uid

string

Customer who is on the receiving end of the Transfer. The destination Customer must be provided for peer to peer Transfers and can be optional for all other Transfers. If not provided, the destination Customer will be the same as the initiating Customer by default.

initiator_type

string

enum

The initiator_type declares the originator for the Transfer. If set to Customer, origination information is pulled from the supplied initiating_customer_uid. If set to Transmitter, origination information is required, provided in the transmitter object (see below). Defaults to Customer. Providing Transmitter information is the Client's responsibility, please review more details in our Transfers guide.

Allowed:

usd_transfer_amount

string

required

The USD amount to transfer

ach

object

ACH information. Only present if the Transfer is an ACH.

instant_payment

object

Instant payment information. Only present if the Transfer is an instant payment.

wire

object

Wire-specific information. Only present if the Transfer is a wire.

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.

Response

201A new Transfer is initiated