cURL
curl --request POST \
--url https://api-sandbox.paychoice.com.au/api/v5/Preauth \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"currency": "<string>",
"amount": 1,
"card[name]": "<string>",
"card[number]": "<string>",
"card[cvv]": "<string>",
"card[expiry_month]": 123,
"card[expiry_year]": 123,
"reference": "<string>",
"card_token": "<string>",
"merchant_guid": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: '<string>',
amount: 1,
'card[name]': '<string>',
'card[number]': '<string>',
'card[cvv]': '<string>',
'card[expiry_month]': 123,
'card[expiry_year]': 123,
reference: '<string>',
card_token: '<string>',
merchant_guid: '<string>'
})
};
fetch('https://api-sandbox.paychoice.com.au/api/v5/Preauth', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-sandbox.paychoice.com.au/api/v5/Preauth"
payload = {
"currency": "<string>",
"amount": 1,
"card[name]": "<string>",
"card[number]": "<string>",
"card[cvv]": "<string>",
"card[expiry_month]": 123,
"card[expiry_year]": 123,
"reference": "<string>",
"card_token": "<string>",
"merchant_guid": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api-sandbox.paychoice.com.au/api/v5/Preauth");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n \"currency\": \"<string>\",\n \"amount\": 1,\n \"card[name]\": \"<string>\",\n \"card[number]\": \"<string>\",\n \"card[cvv]\": \"<string>\",\n \"card[expiry_month]\": 123,\n \"card[expiry_year]\": 123,\n \"reference\": \"<string>\",\n \"card_token\": \"<string>\",\n \"merchant_guid\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.paychoice.com.au/api/v5/Preauth",
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([
'currency' => '<string>',
'amount' => 1,
'card[name]' => '<string>',
'card[number]' => '<string>',
'card[cvv]' => '<string>',
'card[expiry_month]' => 123,
'card[expiry_year]' => 123,
'reference' => '<string>',
'card_token' => '<string>',
'merchant_guid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"pre_auth": {
"id": "6b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
"pre_authid": "24007-P-14CULT45",
"reference": "BOOKING-7781",
"amount": 50.0,
"currency": "AUD",
"status": "Approved",
"status_code": "0",
"error": "Transaction Approved",
"error_code": "00",
"created": "2026-11-04T03:10:44.207Z",
"merchant_guid": "315564b9-b863-4016-8c53-02c9d8cc80b7"
},
"object_type": "pre_auth",
"from_item": 0,
"to_item": 0,
"total_count": 0
}
Refunds and pre-authorisations
Pre-authorise a card
POST
/
api
/
v5
/
Preauth
cURL
curl --request POST \
--url https://api-sandbox.paychoice.com.au/api/v5/Preauth \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"currency": "<string>",
"amount": 1,
"card[name]": "<string>",
"card[number]": "<string>",
"card[cvv]": "<string>",
"card[expiry_month]": 123,
"card[expiry_year]": 123,
"reference": "<string>",
"card_token": "<string>",
"merchant_guid": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: '<string>',
amount: 1,
'card[name]': '<string>',
'card[number]': '<string>',
'card[cvv]': '<string>',
'card[expiry_month]': 123,
'card[expiry_year]': 123,
reference: '<string>',
card_token: '<string>',
merchant_guid: '<string>'
})
};
fetch('https://api-sandbox.paychoice.com.au/api/v5/Preauth', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-sandbox.paychoice.com.au/api/v5/Preauth"
payload = {
"currency": "<string>",
"amount": 1,
"card[name]": "<string>",
"card[number]": "<string>",
"card[cvv]": "<string>",
"card[expiry_month]": 123,
"card[expiry_year]": 123,
"reference": "<string>",
"card_token": "<string>",
"merchant_guid": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api-sandbox.paychoice.com.au/api/v5/Preauth");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n \"currency\": \"<string>\",\n \"amount\": 1,\n \"card[name]\": \"<string>\",\n \"card[number]\": \"<string>\",\n \"card[cvv]\": \"<string>\",\n \"card[expiry_month]\": 123,\n \"card[expiry_year]\": 123,\n \"reference\": \"<string>\",\n \"card_token\": \"<string>\",\n \"merchant_guid\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.paychoice.com.au/api/v5/Preauth",
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([
'currency' => '<string>',
'amount' => 1,
'card[name]' => '<string>',
'card[number]' => '<string>',
'card[cvv]' => '<string>',
'card[expiry_month]' => 123,
'card[expiry_year]' => 123,
'reference' => '<string>',
'card_token' => '<string>',
'merchant_guid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"pre_auth": {
"id": "6b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
"pre_authid": "24007-P-14CULT45",
"reference": "BOOKING-7781",
"amount": 50.0,
"currency": "AUD",
"status": "Approved",
"status_code": "0",
"error": "Transaction Approved",
"error_code": "00",
"created": "2026-11-04T03:10:44.207Z",
"merchant_guid": "315564b9-b863-4016-8c53-02c9d8cc80b7"
},
"object_type": "pre_auth",
"from_item": 0,
"to_item": 0,
"total_count": 0
}
Holds an amount on a card without capturing it. The response includes
pre_authid; pass it to Create a charge to capture, or to Reverse a pre-authorisation to release the funds. Card details are not required if card_token is supplied.
This response has no link field.
{
"pre_auth": {
"id": "6b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
"pre_authid": "24007-P-14CULT45",
"reference": "BOOKING-7781",
"amount": 50.0,
"currency": "AUD",
"status": "Approved",
"status_code": "0",
"error": "Transaction Approved",
"error_code": "00",
"created": "2026-11-04T03:10:44.207Z",
"merchant_guid": "315564b9-b863-4016-8c53-02c9d8cc80b7"
},
"object_type": "pre_auth",
"from_item": 0,
"to_item": 0,
"total_count": 0
}
string
The handle for capture or reverse.
string
"0" Approved, "4" Blocked, "5" Dishonoured, "6" Errored, "9" Processing.Authorizations
Basic Authorization header using the Bearer scheme.
Body
application/jsontext/jsonapplication/*+json
Minimum string length:
1Required range:
x >= 0Response
200
OK