Get BatchPayment

curl --request GET \
  --url https://api.synctera.com/v2/batches/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.synctera.com/v2/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/v2/batches/{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/batches/{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))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/batches/{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

{
  "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": "INITIATED",
  "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,
  "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"
}

GET

batches

{id}

Get BatchPayment

curl --request GET \
  --url https://api.synctera.com/v2/batches/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.synctera.com/v2/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/v2/batches/{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/batches/{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))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/batches/{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

{
  "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": "INITIATED",
  "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,
  "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"

Response

Retrieve 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:

INITIATED,

PENDING_APPROVAL,

PENDING_PAYMENT,

COMPLETED,

CANCELLED,

DECLINED,

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

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

Get BatchPayment

Authorizations

Path Parameters

Response