curl --request POST \
--url https://api-sandbox.synctera.com/v0/eft_ca \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 10000,
"customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
"dc_sign": "DEBIT",
"transaction_code": 304,
"destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
"destination_account_owner_name": "Jane Joe",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"originating_account_owner_name": "John Doe",
"source_data": {},
"effective_date": "2022-03-18",
"is_same_day": true
}
'import requests
url = "https://api-sandbox.synctera.com/v0/eft_ca"
payload = {
"amount": 10000,
"customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
"dc_sign": "DEBIT",
"transaction_code": 304,
"destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
"destination_account_owner_name": "Jane Joe",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"originating_account_owner_name": "John Doe",
"source_data": {},
"effective_date": "2022-03-18",
"is_same_day": True
}
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,
customer_id: '46fec39e-e776-4571-bf90-d0e1d15172fe',
dc_sign: 'DEBIT',
transaction_code: 304,
destination_account_id: 'fccb4a46-1261-4e91-b622-73b5b946183d',
destination_account_owner_name: 'Jane Joe',
originating_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
originating_account_owner_name: 'John Doe',
source_data: {},
effective_date: '2022-03-18',
is_same_day: true
})
};
fetch('https://api-sandbox.synctera.com/v0/eft_ca', 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/eft_ca",
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,
'customer_id' => '46fec39e-e776-4571-bf90-d0e1d15172fe',
'dc_sign' => 'DEBIT',
'transaction_code' => 304,
'destination_account_id' => 'fccb4a46-1261-4e91-b622-73b5b946183d',
'destination_account_owner_name' => 'Jane Joe',
'originating_account_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'originating_account_owner_name' => 'John Doe',
'source_data' => [
],
'effective_date' => '2022-03-18',
'is_same_day' => true
]),
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/eft_ca"
payload := strings.NewReader("{\n \"amount\": 10000,\n \"customer_id\": \"46fec39e-e776-4571-bf90-d0e1d15172fe\",\n \"dc_sign\": \"DEBIT\",\n \"transaction_code\": 304,\n \"destination_account_id\": \"fccb4a46-1261-4e91-b622-73b5b946183d\",\n \"destination_account_owner_name\": \"Jane Joe\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_owner_name\": \"John Doe\",\n \"source_data\": {},\n \"effective_date\": \"2022-03-18\",\n \"is_same_day\": true\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/eft_ca")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 10000,\n \"customer_id\": \"46fec39e-e776-4571-bf90-d0e1d15172fe\",\n \"dc_sign\": \"DEBIT\",\n \"transaction_code\": 304,\n \"destination_account_id\": \"fccb4a46-1261-4e91-b622-73b5b946183d\",\n \"destination_account_owner_name\": \"Jane Joe\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_owner_name\": \"John Doe\",\n \"source_data\": {},\n \"effective_date\": \"2022-03-18\",\n \"is_same_day\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/eft_ca")
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 \"customer_id\": \"46fec39e-e776-4571-bf90-d0e1d15172fe\",\n \"dc_sign\": \"DEBIT\",\n \"transaction_code\": 304,\n \"destination_account_id\": \"fccb4a46-1261-4e91-b622-73b5b946183d\",\n \"destination_account_owner_name\": \"Jane Joe\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_owner_name\": \"John Doe\",\n \"source_data\": {},\n \"effective_date\": \"2022-03-18\",\n \"is_same_day\": true\n}"
response = http.request(request)
puts response.read_body{
"amount": 10000,
"customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
"dc_sign": "DEBIT",
"transaction_code": 304,
"destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
"destination_account_number": 1344012344,
"destination_account_owner_name": "<string>",
"effective_date": "2022-03-18",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_same_day": true,
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"originating_account_number": 1961234745,
"originating_account_owner_name": "<string>",
"reference_id": 123456789,
"status": "POSTED",
"subtype": "INCOMING_CREDIT",
"tenant_id": "abcdef_ghijkl",
"source_data": {},
"failed": false,
"history": [
{
"data": {},
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"network_status": "PENDING",
"posting_date": "2022-03-18",
"transaction_id": "45b5246f-ad97-4629-9aac-465b74a05505"
}{
"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"
}Create EFT Canada Transfer
Create a new EFT Canada transfer
🚧 Beta > This is a Beta endpoint. Feedback from the community is welcome. We may make breaking changes.
curl --request POST \
--url https://api-sandbox.synctera.com/v0/eft_ca \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 10000,
"customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
"dc_sign": "DEBIT",
"transaction_code": 304,
"destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
"destination_account_owner_name": "Jane Joe",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"originating_account_owner_name": "John Doe",
"source_data": {},
"effective_date": "2022-03-18",
"is_same_day": true
}
'import requests
url = "https://api-sandbox.synctera.com/v0/eft_ca"
payload = {
"amount": 10000,
"customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
"dc_sign": "DEBIT",
"transaction_code": 304,
"destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
"destination_account_owner_name": "Jane Joe",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"originating_account_owner_name": "John Doe",
"source_data": {},
"effective_date": "2022-03-18",
"is_same_day": True
}
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,
customer_id: '46fec39e-e776-4571-bf90-d0e1d15172fe',
dc_sign: 'DEBIT',
transaction_code: 304,
destination_account_id: 'fccb4a46-1261-4e91-b622-73b5b946183d',
destination_account_owner_name: 'Jane Joe',
originating_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
originating_account_owner_name: 'John Doe',
source_data: {},
effective_date: '2022-03-18',
is_same_day: true
})
};
fetch('https://api-sandbox.synctera.com/v0/eft_ca', 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/eft_ca",
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,
'customer_id' => '46fec39e-e776-4571-bf90-d0e1d15172fe',
'dc_sign' => 'DEBIT',
'transaction_code' => 304,
'destination_account_id' => 'fccb4a46-1261-4e91-b622-73b5b946183d',
'destination_account_owner_name' => 'Jane Joe',
'originating_account_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'originating_account_owner_name' => 'John Doe',
'source_data' => [
],
'effective_date' => '2022-03-18',
'is_same_day' => true
]),
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/eft_ca"
payload := strings.NewReader("{\n \"amount\": 10000,\n \"customer_id\": \"46fec39e-e776-4571-bf90-d0e1d15172fe\",\n \"dc_sign\": \"DEBIT\",\n \"transaction_code\": 304,\n \"destination_account_id\": \"fccb4a46-1261-4e91-b622-73b5b946183d\",\n \"destination_account_owner_name\": \"Jane Joe\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_owner_name\": \"John Doe\",\n \"source_data\": {},\n \"effective_date\": \"2022-03-18\",\n \"is_same_day\": true\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/eft_ca")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 10000,\n \"customer_id\": \"46fec39e-e776-4571-bf90-d0e1d15172fe\",\n \"dc_sign\": \"DEBIT\",\n \"transaction_code\": 304,\n \"destination_account_id\": \"fccb4a46-1261-4e91-b622-73b5b946183d\",\n \"destination_account_owner_name\": \"Jane Joe\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_owner_name\": \"John Doe\",\n \"source_data\": {},\n \"effective_date\": \"2022-03-18\",\n \"is_same_day\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/eft_ca")
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 \"customer_id\": \"46fec39e-e776-4571-bf90-d0e1d15172fe\",\n \"dc_sign\": \"DEBIT\",\n \"transaction_code\": 304,\n \"destination_account_id\": \"fccb4a46-1261-4e91-b622-73b5b946183d\",\n \"destination_account_owner_name\": \"Jane Joe\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"originating_account_owner_name\": \"John Doe\",\n \"source_data\": {},\n \"effective_date\": \"2022-03-18\",\n \"is_same_day\": true\n}"
response = http.request(request)
puts response.read_body{
"amount": 10000,
"customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
"dc_sign": "DEBIT",
"transaction_code": 304,
"destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
"destination_account_number": 1344012344,
"destination_account_owner_name": "<string>",
"effective_date": "2022-03-18",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_same_day": true,
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"originating_account_number": 1961234745,
"originating_account_owner_name": "<string>",
"reference_id": 123456789,
"status": "POSTED",
"subtype": "INCOMING_CREDIT",
"tenant_id": "abcdef_ghijkl",
"source_data": {},
"failed": false,
"history": [
{
"data": {},
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"network_status": "PENDING",
"posting_date": "2022-03-18",
"transaction_id": "45b5246f-ad97-4629-9aac-465b74a05505"
}{
"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.
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Body
The EFT Canada transfer to be created.
Properties for creating a transfer
Transfer amount in cents
x >= 110000
The UUID of the Synctera customer resource that is the originator of the transfer.
"46fec39e-e776-4571-bf90-d0e1d15172fe"
Debit or credit sign
CREDIT, DEBIT "DEBIT"
The three digit transaction code that identifies the type of transaction. More information can be found here: https://www.payments.ca/sites/default/files/standard007eng.pdf.
304
The UUID of the Synctera external account resource that is the destination of the transfer. This external account represents the account on the destination bank's platform.
"fccb4a46-1261-4e91-b622-73b5b946183d"
The official name of the account owner of the destination account.
"Jane Joe"
The UUID of the Synctera account resource originating the transfer.
"b01db9c7-78f2-4a99-8aca-1231d32f9b96"
The official name of the account owner of the originating account. This must exactly match one of the account_owner_names in the destination external account.
"John Doe"
Additional information to be added to the transfer
The effective date of the transaction once it gets posted
"2022-03-18"
Send the same day (use only is_same_day without specific effective_date).
true
Response
Successful creation of an EFT Canada transfer
EFT transfer specific to Canada
Transfer amount in cents
x >= 110000
The UUID of the Synctera customer resource that is the originator of the transfer.
"46fec39e-e776-4571-bf90-d0e1d15172fe"
Debit or credit sign
CREDIT, DEBIT "DEBIT"
The three digit transaction code that identifies the type of transaction. More information can be found here: https://www.payments.ca/sites/default/files/standard007eng.pdf.
304
The UUID of the Synctera account that is the destination of the transfer. For a transfer originated by the Synctera platform, this will be an external account resource, while for a transfer originated by the external account, this account will be an account resource.
"fccb4a46-1261-4e91-b622-73b5b946183d"
The account number of the destination account.
1344012344
The account owner name of the destination account.
The effective date of the transaction once it gets posted
"2022-03-18"
ID of the transfer
Send the same day (use only is_same_day without specific effective_date).
true
The UUID of the Synctera account that is the origination of the transfer. For a transfer originated by the Synctera platform, this will be an account resource, while for a transfer originated by the external account, this will be an external account resource.
"b01db9c7-78f2-4a99-8aca-1231d32f9b96"
The account number of the originating account.
1961234745
The account owner name of the origination account.
The reference id of the transfer.
123456789
The status of the transfer in the Synctera platform. This is automatically set upon the creation of a transfer. To cancel a transfer, the current status must be 'INITIATED' or 'PENDING' and the request status set to 'CANCELLED'. To trigger a return, the current status must be 'POSTED' and the returned status will be set to 'RETURNED' if successful.
CANCELLED, EXPIRED, INITIATED, IN_SUSPENSE, PENDING, POSTED "POSTED"
The subtype of the transfer
BULK_OUTGOING_CREDIT, BULK_OUTGOING_CREDIT_RETURN, BULK_OUTGOING_CREDIT_RETURN_REVERSAL, BULK_OUTGOING_CREDIT_REVERSAL, BULK_OUTGOING_DEBIT, BULK_OUTGOING_DEBIT_RETURN, BULK_OUTGOING_DEBIT_RETURN_REVERSAL, BULK_OUTGOING_DEBIT_REVERSAL, INCOMING_CREDIT, INCOMING_CREDIT_RETURN, INCOMING_CREDIT_RETURN_REVERSAL, INCOMING_CREDIT_REVERSAL, INCOMING_DEBIT, INCOMING_DEBIT_RETURN, INCOMING_DEBIT_RETURN_REVERSAL, INCOMING_DEBIT_REVERSAL, OUTGOING_CREDIT, OUTGOING_CREDIT_RETURN, OUTGOING_CREDIT_RETURN_REVERSAL, OUTGOING_CREDIT_REVERSAL, OUTGOING_DEBIT, OUTGOING_DEBIT_RETURN, OUTGOING_DEBIT_RETURN_REVERSAL, OUTGOING_DEBIT_REVERSAL "INCOMING_CREDIT"
The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
"abcdef_ghijkl"
Additional information to be added to the transfer
Whether the transfer failed or not.
false
Show child attributes
Show child attributes
The network status of the transfer.
PENDING, POSTED, RETURNED, REVERSED "PENDING"
The posting date of the transaction once it gets posted
"2022-03-18"
The related transaction id of the transfer.
"45b5246f-ad97-4629-9aac-465b74a05505"
Was this page helpful?