Update Batch Payment

curl --request PATCH \
  --url https://api.synctera.com/v1/batches/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "batched_transfer_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "tenant": "abcdef_ghijkl"
}
'

import requests

url = "https://api.synctera.com/v1/batches/{id}"

payload = {
    "batched_transfer_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "tenant": "abcdef_ghijkl"
}
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({
    batched_transfer_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    tenant: 'abcdef_ghijkl'
  })
};

fetch('https://api.synctera.com/v1/batches/{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/v1/batches/{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([
    'batched_transfer_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'tenant' => 'abcdef_ghijkl'
  ]),
  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/v1/batches/{id}"

	payload := strings.NewReader("{\n  \"batched_transfer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenant\": \"abcdef_ghijkl\"\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/v1/batches/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"batched_transfer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenant\": \"abcdef_ghijkl\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v1/batches/{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  \"batched_transfer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenant\": \"abcdef_ghijkl\"\n}"

response = http.request(request)
puts response.read_body

{
  "amount": 123,
  "batch_payment_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batched_transfer_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "status": "CANCELLED",
  "payment_rail": "<string>",
  "payment_rail_transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant": "abcdef_ghijkl",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

PATCH

batches

{id}

Update Batch Payment

curl --request PATCH \
  --url https://api.synctera.com/v1/batches/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "batched_transfer_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "tenant": "abcdef_ghijkl"
}
'

import requests

url = "https://api.synctera.com/v1/batches/{id}"

payload = {
    "batched_transfer_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "tenant": "abcdef_ghijkl"
}
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({
    batched_transfer_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    tenant: 'abcdef_ghijkl'
  })
};

fetch('https://api.synctera.com/v1/batches/{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/v1/batches/{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([
    'batched_transfer_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'tenant' => 'abcdef_ghijkl'
  ]),
  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/v1/batches/{id}"

	payload := strings.NewReader("{\n  \"batched_transfer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenant\": \"abcdef_ghijkl\"\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/v1/batches/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"batched_transfer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenant\": \"abcdef_ghijkl\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v1/batches/{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  \"batched_transfer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenant\": \"abcdef_ghijkl\"\n}"

response = http.request(request)
puts response.read_body

{
  "amount": 123,
  "batch_payment_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batched_transfer_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "status": "CANCELLED",
  "payment_rail": "<string>",
  "payment_rail_transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant": "abcdef_ghijkl",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Body

application/json

Attributes of the Batch Payment for udpate

batched_transfer_ids

string<uuid>[]

The IDs of the transfers that are part of the batch. These values can be modified by the client before the batch is in a terminal status.

status

enum<string>

The status of a Batch

Available options:

CANCELLED,

COMPLETED,

DECLINED,

INITIATED,

PENDING_APPROVAL,

PENDING_PAYMENT,

RETURNED

tenant

string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

Response

Successful update of a Batch Payment

A Batch Payment is a collection of transfers that are processed together. These transfers represent a new transfer on the ledger.

amount

integer<int64>

required

read-only

The total amount of the batch transfer.

batch_payment_template_id

string<uuid>

required

The ID of the batch Payment template that was used to create the batch.

batched_transfer_ids

string<uuid>[]

required

The IDs of the transfers that are part of the batch. These values can be modified by the client before the batch is in a terminal status.

creation_time

string<date-time>

required

read-only

Example:

"2010-05-06T12:23:34.321Z"

string<uuid>

required

read-only

Example:

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

last_updated_time

string<date-time>

required

read-only

Example:

"2010-05-06T12:23:34.321Z"

status

enum<string>

required

The status of a Batch

Available options:

CANCELLED,

COMPLETED,

DECLINED,

INITIATED,

PENDING_APPROVAL,

PENDING_PAYMENT,

RETURNED

payment_rail

string

The payment rail that was used to process the batch.

payment_rail_transfer_id

string<uuid>

The ID of the payment rail transfer that was used to process the batch.

tenant

string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

transaction_id

string<uuid>

The transaction ID of the batch which represents a transaction on the ledger.

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Update Batch Payment

Authorizations

Path Parameters

Body

Response