Create a payment schedule
curl --request POST \
--url https://api-sandbox.synctera.com/v0/payment_schedules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"payment_instruction": {
"request": {
"amount": 607,
"currency": "USD",
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"dc_sign": "debit",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"company_entry_description": "PAYROLL",
"company_name": "Asdf Finance",
"effective_date": "2022-03-18",
"external_data": {},
"final_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hold": {
"amount": 123,
"duration": 2
},
"is_same_day": true,
"memo": "<string>",
"reference_info": "Tempore atque et cum.",
"risk": {
"client_ip": "<string>"
},
"sec_code": "WEB"
},
"type": "ACH"
},
"schedule": {
"interval": 183,
"start_date": "2023-12-25",
"count": 2,
"end_date": "2023-12-25",
"execution_time": "07:30:00"
},
"metadata": {},
"tenant": "abcdef_ghijkl"
}
'import requests
url = "https://api-sandbox.synctera.com/v0/payment_schedules"
payload = {
"description": "<string>",
"payment_instruction": {
"request": {
"amount": 607,
"currency": "USD",
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"dc_sign": "debit",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"company_entry_description": "PAYROLL",
"company_name": "Asdf Finance",
"effective_date": "2022-03-18",
"external_data": {},
"final_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hold": {
"amount": 123,
"duration": 2
},
"is_same_day": True,
"memo": "<string>",
"reference_info": "Tempore atque et cum.",
"risk": { "client_ip": "<string>" },
"sec_code": "WEB"
},
"type": "ACH"
},
"schedule": {
"interval": 183,
"start_date": "2023-12-25",
"count": 2,
"end_date": "2023-12-25",
"execution_time": "07:30:00"
},
"metadata": {},
"tenant": "abcdef_ghijkl"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
payment_instruction: {
request: {
amount: 607,
currency: 'USD',
customer_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
dc_sign: 'debit',
originating_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
receiving_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
company_entry_description: 'PAYROLL',
company_name: 'Asdf Finance',
effective_date: '2022-03-18',
external_data: {},
final_customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
hold: {amount: 123, duration: 2},
is_same_day: true,
memo: '<string>',
reference_info: 'Tempore atque et cum.',
risk: {client_ip: '<string>'},
sec_code: 'WEB'
},
type: 'ACH'
},
schedule: {
interval: 183,
start_date: '2023-12-25',
count: 2,
end_date: '2023-12-25',
execution_time: '07:30:00'
},
metadata: {},
tenant: 'abcdef_ghijkl'
})
};
fetch('https://api-sandbox.synctera.com/v0/payment_schedules', 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-sandbox.synctera.com/v0/payment_schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'payment_instruction' => [
'request' => [
'amount' => 607,
'currency' => 'USD',
'customer_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'dc_sign' => 'debit',
'originating_account_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'receiving_account_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'company_entry_description' => 'PAYROLL',
'company_name' => 'Asdf Finance',
'effective_date' => '2022-03-18',
'external_data' => [
],
'final_customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'hold' => [
'amount' => 123,
'duration' => 2
],
'is_same_day' => true,
'memo' => '<string>',
'reference_info' => 'Tempore atque et cum.',
'risk' => [
'client_ip' => '<string>'
],
'sec_code' => 'WEB'
],
'type' => 'ACH'
],
'schedule' => [
'interval' => 183,
'start_date' => '2023-12-25',
'count' => 2,
'end_date' => '2023-12-25',
'execution_time' => '07:30:00'
],
'metadata' => [
],
'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-sandbox.synctera.com/v0/payment_schedules"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"payment_instruction\": {\n \"request\": {\n \"amount\": 607,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"dc_sign\": \"debit\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"company_entry_description\": \"PAYROLL\",\n \"company_name\": \"Asdf Finance\",\n \"effective_date\": \"2022-03-18\",\n \"external_data\": {},\n \"final_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"hold\": {\n \"amount\": 123,\n \"duration\": 2\n },\n \"is_same_day\": true,\n \"memo\": \"<string>\",\n \"reference_info\": \"Tempore atque et cum.\",\n \"risk\": {\n \"client_ip\": \"<string>\"\n },\n \"sec_code\": \"WEB\"\n },\n \"type\": \"ACH\"\n },\n \"schedule\": {\n \"interval\": 183,\n \"start_date\": \"2023-12-25\",\n \"count\": 2,\n \"end_date\": \"2023-12-25\",\n \"execution_time\": \"07:30:00\"\n },\n \"metadata\": {},\n \"tenant\": \"abcdef_ghijkl\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-sandbox.synctera.com/v0/payment_schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"payment_instruction\": {\n \"request\": {\n \"amount\": 607,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"dc_sign\": \"debit\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"company_entry_description\": \"PAYROLL\",\n \"company_name\": \"Asdf Finance\",\n \"effective_date\": \"2022-03-18\",\n \"external_data\": {},\n \"final_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"hold\": {\n \"amount\": 123,\n \"duration\": 2\n },\n \"is_same_day\": true,\n \"memo\": \"<string>\",\n \"reference_info\": \"Tempore atque et cum.\",\n \"risk\": {\n \"client_ip\": \"<string>\"\n },\n \"sec_code\": \"WEB\"\n },\n \"type\": \"ACH\"\n },\n \"schedule\": {\n \"interval\": 183,\n \"start_date\": \"2023-12-25\",\n \"count\": 2,\n \"end_date\": \"2023-12-25\",\n \"execution_time\": \"07:30:00\"\n },\n \"metadata\": {},\n \"tenant\": \"abcdef_ghijkl\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/payment_schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"payment_instruction\": {\n \"request\": {\n \"amount\": 607,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"dc_sign\": \"debit\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"company_entry_description\": \"PAYROLL\",\n \"company_name\": \"Asdf Finance\",\n \"effective_date\": \"2022-03-18\",\n \"external_data\": {},\n \"final_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"hold\": {\n \"amount\": 123,\n \"duration\": 2\n },\n \"is_same_day\": true,\n \"memo\": \"<string>\",\n \"reference_info\": \"Tempore atque et cum.\",\n \"risk\": {\n \"client_ip\": \"<string>\"\n },\n \"sec_code\": \"WEB\"\n },\n \"type\": \"ACH\"\n },\n \"schedule\": {\n \"interval\": 183,\n \"start_date\": \"2023-12-25\",\n \"count\": 2,\n \"end_date\": \"2023-12-25\",\n \"execution_time\": \"07:30:00\"\n },\n \"metadata\": {},\n \"tenant\": \"abcdef_ghijkl\"\n}"
response = http.request(request)
puts response.read_body{
"creation_time": "2023-11-07T05:31:56Z",
"last_updated_time": "2023-11-07T05:31:56Z",
"tenant": "abcdef_ghijkl",
"description": "<string>",
"payment_instruction": {
"request": {
"amount": 607,
"currency": "USD",
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"dc_sign": "debit",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"company_entry_description": "PAYROLL",
"company_name": "Asdf Finance",
"effective_date": "2022-03-18",
"external_data": {},
"final_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hold": {
"amount": 123,
"duration": 2
},
"is_same_day": true,
"memo": "<string>",
"reference_info": "Tempore atque et cum.",
"risk": {
"client_ip": "<string>"
},
"sec_code": "WEB"
},
"type": "ACH"
},
"schedule": {
"frequency": "DAILY",
"interval": 183,
"start_date": "2023-12-25",
"count": 2,
"end_date": "2023-12-25",
"execution_time": "07:30:00",
"start_search": "BACKWARD"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"next_payment_date": {
"execution_date": "2023-12-25",
"scheduled_date": "2023-12-25"
},
"status": "ACTIVE"
}{
"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"
}PaymentSchedules
Create a payment schedule
Create a payment schedule
POST
/
payment_schedules
Create a payment schedule
curl --request POST \
--url https://api-sandbox.synctera.com/v0/payment_schedules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"payment_instruction": {
"request": {
"amount": 607,
"currency": "USD",
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"dc_sign": "debit",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"company_entry_description": "PAYROLL",
"company_name": "Asdf Finance",
"effective_date": "2022-03-18",
"external_data": {},
"final_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hold": {
"amount": 123,
"duration": 2
},
"is_same_day": true,
"memo": "<string>",
"reference_info": "Tempore atque et cum.",
"risk": {
"client_ip": "<string>"
},
"sec_code": "WEB"
},
"type": "ACH"
},
"schedule": {
"interval": 183,
"start_date": "2023-12-25",
"count": 2,
"end_date": "2023-12-25",
"execution_time": "07:30:00"
},
"metadata": {},
"tenant": "abcdef_ghijkl"
}
'import requests
url = "https://api-sandbox.synctera.com/v0/payment_schedules"
payload = {
"description": "<string>",
"payment_instruction": {
"request": {
"amount": 607,
"currency": "USD",
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"dc_sign": "debit",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"company_entry_description": "PAYROLL",
"company_name": "Asdf Finance",
"effective_date": "2022-03-18",
"external_data": {},
"final_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hold": {
"amount": 123,
"duration": 2
},
"is_same_day": True,
"memo": "<string>",
"reference_info": "Tempore atque et cum.",
"risk": { "client_ip": "<string>" },
"sec_code": "WEB"
},
"type": "ACH"
},
"schedule": {
"interval": 183,
"start_date": "2023-12-25",
"count": 2,
"end_date": "2023-12-25",
"execution_time": "07:30:00"
},
"metadata": {},
"tenant": "abcdef_ghijkl"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
payment_instruction: {
request: {
amount: 607,
currency: 'USD',
customer_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
dc_sign: 'debit',
originating_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
receiving_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
company_entry_description: 'PAYROLL',
company_name: 'Asdf Finance',
effective_date: '2022-03-18',
external_data: {},
final_customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
hold: {amount: 123, duration: 2},
is_same_day: true,
memo: '<string>',
reference_info: 'Tempore atque et cum.',
risk: {client_ip: '<string>'},
sec_code: 'WEB'
},
type: 'ACH'
},
schedule: {
interval: 183,
start_date: '2023-12-25',
count: 2,
end_date: '2023-12-25',
execution_time: '07:30:00'
},
metadata: {},
tenant: 'abcdef_ghijkl'
})
};
fetch('https://api-sandbox.synctera.com/v0/payment_schedules', 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-sandbox.synctera.com/v0/payment_schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'payment_instruction' => [
'request' => [
'amount' => 607,
'currency' => 'USD',
'customer_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'dc_sign' => 'debit',
'originating_account_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'receiving_account_id' => 'b01db9c7-78f2-4a99-8aca-1231d32f9b96',
'company_entry_description' => 'PAYROLL',
'company_name' => 'Asdf Finance',
'effective_date' => '2022-03-18',
'external_data' => [
],
'final_customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'hold' => [
'amount' => 123,
'duration' => 2
],
'is_same_day' => true,
'memo' => '<string>',
'reference_info' => 'Tempore atque et cum.',
'risk' => [
'client_ip' => '<string>'
],
'sec_code' => 'WEB'
],
'type' => 'ACH'
],
'schedule' => [
'interval' => 183,
'start_date' => '2023-12-25',
'count' => 2,
'end_date' => '2023-12-25',
'execution_time' => '07:30:00'
],
'metadata' => [
],
'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-sandbox.synctera.com/v0/payment_schedules"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"payment_instruction\": {\n \"request\": {\n \"amount\": 607,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"dc_sign\": \"debit\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"company_entry_description\": \"PAYROLL\",\n \"company_name\": \"Asdf Finance\",\n \"effective_date\": \"2022-03-18\",\n \"external_data\": {},\n \"final_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"hold\": {\n \"amount\": 123,\n \"duration\": 2\n },\n \"is_same_day\": true,\n \"memo\": \"<string>\",\n \"reference_info\": \"Tempore atque et cum.\",\n \"risk\": {\n \"client_ip\": \"<string>\"\n },\n \"sec_code\": \"WEB\"\n },\n \"type\": \"ACH\"\n },\n \"schedule\": {\n \"interval\": 183,\n \"start_date\": \"2023-12-25\",\n \"count\": 2,\n \"end_date\": \"2023-12-25\",\n \"execution_time\": \"07:30:00\"\n },\n \"metadata\": {},\n \"tenant\": \"abcdef_ghijkl\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-sandbox.synctera.com/v0/payment_schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"payment_instruction\": {\n \"request\": {\n \"amount\": 607,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"dc_sign\": \"debit\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"company_entry_description\": \"PAYROLL\",\n \"company_name\": \"Asdf Finance\",\n \"effective_date\": \"2022-03-18\",\n \"external_data\": {},\n \"final_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"hold\": {\n \"amount\": 123,\n \"duration\": 2\n },\n \"is_same_day\": true,\n \"memo\": \"<string>\",\n \"reference_info\": \"Tempore atque et cum.\",\n \"risk\": {\n \"client_ip\": \"<string>\"\n },\n \"sec_code\": \"WEB\"\n },\n \"type\": \"ACH\"\n },\n \"schedule\": {\n \"interval\": 183,\n \"start_date\": \"2023-12-25\",\n \"count\": 2,\n \"end_date\": \"2023-12-25\",\n \"execution_time\": \"07:30:00\"\n },\n \"metadata\": {},\n \"tenant\": \"abcdef_ghijkl\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/payment_schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"payment_instruction\": {\n \"request\": {\n \"amount\": 607,\n \"currency\": \"USD\",\n \"customer_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"dc_sign\": \"debit\",\n \"originating_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"receiving_account_id\": \"b01db9c7-78f2-4a99-8aca-1231d32f9b96\",\n \"company_entry_description\": \"PAYROLL\",\n \"company_name\": \"Asdf Finance\",\n \"effective_date\": \"2022-03-18\",\n \"external_data\": {},\n \"final_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"hold\": {\n \"amount\": 123,\n \"duration\": 2\n },\n \"is_same_day\": true,\n \"memo\": \"<string>\",\n \"reference_info\": \"Tempore atque et cum.\",\n \"risk\": {\n \"client_ip\": \"<string>\"\n },\n \"sec_code\": \"WEB\"\n },\n \"type\": \"ACH\"\n },\n \"schedule\": {\n \"interval\": 183,\n \"start_date\": \"2023-12-25\",\n \"count\": 2,\n \"end_date\": \"2023-12-25\",\n \"execution_time\": \"07:30:00\"\n },\n \"metadata\": {},\n \"tenant\": \"abcdef_ghijkl\"\n}"
response = http.request(request)
puts response.read_body{
"creation_time": "2023-11-07T05:31:56Z",
"last_updated_time": "2023-11-07T05:31:56Z",
"tenant": "abcdef_ghijkl",
"description": "<string>",
"payment_instruction": {
"request": {
"amount": 607,
"currency": "USD",
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"dc_sign": "debit",
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"company_entry_description": "PAYROLL",
"company_name": "Asdf Finance",
"effective_date": "2022-03-18",
"external_data": {},
"final_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hold": {
"amount": 123,
"duration": 2
},
"is_same_day": true,
"memo": "<string>",
"reference_info": "Tempore atque et cum.",
"risk": {
"client_ip": "<string>"
},
"sec_code": "WEB"
},
"type": "ACH"
},
"schedule": {
"frequency": "DAILY",
"interval": 183,
"start_date": "2023-12-25",
"count": 2,
"end_date": "2023-12-25",
"execution_time": "07:30:00",
"start_search": "BACKWARD"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"next_payment_date": {
"execution_date": "2023-12-25",
"scheduled_date": "2023-12-25"
},
"status": "ACTIVE"
}{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
payment schedule to create
Payment schedule
User provided description for the payment schedule
- Option 1
- Option 2
Show child attributes
Show child attributes
Payment schedule recurrence configuration
Show child attributes
Show child attributes
User provided JSON format data
The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
Example:
"abcdef_ghijkl"
Response
Created payment schedule
Payment schedule
The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
Example:
"abcdef_ghijkl"
User provided description for the payment schedule
- Option 1
- Option 2
Show child attributes
Show child attributes
Payment schedule recurrence configuration
Show child attributes
Show child attributes
Payment schedule ID
User provided JSON format data
Show child attributes
Show child attributes
Status of the payment schedule.
Available options:
ACTIVE, CANCELLED, ERRORED, EXPIRED Was this page helpful?