Create Batch Payment Template
curl --request POST \
--url https://api.synctera.com/v2/batch_templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subtypes": [
"<string>"
],
"type": "<string>",
"max_individual_transaction_amount": 123,
"max_total_transaction_amount": 123,
"max_transaction_count": 123,
"min_individual_transaction_amount": 123,
"min_total_transaction_amount": 123,
"min_transaction_count": 123
},
"name": "International Remittance",
"rules": {
"disable_four_eyes_review": true,
"hold_time": 123,
"payment_rail": "<string>"
},
"tenant": "abcdef_ghijkl",
"description": "This template is used for international remittance",
"enabled": true,
"extra_rail_params": {}
}
'import requests
url = "https://api.synctera.com/v2/batch_templates"
payload = {
"config": {
"external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subtypes": ["<string>"],
"type": "<string>",
"max_individual_transaction_amount": 123,
"max_total_transaction_amount": 123,
"max_transaction_count": 123,
"min_individual_transaction_amount": 123,
"min_total_transaction_amount": 123,
"min_transaction_count": 123
},
"name": "International Remittance",
"rules": {
"disable_four_eyes_review": True,
"hold_time": 123,
"payment_rail": "<string>"
},
"tenant": "abcdef_ghijkl",
"description": "This template is used for international remittance",
"enabled": True,
"extra_rail_params": {}
}
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({
config: {
external_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
settlement_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
settlement_customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
subtypes: ['<string>'],
type: '<string>',
max_individual_transaction_amount: 123,
max_total_transaction_amount: 123,
max_transaction_count: 123,
min_individual_transaction_amount: 123,
min_total_transaction_amount: 123,
min_transaction_count: 123
},
name: 'International Remittance',
rules: {disable_four_eyes_review: true, hold_time: 123, payment_rail: '<string>'},
tenant: 'abcdef_ghijkl',
description: 'This template is used for international remittance',
enabled: true,
extra_rail_params: {}
})
};
fetch('https://api.synctera.com/v2/batch_templates', 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/batch_templates",
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([
'config' => [
'external_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'settlement_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'settlement_customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subtypes' => [
'<string>'
],
'type' => '<string>',
'max_individual_transaction_amount' => 123,
'max_total_transaction_amount' => 123,
'max_transaction_count' => 123,
'min_individual_transaction_amount' => 123,
'min_total_transaction_amount' => 123,
'min_transaction_count' => 123
],
'name' => 'International Remittance',
'rules' => [
'disable_four_eyes_review' => true,
'hold_time' => 123,
'payment_rail' => '<string>'
],
'tenant' => 'abcdef_ghijkl',
'description' => 'This template is used for international remittance',
'enabled' => true,
'extra_rail_params' => [
]
]),
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/batch_templates"
payload := strings.NewReader("{\n \"config\": {\n \"external_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtypes\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"max_individual_transaction_amount\": 123,\n \"max_total_transaction_amount\": 123,\n \"max_transaction_count\": 123,\n \"min_individual_transaction_amount\": 123,\n \"min_total_transaction_amount\": 123,\n \"min_transaction_count\": 123\n },\n \"name\": \"International Remittance\",\n \"rules\": {\n \"disable_four_eyes_review\": true,\n \"hold_time\": 123,\n \"payment_rail\": \"<string>\"\n },\n \"tenant\": \"abcdef_ghijkl\",\n \"description\": \"This template is used for international remittance\",\n \"enabled\": true,\n \"extra_rail_params\": {}\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/batch_templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"external_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtypes\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"max_individual_transaction_amount\": 123,\n \"max_total_transaction_amount\": 123,\n \"max_transaction_count\": 123,\n \"min_individual_transaction_amount\": 123,\n \"min_total_transaction_amount\": 123,\n \"min_transaction_count\": 123\n },\n \"name\": \"International Remittance\",\n \"rules\": {\n \"disable_four_eyes_review\": true,\n \"hold_time\": 123,\n \"payment_rail\": \"<string>\"\n },\n \"tenant\": \"abcdef_ghijkl\",\n \"description\": \"This template is used for international remittance\",\n \"enabled\": true,\n \"extra_rail_params\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/batch_templates")
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 \"config\": {\n \"external_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtypes\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"max_individual_transaction_amount\": 123,\n \"max_total_transaction_amount\": 123,\n \"max_transaction_count\": 123,\n \"min_individual_transaction_amount\": 123,\n \"min_total_transaction_amount\": 123,\n \"min_transaction_count\": 123\n },\n \"name\": \"International Remittance\",\n \"rules\": {\n \"disable_four_eyes_review\": true,\n \"hold_time\": 123,\n \"payment_rail\": \"<string>\"\n },\n \"tenant\": \"abcdef_ghijkl\",\n \"description\": \"This template is used for international remittance\",\n \"enabled\": true,\n \"extra_rail_params\": {}\n}"
response = http.request(request)
puts response.read_body{
"config": {
"external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subtypes": [
"<string>"
],
"type": "<string>",
"max_individual_transaction_amount": 123,
"max_total_transaction_amount": 123,
"max_transaction_count": 123,
"min_individual_transaction_amount": 123,
"min_total_transaction_amount": 123,
"min_transaction_count": 123
},
"name": "International Remittance",
"rules": {
"disable_four_eyes_review": true,
"hold_time": 123,
"payment_rail": "<string>"
},
"tenant": "abcdef_ghijkl",
"description": "This template is used for international remittance",
"enabled": true,
"extra_rail_params": {},
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}Batch Payments
Create Batch Payment Template
Create a Batch Payment template
POST
/
batch_templates
Create Batch Payment Template
curl --request POST \
--url https://api.synctera.com/v2/batch_templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subtypes": [
"<string>"
],
"type": "<string>",
"max_individual_transaction_amount": 123,
"max_total_transaction_amount": 123,
"max_transaction_count": 123,
"min_individual_transaction_amount": 123,
"min_total_transaction_amount": 123,
"min_transaction_count": 123
},
"name": "International Remittance",
"rules": {
"disable_four_eyes_review": true,
"hold_time": 123,
"payment_rail": "<string>"
},
"tenant": "abcdef_ghijkl",
"description": "This template is used for international remittance",
"enabled": true,
"extra_rail_params": {}
}
'import requests
url = "https://api.synctera.com/v2/batch_templates"
payload = {
"config": {
"external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subtypes": ["<string>"],
"type": "<string>",
"max_individual_transaction_amount": 123,
"max_total_transaction_amount": 123,
"max_transaction_count": 123,
"min_individual_transaction_amount": 123,
"min_total_transaction_amount": 123,
"min_transaction_count": 123
},
"name": "International Remittance",
"rules": {
"disable_four_eyes_review": True,
"hold_time": 123,
"payment_rail": "<string>"
},
"tenant": "abcdef_ghijkl",
"description": "This template is used for international remittance",
"enabled": True,
"extra_rail_params": {}
}
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({
config: {
external_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
settlement_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
settlement_customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
subtypes: ['<string>'],
type: '<string>',
max_individual_transaction_amount: 123,
max_total_transaction_amount: 123,
max_transaction_count: 123,
min_individual_transaction_amount: 123,
min_total_transaction_amount: 123,
min_transaction_count: 123
},
name: 'International Remittance',
rules: {disable_four_eyes_review: true, hold_time: 123, payment_rail: '<string>'},
tenant: 'abcdef_ghijkl',
description: 'This template is used for international remittance',
enabled: true,
extra_rail_params: {}
})
};
fetch('https://api.synctera.com/v2/batch_templates', 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/batch_templates",
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([
'config' => [
'external_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'settlement_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'settlement_customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subtypes' => [
'<string>'
],
'type' => '<string>',
'max_individual_transaction_amount' => 123,
'max_total_transaction_amount' => 123,
'max_transaction_count' => 123,
'min_individual_transaction_amount' => 123,
'min_total_transaction_amount' => 123,
'min_transaction_count' => 123
],
'name' => 'International Remittance',
'rules' => [
'disable_four_eyes_review' => true,
'hold_time' => 123,
'payment_rail' => '<string>'
],
'tenant' => 'abcdef_ghijkl',
'description' => 'This template is used for international remittance',
'enabled' => true,
'extra_rail_params' => [
]
]),
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/batch_templates"
payload := strings.NewReader("{\n \"config\": {\n \"external_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtypes\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"max_individual_transaction_amount\": 123,\n \"max_total_transaction_amount\": 123,\n \"max_transaction_count\": 123,\n \"min_individual_transaction_amount\": 123,\n \"min_total_transaction_amount\": 123,\n \"min_transaction_count\": 123\n },\n \"name\": \"International Remittance\",\n \"rules\": {\n \"disable_four_eyes_review\": true,\n \"hold_time\": 123,\n \"payment_rail\": \"<string>\"\n },\n \"tenant\": \"abcdef_ghijkl\",\n \"description\": \"This template is used for international remittance\",\n \"enabled\": true,\n \"extra_rail_params\": {}\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/batch_templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"external_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtypes\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"max_individual_transaction_amount\": 123,\n \"max_total_transaction_amount\": 123,\n \"max_transaction_count\": 123,\n \"min_individual_transaction_amount\": 123,\n \"min_total_transaction_amount\": 123,\n \"min_transaction_count\": 123\n },\n \"name\": \"International Remittance\",\n \"rules\": {\n \"disable_four_eyes_review\": true,\n \"hold_time\": 123,\n \"payment_rail\": \"<string>\"\n },\n \"tenant\": \"abcdef_ghijkl\",\n \"description\": \"This template is used for international remittance\",\n \"enabled\": true,\n \"extra_rail_params\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/batch_templates")
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 \"config\": {\n \"external_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settlement_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtypes\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"max_individual_transaction_amount\": 123,\n \"max_total_transaction_amount\": 123,\n \"max_transaction_count\": 123,\n \"min_individual_transaction_amount\": 123,\n \"min_total_transaction_amount\": 123,\n \"min_transaction_count\": 123\n },\n \"name\": \"International Remittance\",\n \"rules\": {\n \"disable_four_eyes_review\": true,\n \"hold_time\": 123,\n \"payment_rail\": \"<string>\"\n },\n \"tenant\": \"abcdef_ghijkl\",\n \"description\": \"This template is used for international remittance\",\n \"enabled\": true,\n \"extra_rail_params\": {}\n}"
response = http.request(request)
puts response.read_body{
"config": {
"external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subtypes": [
"<string>"
],
"type": "<string>",
"max_individual_transaction_amount": 123,
"max_total_transaction_amount": 123,
"max_transaction_count": 123,
"min_individual_transaction_amount": 123,
"min_total_transaction_amount": 123,
"min_transaction_count": 123
},
"name": "International Remittance",
"rules": {
"disable_four_eyes_review": true,
"hold_time": 123,
"payment_rail": "<string>"
},
"tenant": "abcdef_ghijkl",
"description": "This template is used for international remittance",
"enabled": true,
"extra_rail_params": {},
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Attributes of the Batch Payment template
A Batch Payment Template is a template that is used when creating a batch transfer.
The config of a Batch Payment Template. This is used the match the Batch Payment Template to a batch transfer.
Show child attributes
Show child attributes
Example:
"International Remittance"
The rules of a Batch Payment Template. This is used when processing a batch transfer.
Show child attributes
Show child attributes
The id of the tenant containing the resource.
Example:
"abcdef_ghijkl"
Example:
"This template is used for international remittance"
Whether or not the template is enabled. If the template is not enabled, it will not be used when creating a batch transfer.
Additional parameters to be passed through to the payment rail.
Response
Successful creation of a Batch Payment template
A Batch Payment Template is a template that is used when creating a batch transfer.
The config of a Batch Payment Template. This is used the match the Batch Payment Template to a batch transfer.
Show child attributes
Show child attributes
Example:
"International Remittance"
The rules of a Batch Payment Template. This is used when processing a batch transfer.
Show child attributes
Show child attributes
The id of the tenant containing the resource.
Example:
"abcdef_ghijkl"
Example:
"This template is used for international remittance"
Whether or not the template is enabled. If the template is not enabled, it will not be used when creating a batch transfer.
Additional parameters to be passed through to the payment rail.
Example:
"d290f1ee-6c54-4b01-90e6-d701748f0851"
Was this page helpful?
⌘I