Update Batch Payment Template

curl --request PATCH \
  --url https://api.synctera.com/v2/batch_templates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "This template is used for international remittance",
  "enabled": true,
  "extra_rail_params": {},
  "name": "International Remittance",
  "rules": {
    "disable_four_eyes_review": true,
    "hold_time": 123,
    "payment_rail": "<string>"
  }
}
'

import requests

url = "https://api.synctera.com/v2/batch_templates/{id}"

payload = {
    "description": "This template is used for international remittance",
    "enabled": True,
    "extra_rail_params": {},
    "name": "International Remittance",
    "rules": {
        "disable_four_eyes_review": True,
        "hold_time": 123,
        "payment_rail": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'This template is used for international remittance',
    enabled: true,
    extra_rail_params: {},
    name: 'International Remittance',
    rules: {disable_four_eyes_review: true, hold_time: 123, payment_rail: '<string>'}
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'This template is used for international remittance',
    'enabled' => true,
    'extra_rail_params' => [
        
    ],
    'name' => 'International Remittance',
    'rules' => [
        'disable_four_eyes_review' => true,
        'hold_time' => 123,
        'payment_rail' => '<string>'
    ]
  ]),
  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/{id}"

	payload := strings.NewReader("{\n  \"description\": \"This template is used for international remittance\",\n  \"enabled\": true,\n  \"extra_rail_params\": {},\n  \"name\": \"International Remittance\",\n  \"rules\": {\n    \"disable_four_eyes_review\": true,\n    \"hold_time\": 123,\n    \"payment_rail\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.synctera.com/v2/batch_templates/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"This template is used for international remittance\",\n  \"enabled\": true,\n  \"extra_rail_params\": {},\n  \"name\": \"International Remittance\",\n  \"rules\": {\n    \"disable_four_eyes_review\": true,\n    \"hold_time\": 123,\n    \"payment_rail\": \"<string>\"\n  }\n}")
  .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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"This template is used for international remittance\",\n  \"enabled\": true,\n  \"extra_rail_params\": {},\n  \"name\": \"International Remittance\",\n  \"rules\": {\n    \"disable_four_eyes_review\": true,\n    \"hold_time\": 123,\n    \"payment_rail\": \"<string>\"\n  }\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,
  "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"
}

PATCH

batch_templates

{id}

Update Batch Payment Template

curl --request PATCH \
  --url https://api.synctera.com/v2/batch_templates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "This template is used for international remittance",
  "enabled": true,
  "extra_rail_params": {},
  "name": "International Remittance",
  "rules": {
    "disable_four_eyes_review": true,
    "hold_time": 123,
    "payment_rail": "<string>"
  }
}
'

import requests

url = "https://api.synctera.com/v2/batch_templates/{id}"

payload = {
    "description": "This template is used for international remittance",
    "enabled": True,
    "extra_rail_params": {},
    "name": "International Remittance",
    "rules": {
        "disable_four_eyes_review": True,
        "hold_time": 123,
        "payment_rail": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'This template is used for international remittance',
    enabled: true,
    extra_rail_params: {},
    name: 'International Remittance',
    rules: {disable_four_eyes_review: true, hold_time: 123, payment_rail: '<string>'}
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'This template is used for international remittance',
    'enabled' => true,
    'extra_rail_params' => [
        
    ],
    'name' => 'International Remittance',
    'rules' => [
        'disable_four_eyes_review' => true,
        'hold_time' => 123,
        'payment_rail' => '<string>'
    ]
  ]),
  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/{id}"

	payload := strings.NewReader("{\n  \"description\": \"This template is used for international remittance\",\n  \"enabled\": true,\n  \"extra_rail_params\": {},\n  \"name\": \"International Remittance\",\n  \"rules\": {\n    \"disable_four_eyes_review\": true,\n    \"hold_time\": 123,\n    \"payment_rail\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.synctera.com/v2/batch_templates/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"This template is used for international remittance\",\n  \"enabled\": true,\n  \"extra_rail_params\": {},\n  \"name\": \"International Remittance\",\n  \"rules\": {\n    \"disable_four_eyes_review\": true,\n    \"hold_time\": 123,\n    \"payment_rail\": \"<string>\"\n  }\n}")
  .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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"This template is used for international remittance\",\n  \"enabled\": true,\n  \"extra_rail_params\": {},\n  \"name\": \"International Remittance\",\n  \"rules\": {\n    \"disable_four_eyes_review\": true,\n    \"hold_time\": 123,\n    \"payment_rail\": \"<string>\"\n  }\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,
  "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

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

The unique resource identifier

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Attributes of the Batch Payment template

A Batch Payment Template is a template that is used when creating a batch transfer.

config

Batch Payment Template Config · object

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

Show child attributes

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.

name

string

Example:

"International Remittance"

rules

Batch Payment Template Rules · object

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

Show child attributes

Response

Successful update of a Batch Payment template

A Batch Payment Template is a template that is used when creating a batch transfer.

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. This is relevant for Fintechs that have multiple workspaces.

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

Update Batch Payment Template

Authorizations

Path Parameters

Body

Response