Sign in
latestOpenAPI 3.0.22026-08-21530310.0 KB

54f4fe726d8f

Sandbox

Simulate a Transaction

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.

post/sandbox/mock_transactions

Request body

customer_uidstring

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

transaction_type'wire' | 'instant_payment' | 'ach' | 'ach_return' required
transaction_uidstring

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'.

us_dollar_amountnumber

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.

descriptionstring

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

synthetic_account_uidstring

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.

virtual_reference_number_uidstring

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.

network'tch' | 'fednow'

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.

counterparty_namestring

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_namestring

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

entry_descriptionstring

Description of the transaction. Applicable for transaction_type of ach.

intermediary_bank_address0 — unresolved $ref
intermediary_bank_namestring

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

intermediary_bank_routing_number0 — unresolved $ref
memostring nullable

A message transmitted to the recipient bank. Supports letters, numbers, and special characters: . !@#$%^&*',/:;<=>?~`|[]{})(+=_- (max 140 characters).

wire_instructionsstring

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

addendastring

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.

sec_code'CCD' | 'CIE' | 'PPD' | 'TEL' | 'WEB'

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.

iatstring nullable

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

chipsstring nullable

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

imadstring nullable

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

uetrstring nullable

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

Response

A success message is returned

successstring
uidstring

The UID of the newly mocked Transaction.

Example response

{
  "success": "A mocked transaction has been successfully initiated.",
  "uid": "mDBBkGGG4wJzg3QV"
}