Skip to main content
POST
/
wires
/
transaction_simulations
/
receiving_transaction
Simulate receiving Wire transaction
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/wires/transaction_simulations/receiving_transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_number": "123638791329",
  "amount": 607,
  "beneficiary_account_override": "",
  "network": "FEDWIRE",
  "recipient_message": "ACCT 1234567890"
}
'
import requests

url = "https://api-sandbox.synctera.com/v0/wires/transaction_simulations/receiving_transaction"

payload = {
"account_number": "123638791329",
"amount": 607,
"beneficiary_account_override": "",
"network": "FEDWIRE",
"recipient_message": "ACCT 1234567890"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account_number: '123638791329',
amount: 607,
beneficiary_account_override: '',
network: 'FEDWIRE',
recipient_message: 'ACCT 1234567890'
})
};

fetch('https://api-sandbox.synctera.com/v0/wires/transaction_simulations/receiving_transaction', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.synctera.com/v0/wires/transaction_simulations/receiving_transaction",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'account_number' => '123638791329',
'amount' => 607,
'beneficiary_account_override' => '',
'network' => 'FEDWIRE',
'recipient_message' => 'ACCT 1234567890'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api-sandbox.synctera.com/v0/wires/transaction_simulations/receiving_transaction"

payload := strings.NewReader("{\n \"account_number\": \"123638791329\",\n \"amount\": 607,\n \"beneficiary_account_override\": \"\",\n \"network\": \"FEDWIRE\",\n \"recipient_message\": \"ACCT 1234567890\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api-sandbox.synctera.com/v0/wires/transaction_simulations/receiving_transaction")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_number\": \"123638791329\",\n \"amount\": 607,\n \"beneficiary_account_override\": \"\",\n \"network\": \"FEDWIRE\",\n \"recipient_message\": \"ACCT 1234567890\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.synctera.com/v0/wires/transaction_simulations/receiving_transaction")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_number\": \"123638791329\",\n \"amount\": 607,\n \"beneficiary_account_override\": \"\",\n \"network\": \"FEDWIRE\",\n \"recipient_message\": \"ACCT 1234567890\"\n}"

response = http.request(request)
puts response.read_body
{
  "file_name": "SIMULATION.20230709T222327.086_221.txt"
}
{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}
{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}
{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}
{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Incoming Wire simulation request

Simulate receiving a Wire transaction

account_number
string
required

Number of the receiving account

Example:

"123638791329"

amount
integer
required

Amount to transfer in cents (e.g. 100 = $1).

Required range: x >= 1
Example:

607

beneficiary_account_override
string

Simulation-only knob. If present, replaces account_number as the value placed in the generated pacs.008 CdtrAcct field (use the empty string to omit CdtrAcct entirely). account_number still drives partner-prefix validation and the receiver-info lookup; this override only affects what is stamped on the wire, which is what the receiver code parses into IncomingWire.AccountNo. Used to construct the "structured account is missing/short, account digits embedded in recipient message" scenario. Not used in production wires. FEDWIRE only.

Example:

""

network
enum<string>
default:FEDWIRE

Network to use for the Wire transfer

Available options:
DATASOFT,
FEDWIRE
Example:

"FEDWIRE"

recipient_message
string

Simulation-only knob. Overrides the unstructured remittance information (ISO 20022 RmtInf/Ustrd) on the generated wire so we can exercise the recipient-message account-number extraction path. Not used in production wires. FEDWIRE only — rejected for DATASOFT since the Datasoft webhook payload has no field to carry an unstructured recipient message.

Example:

"ACCT 1234567890"

Response

Simulated receiving a Wire transaction

Incoming Wire simulation result with the created file name

file_name
string
required
Example:

"SIMULATION.20230709T222327.086_221.txt"