cURL
curl --request POST \
--url https://api-sandbox.paychoice.com.au/api/v5/Token \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"card[name]": "<string>",
"card[number]": "<string>",
"card[expiry_month]": 123,
"card[expiry_year]": 123,
"merchant_guid": "<string>",
"card_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key_id": 123,
"card_type": 123
}
'const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
'card[name]': '<string>',
'card[number]': '<string>',
'card[expiry_month]': 123,
'card[expiry_year]': 123,
merchant_guid: '<string>',
card_token: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
key_id: 123,
card_type: 123
})
};
fetch('https://api-sandbox.paychoice.com.au/api/v5/Token', 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/Token"
payload = {
"card[name]": "<string>",
"card[number]": "<string>",
"card[expiry_month]": 123,
"card[expiry_year]": 123,
"merchant_guid": "<string>",
"card_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key_id": 123,
"card_type": 123
}
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/Token");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n \"card[name]\": \"<string>\",\n \"card[number]\": \"<string>\",\n \"card[expiry_month]\": 123,\n \"card[expiry_year]\": 123,\n \"merchant_guid\": \"<string>\",\n \"card_token\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"key_id\": 123,\n \"card_type\": 123\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/Token",
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([
'card[name]' => '<string>',
'card[number]' => '<string>',
'card[expiry_month]' => 123,
'card[expiry_year]' => 123,
'merchant_guid' => '<string>',
'card_token' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'key_id' => 123,
'card_type' => 123
]),
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;
}{
"card": {
"token": "c629ac3b-682b-41e4-9a81-9445960843cf",
"card_name": "John Citizen",
"masked_number": "411111XXXXXX1111",
"expiry_month": "12",
"expiry_year": "28",
"card_type": "Visa",
"key_id": 1,
"link": { "href": "/api/v5/token/c629ac3b-682b-41e4-9a81-9445960843cf", "rel": "self" }
},
"object_type": "card",
"merchant_guid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
"from_item": 0,
"to_item": 0,
"total_count": 0
}
Tokens
Store a credit card
POST
/
api
/
v5
/
Token
cURL
curl --request POST \
--url https://api-sandbox.paychoice.com.au/api/v5/Token \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"card[name]": "<string>",
"card[number]": "<string>",
"card[expiry_month]": 123,
"card[expiry_year]": 123,
"merchant_guid": "<string>",
"card_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key_id": 123,
"card_type": 123
}
'const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
'card[name]': '<string>',
'card[number]': '<string>',
'card[expiry_month]': 123,
'card[expiry_year]': 123,
merchant_guid: '<string>',
card_token: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
key_id: 123,
card_type: 123
})
};
fetch('https://api-sandbox.paychoice.com.au/api/v5/Token', 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/Token"
payload = {
"card[name]": "<string>",
"card[number]": "<string>",
"card[expiry_month]": 123,
"card[expiry_year]": 123,
"merchant_guid": "<string>",
"card_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key_id": 123,
"card_type": 123
}
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/Token");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n \"card[name]\": \"<string>\",\n \"card[number]\": \"<string>\",\n \"card[expiry_month]\": 123,\n \"card[expiry_year]\": 123,\n \"merchant_guid\": \"<string>\",\n \"card_token\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"key_id\": 123,\n \"card_type\": 123\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/Token",
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([
'card[name]' => '<string>',
'card[number]' => '<string>',
'card[expiry_month]' => 123,
'card[expiry_year]' => 123,
'merchant_guid' => '<string>',
'card_token' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'key_id' => 123,
'card_type' => 123
]),
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;
}{
"card": {
"token": "c629ac3b-682b-41e4-9a81-9445960843cf",
"card_name": "John Citizen",
"masked_number": "411111XXXXXX1111",
"expiry_month": "12",
"expiry_year": "28",
"card_type": "Visa",
"key_id": 1,
"link": { "href": "/api/v5/token/c629ac3b-682b-41e4-9a81-9445960843cf", "rel": "self" }
},
"object_type": "card",
"merchant_guid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
"from_item": 0,
"to_item": 0,
"total_count": 0
}
Stores card details and returns a token to use in place of the card on later charges (pass it as
card_token). Returns HTTP 200 on v4 and 201 Created on v5; the body is the same. merchant_guid is returned at the top level, outside card.
Tokens expire after first use unless attached to a customer.
{
"card": {
"token": "c629ac3b-682b-41e4-9a81-9445960843cf",
"card_name": "John Citizen",
"masked_number": "411111XXXXXX1111",
"expiry_month": "12",
"expiry_year": "28",
"card_type": "Visa",
"key_id": 1,
"link": { "href": "/api/v5/token/c629ac3b-682b-41e4-9a81-9445960843cf", "rel": "self" }
},
"object_type": "card",
"merchant_guid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
"from_item": 0,
"to_item": 0,
"total_count": 0
}
uuid
The card token.
string
Visa, MasterCard, AmericanExpress, DinersClub, Jcb, Discover, BankCard or Unknown.string
Middle digits masked.
Authorizations
Basic Authorization header using the Bearer scheme.
Body
application/jsontext/jsonapplication/*+json
Response
200
OK

