Get Batch Payment Templates

curl --request GET \
  --url https://api.synctera.com/v1/batch_templates \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v1/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/v1/batch_templates",
  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/v1/batch_templates"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v1/batch_templates")

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
}

{
  "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
}

GET

batch_templates

Get Batch Payment Templates

curl --request GET \
  --url https://api.synctera.com/v1/batch_templates \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v1/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/v1/batch_templates",
  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/v1/batch_templates"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v1/batch_templates")

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
}

{
  "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

Authorization

string

header

required

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

Query Parameters

name

string

Name of the Batch Template

Example:

"International Remittance"

enabled

boolean

Whether or not the template is enabled. If the template is not enabled, it will not be used when creating a batch transfer.

Example:

true

description

string

Description of the Batch Template

Example:

"This template is used for international remittance"

page_token

string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

string<uuid>[]

Unique resource identifier

limit

integer

default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1

Example:

100

Response

Retrieve all Batch Payment templates

config

Batch Payment Template Config · object

required

The config of a Batch Payment Template. This is used the match the Batch Payment Template to a batch transfer.

Show child attributes

name

string

required

Example:

"International Remittance"

rules

Batch Payment Template Rules · object

required

The rules of a Batch Payment Template. This is used when processing a batch transfer.

Show child attributes

tenant

string

required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

description

string

Example:

"This template is used for international remittance"

enabled

boolean

Whether or not the template is enabled. If the template is not enabled, it will not be used when creating a batch transfer.

extra_rail_params

object

Additional parameters to be passed through to the payment rail.

string<uuid>

read-only

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Get Batch Payment Templates

Authorizations

Query Parameters

Response