Get Batch Payment Template
curl --request GET \
--url https://api.synctera.com/v2/batch_templates/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.synctera.com/v2/batch_templates/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.synctera.com/v2/batch_templates/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.synctera.com/v2/batch_templates/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.synctera.com/v2/batch_templates/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/batch_templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
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,
"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"
}Batch Payments
Get Batch Payment Template
Get a Batch Payment template
GET
/
batch_templates
/
{id}
Get Batch Payment Template
curl --request GET \
--url https://api.synctera.com/v2/batch_templates/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.synctera.com/v2/batch_templates/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.synctera.com/v2/batch_templates/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.synctera.com/v2/batch_templates/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.synctera.com/v2/batch_templates/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/batch_templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
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,
"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.
Path Parameters
The unique resource identifier
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Response
Retrieve 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. This is relevant for Fintechs that have multiple workspaces.
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?