Simulate clearing or refund
curl --request POST \
--url https://api-sandbox.synctera.com/v0/cards/transaction_simulations/clearing \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 80,
"card_acceptor": {
"address": "address",
"city": "city",
"country": "country",
"ecommerce_security_level_indicator": "ecommerce_security_level_indicator",
"mcc": "mcc",
"name": "name",
"partial_approval_capable": false,
"state": "state",
"zip": "zip"
},
"force_post": false,
"is_refund": false,
"mid": "mid",
"network_fees": [
{
"amount": 123,
"credit_debit": "C",
"type": "ISSUER_FEE"
},
{
"amount": 123,
"credit_debit": "C",
"type": "ISSUER_FEE"
}
],
"original_transaction_id": "original_transaction_id"
}
'import requests
url = "https://api-sandbox.synctera.com/v0/cards/transaction_simulations/clearing"
payload = {
"amount": 80,
"card_acceptor": {
"address": "address",
"city": "city",
"country": "country",
"ecommerce_security_level_indicator": "ecommerce_security_level_indicator",
"mcc": "mcc",
"name": "name",
"partial_approval_capable": False,
"state": "state",
"zip": "zip"
},
"force_post": False,
"is_refund": False,
"mid": "mid",
"network_fees": [
{
"amount": 123,
"credit_debit": "C",
"type": "ISSUER_FEE"
},
{
"amount": 123,
"credit_debit": "C",
"type": "ISSUER_FEE"
}
],
"original_transaction_id": "original_transaction_id"
}
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: 80,
card_acceptor: {
address: 'address',
city: 'city',
country: 'country',
ecommerce_security_level_indicator: 'ecommerce_security_level_indicator',
mcc: 'mcc',
name: 'name',
partial_approval_capable: false,
state: 'state',
zip: 'zip'
},
force_post: false,
is_refund: false,
mid: 'mid',
network_fees: [
{amount: 123, credit_debit: 'C', type: 'ISSUER_FEE'},
{amount: 123, credit_debit: 'C', type: 'ISSUER_FEE'}
],
original_transaction_id: 'original_transaction_id'
})
};
fetch('https://api-sandbox.synctera.com/v0/cards/transaction_simulations/clearing', 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/clearing",
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' => 80,
'card_acceptor' => [
'address' => 'address',
'city' => 'city',
'country' => 'country',
'ecommerce_security_level_indicator' => 'ecommerce_security_level_indicator',
'mcc' => 'mcc',
'name' => 'name',
'partial_approval_capable' => false,
'state' => 'state',
'zip' => 'zip'
],
'force_post' => false,
'is_refund' => false,
'mid' => 'mid',
'network_fees' => [
[
'amount' => 123,
'credit_debit' => 'C',
'type' => 'ISSUER_FEE'
],
[
'amount' => 123,
'credit_debit' => 'C',
'type' => 'ISSUER_FEE'
]
],
'original_transaction_id' => 'original_transaction_id'
]),
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/clearing"
payload := strings.NewReader("{\n \"amount\": 80,\n \"card_acceptor\": {\n \"address\": \"address\",\n \"city\": \"city\",\n \"country\": \"country\",\n \"ecommerce_security_level_indicator\": \"ecommerce_security_level_indicator\",\n \"mcc\": \"mcc\",\n \"name\": \"name\",\n \"partial_approval_capable\": false,\n \"state\": \"state\",\n \"zip\": \"zip\"\n },\n \"force_post\": false,\n \"is_refund\": false,\n \"mid\": \"mid\",\n \"network_fees\": [\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n },\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n }\n ],\n \"original_transaction_id\": \"original_transaction_id\"\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/clearing")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 80,\n \"card_acceptor\": {\n \"address\": \"address\",\n \"city\": \"city\",\n \"country\": \"country\",\n \"ecommerce_security_level_indicator\": \"ecommerce_security_level_indicator\",\n \"mcc\": \"mcc\",\n \"name\": \"name\",\n \"partial_approval_capable\": false,\n \"state\": \"state\",\n \"zip\": \"zip\"\n },\n \"force_post\": false,\n \"is_refund\": false,\n \"mid\": \"mid\",\n \"network_fees\": [\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n },\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n }\n ],\n \"original_transaction_id\": \"original_transaction_id\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/cards/transaction_simulations/clearing")
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\": 80,\n \"card_acceptor\": {\n \"address\": \"address\",\n \"city\": \"city\",\n \"country\": \"country\",\n \"ecommerce_security_level_indicator\": \"ecommerce_security_level_indicator\",\n \"mcc\": \"mcc\",\n \"name\": \"name\",\n \"partial_approval_capable\": false,\n \"state\": \"state\",\n \"zip\": \"zip\"\n },\n \"force_post\": false,\n \"is_refund\": false,\n \"mid\": \"mid\",\n \"network_fees\": [\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n },\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n }\n ],\n \"original_transaction_id\": \"original_transaction_id\"\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"
}Card Transaction Simulations
Simulate clearing or refund
Simulate an authorization.clearing type transaction by including the original_transaction_token and amount in your request. To simulate a refund type transaction, set the is_refund field to true.
POST
/
cards
/
transaction_simulations
/
clearing
Simulate clearing or refund
curl --request POST \
--url https://api-sandbox.synctera.com/v0/cards/transaction_simulations/clearing \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 80,
"card_acceptor": {
"address": "address",
"city": "city",
"country": "country",
"ecommerce_security_level_indicator": "ecommerce_security_level_indicator",
"mcc": "mcc",
"name": "name",
"partial_approval_capable": false,
"state": "state",
"zip": "zip"
},
"force_post": false,
"is_refund": false,
"mid": "mid",
"network_fees": [
{
"amount": 123,
"credit_debit": "C",
"type": "ISSUER_FEE"
},
{
"amount": 123,
"credit_debit": "C",
"type": "ISSUER_FEE"
}
],
"original_transaction_id": "original_transaction_id"
}
'import requests
url = "https://api-sandbox.synctera.com/v0/cards/transaction_simulations/clearing"
payload = {
"amount": 80,
"card_acceptor": {
"address": "address",
"city": "city",
"country": "country",
"ecommerce_security_level_indicator": "ecommerce_security_level_indicator",
"mcc": "mcc",
"name": "name",
"partial_approval_capable": False,
"state": "state",
"zip": "zip"
},
"force_post": False,
"is_refund": False,
"mid": "mid",
"network_fees": [
{
"amount": 123,
"credit_debit": "C",
"type": "ISSUER_FEE"
},
{
"amount": 123,
"credit_debit": "C",
"type": "ISSUER_FEE"
}
],
"original_transaction_id": "original_transaction_id"
}
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: 80,
card_acceptor: {
address: 'address',
city: 'city',
country: 'country',
ecommerce_security_level_indicator: 'ecommerce_security_level_indicator',
mcc: 'mcc',
name: 'name',
partial_approval_capable: false,
state: 'state',
zip: 'zip'
},
force_post: false,
is_refund: false,
mid: 'mid',
network_fees: [
{amount: 123, credit_debit: 'C', type: 'ISSUER_FEE'},
{amount: 123, credit_debit: 'C', type: 'ISSUER_FEE'}
],
original_transaction_id: 'original_transaction_id'
})
};
fetch('https://api-sandbox.synctera.com/v0/cards/transaction_simulations/clearing', 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/clearing",
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' => 80,
'card_acceptor' => [
'address' => 'address',
'city' => 'city',
'country' => 'country',
'ecommerce_security_level_indicator' => 'ecommerce_security_level_indicator',
'mcc' => 'mcc',
'name' => 'name',
'partial_approval_capable' => false,
'state' => 'state',
'zip' => 'zip'
],
'force_post' => false,
'is_refund' => false,
'mid' => 'mid',
'network_fees' => [
[
'amount' => 123,
'credit_debit' => 'C',
'type' => 'ISSUER_FEE'
],
[
'amount' => 123,
'credit_debit' => 'C',
'type' => 'ISSUER_FEE'
]
],
'original_transaction_id' => 'original_transaction_id'
]),
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/clearing"
payload := strings.NewReader("{\n \"amount\": 80,\n \"card_acceptor\": {\n \"address\": \"address\",\n \"city\": \"city\",\n \"country\": \"country\",\n \"ecommerce_security_level_indicator\": \"ecommerce_security_level_indicator\",\n \"mcc\": \"mcc\",\n \"name\": \"name\",\n \"partial_approval_capable\": false,\n \"state\": \"state\",\n \"zip\": \"zip\"\n },\n \"force_post\": false,\n \"is_refund\": false,\n \"mid\": \"mid\",\n \"network_fees\": [\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n },\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n }\n ],\n \"original_transaction_id\": \"original_transaction_id\"\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/clearing")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 80,\n \"card_acceptor\": {\n \"address\": \"address\",\n \"city\": \"city\",\n \"country\": \"country\",\n \"ecommerce_security_level_indicator\": \"ecommerce_security_level_indicator\",\n \"mcc\": \"mcc\",\n \"name\": \"name\",\n \"partial_approval_capable\": false,\n \"state\": \"state\",\n \"zip\": \"zip\"\n },\n \"force_post\": false,\n \"is_refund\": false,\n \"mid\": \"mid\",\n \"network_fees\": [\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n },\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n }\n ],\n \"original_transaction_id\": \"original_transaction_id\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/cards/transaction_simulations/clearing")
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\": 80,\n \"card_acceptor\": {\n \"address\": \"address\",\n \"city\": \"city\",\n \"country\": \"country\",\n \"ecommerce_security_level_indicator\": \"ecommerce_security_level_indicator\",\n \"mcc\": \"mcc\",\n \"name\": \"name\",\n \"partial_approval_capable\": false,\n \"state\": \"state\",\n \"zip\": \"zip\"\n },\n \"force_post\": false,\n \"is_refund\": false,\n \"mid\": \"mid\",\n \"network_fees\": [\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n },\n {\n \"amount\": 123,\n \"credit_debit\": \"C\",\n \"type\": \"ISSUER_FEE\"\n }\n ],\n \"original_transaction_id\": \"original_transaction_id\"\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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Transaction clearing or refund details
The amount of the transaction in the smallest whole denomination of the applicable currency (eg. For USD use cents)
When you simulated a clearing the synchronous response would have included a transaction.token. That value should be used here.
Show child attributes
Show child attributes
Example:
{
"address": "address",
"city": "city",
"country": "country",
"ecommerce_security_level_indicator": "ecommerce_security_level_indicator",
"mcc": "mcc",
"name": "name",
"partial_approval_capable": false,
"state": "state",
"zip": "zip"
}
Required string length:
1 - 50Show child attributes
Show child attributes
Response
Success
The response is of type object.
Was this page helpful?
⌘I