API Reference
Learn More about Newline

Simulate a Transaction

post
https://sandbox.newline53.com/api/v1/sandbox/mock_transactions

Note This endpoint is only available in Sandbox.

Create a Transaction by simulating the attributes that would be expected from reading an actual transaction received from a third party system. The simulated Transaction will appear in the respective Transaction list after it is successfully processed.

Transactions can be simulated against either a Synthetic Account, or a VRN that is created and mapped to a Synthetic Account.

Body Params
string

The uid of the customer for which to create the Transaction. Required except when transaction_type is ach_return.

string
enum
required
Allowed:
string

The Transaction UID value is required when the simulated transaction type is "ach_return". This is the transaction that newline will simulate the return for. The transaction supplied must be of type 'ACH'.

number

Positive value interpreted as a credit; negative value interpreted as a debit. Required for transaction_type of wire, instant_payment, and ach; ignored when transaction_type is ach_return.

string
length ≥ 8

Additional information about this Mock Transaction; used as the Transaction description. When provided, a minimum of 8 characters is required.

string

Optionally specifies the general Synthetic Account to be used for creating the transaction. If not passed, a random Synthetic Account belonging to the Customer will be used.

string

Optional. If a VRN UID is supplied the simulated transaction will be associated with that VRN. The VRN UID must be in an active status. Only the following simulated transactions can have an associated VRN: wire credits, ACHs, or instant_payment.

string
enum

Optional. You may specify the network on which to simulate the transaction. If not specified, the default network "tch" will be used. Applicable for transaction_type of instant_payment.

Allowed:
counterparty_address

Address of the business or individual who owns the external account. Applicable for transaction_type of wire or instant_payment.

string
length ≤ 35

Name of the business or individual who owns the external account. Maximum 35 characters. Applicable for transaction_type of wire or instant_payment.

counterparty_bank_address
object

Address of the financial institution where the external account is held. Applicable for transaction_type of wire.

string
length ≤ 35

Name of the financial institution where the counterparty account is held. Maximum 35 characters. Applicable for transaction_type of wire.

string
length between 1 and 10

Description of the transaction. Applicable for transaction_type of ach.

intermediary_bank_address
object

Address of the intermediary bank, when applicable. Applicable for transaction_type of wire.

string
length ≤ 35

Name of the intermediary bank, when applicable. Maximum 35 characters. Applicable for transaction_type of wire.

string
length between 9 and 9

The routing number associated with the intermediary bank involved in the wire transfer. Applicable for transaction_type of wire.

string | null

A message transmitted to the recipient bank. Can contain letters and numbers as well as '-', '_', and spaces.

string
length ≤ 140

Additional details or instructions for the wire, issued to the recipient financial institution when the wire is executed.

string
length ≤ 80

Optional additional payment-related information, such as invoice numbers, originator/receiver information, payment instructions, etc. Up to 80 characters. Optional for all newline supported SEC codes other than TEL. Newline will reject the Transfer if an Addenda value is provided with SEC code TEL.

string
enum

Standard Entry Class (SEC) code. Newline supports the following SEC codes: CCD, CIE, PPD, TEL, WEB. For more details, refer to our ACH guide's section on SEC code use.

Allowed:
string | null

Optional. If the iat param is supplied on a mocked RDFI or ODFI ACH transaction, the transaction will have IAT details mocked accordingly.

string | null

CHIPS number of the wire recipient. At most one of chips, imad, or uetr should be present.

string | null

FedWire IMAD number identifying a wire transaction. At most one of chips, imad, or uetr should be present.

string | null

Unique End to end Transaction Reference value from SWIFT for a wire transaction. At most one of chips, imad, or uetr should be present.

Headers
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

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 8 months ago