Skip to main content
POST
/
cards
/
transaction_simulations
/
financial
/
advice
Simulate financial advice
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/cards/transaction_simulations/financial/advice \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "original_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "network_fees": [
    {
      "amount": 123,
      "credit_debit": "C",
      "type": "ISSUER_FEE"
    }
  ],
  "transaction_options": {
    "additional_data": "<string>",
    "card_expiration_date_yymm": "<string>",
    "database_transaction_timeout": 123,
    "encryption_key_id": "<string>",
    "is_async": false,
    "pre_auth_time_limit": "<string>",
    "send_expiration_date": false,
    "send_track_data": false,
    "transaction_id": "<string>",
    "transaction_timeout_threshold_seconds": 123
  }
}
'
import requests

url = "https://api-sandbox.synctera.com/v0/cards/transaction_simulations/financial/advice"

payload = {
"amount": 123,
"original_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"network_fees": [
{
"amount": 123,
"credit_debit": "C",
"type": "ISSUER_FEE"
}
],
"transaction_options": {
"additional_data": "<string>",
"card_expiration_date_yymm": "<string>",
"database_transaction_timeout": 123,
"encryption_key_id": "<string>",
"is_async": False,
"pre_auth_time_limit": "<string>",
"send_expiration_date": False,
"send_track_data": False,
"transaction_id": "<string>",
"transaction_timeout_threshold_seconds": 123
}
}
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: 123,
original_transaction_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
network_fees: [{amount: 123, credit_debit: 'C', type: 'ISSUER_FEE'}],
transaction_options: {
additional_data: '<string>',
card_expiration_date_yymm: '<string>',
database_transaction_timeout: 123,
encryption_key_id: '<string>',
is_async: false,
pre_auth_time_limit: '<string>',
send_expiration_date: false,
send_track_data: false,
transaction_id: '<string>',
transaction_timeout_threshold_seconds: 123
}
})
};

fetch('https://api-sandbox.synctera.com/v0/cards/transaction_simulations/financial/advice', 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/cards/transaction_simulations/financial/advice",
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' => 123,
'original_transaction_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'network_fees' => [
[
'amount' => 123,
'credit_debit' => 'C',
'type' => 'ISSUER_FEE'
]
],
'transaction_options' => [
'additional_data' => '<string>',
'card_expiration_date_yymm' => '<string>',
'database_transaction_timeout' => 123,
'encryption_key_id' => '<string>',
'is_async' => false,
'pre_auth_time_limit' => '<string>',
'send_expiration_date' => false,
'send_track_data' => false,
'transaction_id' => '<string>',
'transaction_timeout_threshold_seconds' => 123
]
]),
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/cards/transaction_simulations/financial/advice"

payload := strings.NewReader("{\n \"amount\": 123,\n \"original_transaction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"network_fees\": [\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n }\n ],\n \"transaction_options\": {\n \"additional_data\": \"<string>\",\n \"card_expiration_date_yymm\": \"<string>\",\n \"database_transaction_timeout\": 123,\n \"encryption_key_id\": \"<string>\",\n \"is_async\": false,\n \"pre_auth_time_limit\": \"<string>\",\n \"send_expiration_date\": false,\n \"send_track_data\": false,\n \"transaction_id\": \"<string>\",\n \"transaction_timeout_threshold_seconds\": 123\n }\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/cards/transaction_simulations/financial/advice")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"original_transaction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"network_fees\": [\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n }\n ],\n \"transaction_options\": {\n \"additional_data\": \"<string>\",\n \"card_expiration_date_yymm\": \"<string>\",\n \"database_transaction_timeout\": 123,\n \"encryption_key_id\": \"<string>\",\n \"is_async\": false,\n \"pre_auth_time_limit\": \"<string>\",\n \"send_expiration_date\": false,\n \"send_track_data\": false,\n \"transaction_id\": \"<string>\",\n \"transaction_timeout_threshold_seconds\": 123\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.synctera.com/v0/cards/transaction_simulations/financial/advice")

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\": 123,\n \"original_transaction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"network_fees\": [\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n }\n ],\n \"transaction_options\": {\n \"additional_data\": \"<string>\",\n \"card_expiration_date_yymm\": \"<string>\",\n \"database_transaction_timeout\": 123,\n \"encryption_key_id\": \"<string>\",\n \"is_async\": false,\n \"pre_auth_time_limit\": \"<string>\",\n \"send_expiration_date\": false,\n \"send_track_data\": false,\n \"transaction_id\": \"<string>\",\n \"transaction_timeout_threshold_seconds\": 123\n }\n}"

response = http.request(request)
puts response.read_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.

Body

application/json

Financial advice details

amount
integer
required

The amount of the transaction in the smallest whole denomination of the applicable currency (eg. For USD use cents)

original_transaction_id
string<uuid>
required
network_fees
object[]
transaction_options
object

Response

Success

The response is of type object.