Simulate OCT
curl --request POST \
--url https://api.synctera.com/v1/cards/transaction_simulations/financial/original_credit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mid": "<string>",
"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"
},
"screening_score": "<string>",
"transactionPurpose": "<string>"
}
'import requests
url = "https://api.synctera.com/v1/cards/transaction_simulations/financial/original_credit"
payload = {
"amount": 123,
"card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mid": "<string>",
"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"
},
"screening_score": "<string>",
"transactionPurpose": "<string>"
}
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,
card_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
mid: '<string>',
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'
},
screening_score: '<string>',
transactionPurpose: '<string>'
})
};
fetch('https://api.synctera.com/v1/cards/transaction_simulations/financial/original_credit', 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/v1/cards/transaction_simulations/financial/original_credit",
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,
'card_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'mid' => '<string>',
'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'
],
'screening_score' => '<string>',
'transactionPurpose' => '<string>'
]),
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/v1/cards/transaction_simulations/financial/original_credit"
payload := strings.NewReader("{\n \"amount\": 123,\n \"card_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mid\": \"<string>\",\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 \"screening_score\": \"<string>\",\n \"transactionPurpose\": \"<string>\"\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/v1/cards/transaction_simulations/financial/original_credit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"card_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mid\": \"<string>\",\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 \"screening_score\": \"<string>\",\n \"transactionPurpose\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v1/cards/transaction_simulations/financial/original_credit")
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 \"card_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mid\": \"<string>\",\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 \"screening_score\": \"<string>\",\n \"transactionPurpose\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}Card Transaction Simulations (beta)
Simulate OCT
This Original Credit Transaction (OCT) enables the cardholder to receive funds on the specified card from an external source via the card network. Use this endpoint to simulate a transaction that is similar to a wire transfer and not linked to any purchase.
Simulate an OCT by including the card_token, amount, mid, and type in your request.
POST
/
cards
/
transaction_simulations
/
financial
/
original_credit
Simulate OCT
curl --request POST \
--url https://api.synctera.com/v1/cards/transaction_simulations/financial/original_credit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mid": "<string>",
"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"
},
"screening_score": "<string>",
"transactionPurpose": "<string>"
}
'import requests
url = "https://api.synctera.com/v1/cards/transaction_simulations/financial/original_credit"
payload = {
"amount": 123,
"card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mid": "<string>",
"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"
},
"screening_score": "<string>",
"transactionPurpose": "<string>"
}
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,
card_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
mid: '<string>',
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'
},
screening_score: '<string>',
transactionPurpose: '<string>'
})
};
fetch('https://api.synctera.com/v1/cards/transaction_simulations/financial/original_credit', 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/v1/cards/transaction_simulations/financial/original_credit",
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,
'card_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'mid' => '<string>',
'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'
],
'screening_score' => '<string>',
'transactionPurpose' => '<string>'
]),
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/v1/cards/transaction_simulations/financial/original_credit"
payload := strings.NewReader("{\n \"amount\": 123,\n \"card_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mid\": \"<string>\",\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 \"screening_score\": \"<string>\",\n \"transactionPurpose\": \"<string>\"\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/v1/cards/transaction_simulations/financial/original_credit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"card_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mid\": \"<string>\",\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 \"screening_score\": \"<string>\",\n \"transactionPurpose\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v1/cards/transaction_simulations/financial/original_credit")
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 \"card_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mid\": \"<string>\",\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 \"screening_score\": \"<string>\",\n \"transactionPurpose\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}{
"code": "BAD_REQUEST_BODY",
"detail": "Missing required fields: first_name, dob",
"status": 400
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
OCT details
The amount of the transaction in the smallest whole denomination of the applicable currency (eg. For USD use cents)
Required string length:
1 - 50Available options:
account_to_account, bill_payment, business_to_business, card_bill_payment, cash_claim, cash_in, cash_out, disbursement, face_to_face_merchant_payment, gambling_payout, government_disbursement, government_payment, loyalty, merchant_disbursement, mobile_air_time_payment, money_transfer_by_bank, money_transfer_by_merchant, online_gambling_payout, payments_goods_services, pension_disbursement, person_to_person, prepaid, prepaid_loads, wallet_transfer 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"
}
Show child attributes
Show child attributes
Response
Success
The response is of type object.
Was this page helpful?
⌘I