Send a wire
curl --request POST \
--url https://api.synctera.com/v2/wires \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 10000,
"currency": "USD",
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"recipient_message": "<string>",
"bank_message": "<string>",
"metadata": {}
}
'import requests
url = "https://api.synctera.com/v2/wires"
payload = {
"amount": 10000,
"currency": "USD",
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"recipient_message": "<string>",
"bank_message": "<string>",
"metadata": {}
}
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({
amount: 10000,
currency: 'USD',
customer_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
originating_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
receiving_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
recipient_message: '<string>',
bank_message: '<string>',
metadata: {}
})
};
fetch('https://api.synctera.com/v2/wires', 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.synctera.com/v2/wires",
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([
'amount' => 10000,
'currency' => 'USD',
'customer_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'originating_account_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'receiving_account_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'recipient_message' => '<string>',
'bank_message' => '<string>',
'metadata' => [
]
]),
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.synctera.com/v2/wires"
payload := strings.NewReader("{\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"recipient_message\": \"<string>\",\n \"bank_message\": \"<string>\",\n \"metadata\": {}\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.synctera.com/v2/wires")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"recipient_message\": \"<string>\",\n \"bank_message\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/wires")
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 \"amount\": 10000,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"recipient_message\": \"<string>\",\n \"bank_message\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"amount": 10000,
"creation_time": "2010-05-06T12:23:34.321Z",
"currency": "USD",
"effective_date": "2022-03-18",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_bulk": true,
"last_updated_time": "2010-05-06T12:23:34.321Z",
"originating_account_number": 1961234745,
"receiving_account_number": 1961234745,
"sender_reference_id": "9F564A6124E65",
"status": "PENDING",
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_message": "<string>",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"case_id": 53,
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"fed_input_message_accountability_data": "10220318BANK0001123456",
"input_message_accountability_data": "10220318BANK0001123456",
"network": "fedwire",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"recipient_message": "<string>",
"return_data": {
"previous_message_id": "<string>",
"original_end_to_end_identification": "<string>",
"original_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"original_instruction_identification": "<string>",
"original_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"original_transaction_identification": "<string>",
"original_uetr": "<string>",
"reason": "<string>",
"reason_code": "NARR"
},
"sanction_screening_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_date": "2022-03-18",
"status_details": "PENDING_DUAL_APPROVAL",
"transaction_in_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96"
}{
"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"
}{
"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"
}Wires
Send a wire
Create an outgoing wire transfer
POST
/
wires
Send a wire
curl --request POST \
--url https://api.synctera.com/v2/wires \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 10000,
"currency": "USD",
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"recipient_message": "<string>",
"bank_message": "<string>",
"metadata": {}
}
'import requests
url = "https://api.synctera.com/v2/wires"
payload = {
"amount": 10000,
"currency": "USD",
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"recipient_message": "<string>",
"bank_message": "<string>",
"metadata": {}
}
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({
amount: 10000,
currency: 'USD',
customer_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
originating_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
receiving_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
recipient_message: '<string>',
bank_message: '<string>',
metadata: {}
})
};
fetch('https://api.synctera.com/v2/wires', 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.synctera.com/v2/wires",
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([
'amount' => 10000,
'currency' => 'USD',
'customer_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'originating_account_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'receiving_account_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'recipient_message' => '<string>',
'bank_message' => '<string>',
'metadata' => [
]
]),
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.synctera.com/v2/wires"
payload := strings.NewReader("{\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"recipient_message\": \"<string>\",\n \"bank_message\": \"<string>\",\n \"metadata\": {}\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.synctera.com/v2/wires")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"recipient_message\": \"<string>\",\n \"bank_message\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/wires")
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 \"amount\": 10000,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"recipient_message\": \"<string>\",\n \"bank_message\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"amount": 10000,
"creation_time": "2010-05-06T12:23:34.321Z",
"currency": "USD",
"effective_date": "2022-03-18",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_bulk": true,
"last_updated_time": "2010-05-06T12:23:34.321Z",
"originating_account_number": 1961234745,
"receiving_account_number": 1961234745,
"sender_reference_id": "9F564A6124E65",
"status": "PENDING",
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_message": "<string>",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"case_id": 53,
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"fed_input_message_accountability_data": "10220318BANK0001123456",
"input_message_accountability_data": "10220318BANK0001123456",
"network": "fedwire",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"recipient_message": "<string>",
"return_data": {
"previous_message_id": "<string>",
"original_end_to_end_identification": "<string>",
"original_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"original_instruction_identification": "<string>",
"original_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"original_transaction_identification": "<string>",
"original_uetr": "<string>",
"reason": "<string>",
"reason_code": "NARR"
},
"sanction_screening_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_date": "2022-03-18",
"status_details": "PENDING_DUAL_APPROVAL",
"transaction_in_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96"
}{
"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"
}{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Body
application/json
Wire transfer request
Transfer amount in cents ($100 would be 10000)
Required range:
x >= 1Example:
10000
3-character currency code
Available options:
USD Example:
"USD"
The customer UUID representing the person initiating the Wire transfer
Example:
"b01db9c7-78f2-4a99-8aca-1231d32f9b96"
Sender account ID
Example:
"b01db9c7-78f2-4a99-8aca-1231d32f9b96"
The external account uuid representing the recipient of the wire.
Example:
"b01db9c7-78f2-4a99-8aca-1231d32f9b96"
Information from the originator to the beneficiary (recipient).
Maximum string length:
140Instructions intended for the financial institutions that are processing the wire.
Maximum string length:
210Additional transfer metadata structured as key-value pairs
Response
Created wire
Transfer amount in cents ($100 would be 10000)
Example:
10000
Example:
"2010-05-06T12:23:34.321Z"
3-character currency code
Example:
"USD"
The effective date of the transaction once it gets posted
Example:
"2022-03-18"
wire ID
Whether or not the wire is a "bulk" wire created via the batch payment API.
Example:
"2010-05-06T12:23:34.321Z"
The account number representing the sender account. If the outgoing wire is a return, it refers to the sender of the initial wire not the sender of the return.
Example:
1961234745
The account number representing the recipient account. If the outgoing wire is a return, it refers to the recipient of the initial wire not the destination of the return.
Example:
1961234745
Sender's id associated with fedwire transfer
Example:
"9F564A6124E65"
The current status of the transfer
Available options:
CANCELED, COMPLETED, DECLINED, PENDING Example:
"PENDING"
ID of the resulting transaction resource
Instructions intended for the financial institutions that are processing the wire.
The batch ID associated with the wire if it was created via the batch payment API.
The case id associated with the wire.
Example:
53
The customer UUID representing the person initiating the Wire transfer
Example:
"b01db9c7-78f2-4a99-8aca-1231d32f9b96"
The Synctera-generated IMAD can be overwritten when the wire is uploaded to the FED. If that happens and we are provided with the new IMAD, it will be populated in this field.
Example:
"10220318BANK0001123456"
The input message accountability data consists of a 8 character cycle date (CCYYMMDD) an 8 character source and a 6 character sequence number.
Example:
"10220318BANK0001123456"
The network used to process the wire
Example:
"fedwire"
Sender account ID
Example:
"b01db9c7-78f2-4a99-8aca-1231d32f9b96"
The external account uuid representing the recipient of the wire.
Example:
"b01db9c7-78f2-4a99-8aca-1231d32f9b96"
Information from the originator to the beneficiary (recipient).
Data associated with a returned wire
Show child attributes
Show child attributes
The settlement date of the transaction once it gets posted
Example:
"2022-03-18"
Additional details about the status of the transfer
Available options:
APPROVED, CANCELED, DECLINED_COMPLIANCE_REVIEW, DECLINED_DUAL_APPROVAL, DECLINED_FRAUD, PENDING_COMPLIANCE_REVIEW, PENDING_DUAL_APPROVAL Example:
"PENDING_DUAL_APPROVAL"
The transaction uuid of the incoming wire that triggered an outgoing return. This is only used if the outgoing wire is a return.
Example:
"b01db9c7-78f2-4a99-8aca-1231d32f9b96"
Was this page helpful?