Make a payment

curl --request POST \
  --url https://api.synctera.com/v2/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 5000,
  "lending_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "payment_configs": {},
  "business_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "description": "Card paydown",
  "effective_date": "2024-01-25",
  "person_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tenant": "abcdef_ghijkl"
}
'

import requests

url = "https://api.synctera.com/v2/payments"

payload = {
    "amount": 5000,
    "lending_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "payment_configs": {},
    "business_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "description": "Card paydown",
    "effective_date": "2024-01-25",
    "person_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "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({
    amount: 5000,
    lending_account_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    payment_configs: {},
    business_id: 'b2c3d4e5-f6a7-8901-bcde-f12345678901',
    description: 'Card paydown',
    effective_date: '2024-01-25',
    person_id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    tenant: 'abcdef_ghijkl'
  })
};

fetch('https://api.synctera.com/v2/payments', 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/payments",
  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([
    'amount' => 5000,
    'lending_account_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    'payment_configs' => [
        
    ],
    'business_id' => 'b2c3d4e5-f6a7-8901-bcde-f12345678901',
    'description' => 'Card paydown',
    'effective_date' => '2024-01-25',
    'person_id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    '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/v2/payments"

	payload := strings.NewReader("{\n  \"amount\": 5000,\n  \"lending_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"payment_configs\": {},\n  \"business_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n  \"description\": \"Card paydown\",\n  \"effective_date\": \"2024-01-25\",\n  \"person_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\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.synctera.com/v2/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 5000,\n  \"lending_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"payment_configs\": {},\n  \"business_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n  \"description\": \"Card paydown\",\n  \"effective_date\": \"2024-01-25\",\n  \"person_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"tenant\": \"abcdef_ghijkl\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/payments")

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  \"amount\": 5000,\n  \"lending_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"payment_configs\": {},\n  \"business_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n  \"description\": \"Card paydown\",\n  \"effective_date\": \"2024-01-25\",\n  \"person_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"tenant\": \"abcdef_ghijkl\"\n}"

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

{
  "description": "<string>",
  "error_details": {
    "code": "<string>",
    "details": "<string>"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "payment_date": {
    "execution_date": "2023-12-25",
    "scheduled_date": "2023-12-25"
  },
  "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"
  },
  "payment_schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "COMPLETED",
  "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"
}

Payments

Make a payment

🚧 Beta This is a Beta endpoint. Feedback from the community is welcome. We may make breaking changes to this endpoint.

Make a one-time payment against a lending account (e.g. a card paydown), funded either from an internal Synctera platform account or an external ACH-linked account. If effective_date is today or omitted, the payment executes immediately and the response reflects its final status (EXECUTED, FAILED, or SKIPPED). If effective_date is in the future, the payment is scheduled and executes on that date.

POST

payments

Make a payment

curl --request POST \
  --url https://api.synctera.com/v2/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 5000,
  "lending_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "payment_configs": {},
  "business_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "description": "Card paydown",
  "effective_date": "2024-01-25",
  "person_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tenant": "abcdef_ghijkl"
}
'

import requests

url = "https://api.synctera.com/v2/payments"

payload = {
    "amount": 5000,
    "lending_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "payment_configs": {},
    "business_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "description": "Card paydown",
    "effective_date": "2024-01-25",
    "person_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "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({
    amount: 5000,
    lending_account_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    payment_configs: {},
    business_id: 'b2c3d4e5-f6a7-8901-bcde-f12345678901',
    description: 'Card paydown',
    effective_date: '2024-01-25',
    person_id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    tenant: 'abcdef_ghijkl'
  })
};

fetch('https://api.synctera.com/v2/payments', 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/payments",
  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([
    'amount' => 5000,
    'lending_account_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    'payment_configs' => [
        
    ],
    'business_id' => 'b2c3d4e5-f6a7-8901-bcde-f12345678901',
    'description' => 'Card paydown',
    'effective_date' => '2024-01-25',
    'person_id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    '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/v2/payments"

	payload := strings.NewReader("{\n  \"amount\": 5000,\n  \"lending_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"payment_configs\": {},\n  \"business_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n  \"description\": \"Card paydown\",\n  \"effective_date\": \"2024-01-25\",\n  \"person_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\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.synctera.com/v2/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 5000,\n  \"lending_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"payment_configs\": {},\n  \"business_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n  \"description\": \"Card paydown\",\n  \"effective_date\": \"2024-01-25\",\n  \"person_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"tenant\": \"abcdef_ghijkl\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/payments")

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  \"amount\": 5000,\n  \"lending_account_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"payment_configs\": {},\n  \"business_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n  \"description\": \"Card paydown\",\n  \"effective_date\": \"2024-01-25\",\n  \"person_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"tenant\": \"abcdef_ghijkl\"\n}"

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

{
  "description": "<string>",
  "error_details": {
    "code": "<string>",
    "details": "<string>"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "payment_date": {
    "execution_date": "2023-12-25",
    "scheduled_date": "2023-12-25"
  },
  "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"
  },
  "payment_schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "COMPLETED",
  "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.

Headers

Idempotency-Key

string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

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

Body

application/json

Payment to make

Request to make a one-time payment against a lending account (e.g. a card paydown). Exactly one of person_id or business_id must be provided to identify the customer initiating the payment; exactly one of payment_configs.ach or payment_configs.internal_transfer must be provided to identify the funding source.

amount

integer<int64>

required

Amount to pay, in cents. Paid in full as requested, even if it exceeds the account's current balance -- an intentional overpayment is honored, not truncated to the balance.

Required range: x >= 1

Example:

5000

lending_account_id

string<uuid>

required

The lending account (card/account) to pay down

Example:

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

payment_configs

object

required

Payment method-specific configurations

Show child attributes

business_id

string<uuid>

The business ID initiating this payment. Mutually exclusive with person_id -- exactly one must be provided.

Example:

"b2c3d4e5-f6a7-8901-bcde-f12345678901"

description

string

Optional description for the payment. Defaults to "Payment".

Example:

"Card paydown"

effective_date

string<date>

Date the payment should be made. Defaults to today. If today or in the past, the payment is executed immediately and the response reflects its final status; if in the future, the payment is scheduled and executes on that date.

Example:

"2024-01-25"

person_id

string<uuid>

The person ID initiating this payment. Mutually exclusive with business_id -- exactly one must be provided.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

tenant

string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

Response

Payment created (and, if effective immediately, executed)

Executed payment

description

string

User provided description for the payment schedule

error_details

object

Payment error details. It will be included only when status is ERROR

Show child attributes

string<uuid>

Payment ID

metadata

object

User provided JSON format data for the payment schedule

payment_date

object

read-only

Show child attributes

payment_instruction

object

Option 1
Option 2

Show child attributes

payment_schedule_id

string<uuid>

ID of the payment schedule that executed this payment

status

enum<string>

Payment request status

Available options:

COMPLETED,

ERROR

transaction_id

string<uuid>

Transaction ID. It will be included only when status is COMPLETED

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Make a payment

Authorizations

Headers

Body

Response