Create Checkout Session
curl --request POST \
--url https://service-sandbox.tazapay.com/v3/checkout \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"invoice_currency": "USD",
"amount": 100000,
"customer_details": {
"name": "Andrea Lark",
"country": "SG",
"email": "andrea@example.com",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"billing_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"shipping_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"success_url": "https://mystore.com/success_page",
"cancel_url": "https://mystore.com/try_again",
"webhook_url": "https://mystore.com/internal/webhook",
"payment_methods": [
"paynow_sgd",
"card"
],
"transaction_description": "1 x T-shirt",
"expires_at": "2024-07-21T14:01:04.576356Z",
"reference_id": "mystore_order_00001"
}
'import requests
url = "https://service-sandbox.tazapay.com/v3/checkout"
payload = {
"invoice_currency": "USD",
"amount": 100000,
"customer_details": {
"name": "Andrea Lark",
"country": "SG",
"email": "andrea@example.com",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"billing_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"shipping_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"success_url": "https://mystore.com/success_page",
"cancel_url": "https://mystore.com/try_again",
"webhook_url": "https://mystore.com/internal/webhook",
"payment_methods": ["paynow_sgd", "card"],
"transaction_description": "1 x T-shirt",
"expires_at": "2024-07-21T14:01:04.576356Z",
"reference_id": "mystore_order_00001"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invoice_currency: 'USD',
amount: 100000,
customer_details: {
name: 'Andrea Lark',
country: 'SG',
email: 'andrea@example.com',
phone: {calling_code: '65', number: '87654321'}
},
billing_details: {
address: {
city: 'Singapore',
country: 'SG',
line1: '1st Street',
line2: '2nd Avenue',
postal_code: '43004',
state: 'Singapore'
},
label: 'Home',
name: 'Andrea Lark',
phone: {calling_code: '65', number: '87654321'}
},
shipping_details: {
address: {
city: 'Singapore',
country: 'SG',
line1: '1st Street',
line2: '2nd Avenue',
postal_code: '43004',
state: 'Singapore'
},
label: 'Home',
name: 'Andrea Lark',
phone: {calling_code: '65', number: '87654321'}
},
success_url: 'https://mystore.com/success_page',
cancel_url: 'https://mystore.com/try_again',
webhook_url: 'https://mystore.com/internal/webhook',
payment_methods: ['paynow_sgd', 'card'],
transaction_description: '1 x T-shirt',
expires_at: '2024-07-21T14:01:04.576356Z',
reference_id: 'mystore_order_00001'
})
};
fetch('https://service-sandbox.tazapay.com/v3/checkout', 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://service-sandbox.tazapay.com/v3/checkout",
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([
'invoice_currency' => 'USD',
'amount' => 100000,
'customer_details' => [
'name' => 'Andrea Lark',
'country' => 'SG',
'email' => 'andrea@example.com',
'phone' => [
'calling_code' => '65',
'number' => '87654321'
]
],
'billing_details' => [
'address' => [
'city' => 'Singapore',
'country' => 'SG',
'line1' => '1st Street',
'line2' => '2nd Avenue',
'postal_code' => '43004',
'state' => 'Singapore'
],
'label' => 'Home',
'name' => 'Andrea Lark',
'phone' => [
'calling_code' => '65',
'number' => '87654321'
]
],
'shipping_details' => [
'address' => [
'city' => 'Singapore',
'country' => 'SG',
'line1' => '1st Street',
'line2' => '2nd Avenue',
'postal_code' => '43004',
'state' => 'Singapore'
],
'label' => 'Home',
'name' => 'Andrea Lark',
'phone' => [
'calling_code' => '65',
'number' => '87654321'
]
],
'success_url' => 'https://mystore.com/success_page',
'cancel_url' => 'https://mystore.com/try_again',
'webhook_url' => 'https://mystore.com/internal/webhook',
'payment_methods' => [
'paynow_sgd',
'card'
],
'transaction_description' => '1 x T-shirt',
'expires_at' => '2024-07-21T14:01:04.576356Z',
'reference_id' => 'mystore_order_00001'
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://service-sandbox.tazapay.com/v3/checkout"
payload := strings.NewReader("{\n \"invoice_currency\": \"USD\",\n \"amount\": 100000,\n \"customer_details\": {\n \"name\": \"Andrea Lark\",\n \"country\": \"SG\",\n \"email\": \"andrea@example.com\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"billing_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"shipping_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"success_url\": \"https://mystore.com/success_page\",\n \"cancel_url\": \"https://mystore.com/try_again\",\n \"webhook_url\": \"https://mystore.com/internal/webhook\",\n \"payment_methods\": [\n \"paynow_sgd\",\n \"card\"\n ],\n \"transaction_description\": \"1 x T-shirt\",\n \"expires_at\": \"2024-07-21T14:01:04.576356Z\",\n \"reference_id\": \"mystore_order_00001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://service-sandbox.tazapay.com/v3/checkout")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"invoice_currency\": \"USD\",\n \"amount\": 100000,\n \"customer_details\": {\n \"name\": \"Andrea Lark\",\n \"country\": \"SG\",\n \"email\": \"andrea@example.com\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"billing_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"shipping_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"success_url\": \"https://mystore.com/success_page\",\n \"cancel_url\": \"https://mystore.com/try_again\",\n \"webhook_url\": \"https://mystore.com/internal/webhook\",\n \"payment_methods\": [\n \"paynow_sgd\",\n \"card\"\n ],\n \"transaction_description\": \"1 x T-shirt\",\n \"expires_at\": \"2024-07-21T14:01:04.576356Z\",\n \"reference_id\": \"mystore_order_00001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://service-sandbox.tazapay.com/v3/checkout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invoice_currency\": \"USD\",\n \"amount\": 100000,\n \"customer_details\": {\n \"name\": \"Andrea Lark\",\n \"country\": \"SG\",\n \"email\": \"andrea@example.com\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"billing_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"shipping_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"success_url\": \"https://mystore.com/success_page\",\n \"cancel_url\": \"https://mystore.com/try_again\",\n \"webhook_url\": \"https://mystore.com/internal/webhook\",\n \"payment_methods\": [\n \"paynow_sgd\",\n \"card\"\n ],\n \"transaction_description\": \"1 x T-shirt\",\n \"expires_at\": \"2024-07-21T14:01:04.576356Z\",\n \"reference_id\": \"mystore_order_00001\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "checkout session created successfully",
"data": {
"id": "chk_cirsp2sl4ar024j0akj0",
"object": "checkout",
"invoice_currency": "USD",
"amount": 100000,
"amount_paid": 0,
"customer_details": {
"country": "SG",
"email": "andrea@example.com",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"customer": "cus_afobaifawnf",
"billing_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"shipping_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"success_url": "https://mystore.com/success_page",
"cancel_url": "https://mystore.com/try_again",
"webhook_url": "https://mystore.com/internal/webhook",
"payment_methods": [
"paynow_sgd",
"card"
],
"transaction_description": "1 x trousers",
"expires_at": "2023-07-21T14:01:04.576356Z",
"created_at": "2023-07-19T11:44:11.722049185Z",
"url": "https://checkout.tazapay.com/transaction=ajfuibfainfaonfa",
"payment_status": "unpaid",
"payment_status_description": null,
"status": "active",
"payin": "chk_cirsp2sl4ar024j0akj0",
"payment_attempts": [],
"latest_payment_attempt": "",
"partially_paid": false,
"paid_in_excess": false,
"transaction_documents": [],
"reference_id": "mystore_order_00001",
"metadata": null
}
}Checkout
Create Checkout Session
This lets you create a checkout session for your customer by generating a Tazapay hosted payment page.
POST
/
v3
/
checkout
Create Checkout Session
curl --request POST \
--url https://service-sandbox.tazapay.com/v3/checkout \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"invoice_currency": "USD",
"amount": 100000,
"customer_details": {
"name": "Andrea Lark",
"country": "SG",
"email": "andrea@example.com",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"billing_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"shipping_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"success_url": "https://mystore.com/success_page",
"cancel_url": "https://mystore.com/try_again",
"webhook_url": "https://mystore.com/internal/webhook",
"payment_methods": [
"paynow_sgd",
"card"
],
"transaction_description": "1 x T-shirt",
"expires_at": "2024-07-21T14:01:04.576356Z",
"reference_id": "mystore_order_00001"
}
'import requests
url = "https://service-sandbox.tazapay.com/v3/checkout"
payload = {
"invoice_currency": "USD",
"amount": 100000,
"customer_details": {
"name": "Andrea Lark",
"country": "SG",
"email": "andrea@example.com",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"billing_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"shipping_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"success_url": "https://mystore.com/success_page",
"cancel_url": "https://mystore.com/try_again",
"webhook_url": "https://mystore.com/internal/webhook",
"payment_methods": ["paynow_sgd", "card"],
"transaction_description": "1 x T-shirt",
"expires_at": "2024-07-21T14:01:04.576356Z",
"reference_id": "mystore_order_00001"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invoice_currency: 'USD',
amount: 100000,
customer_details: {
name: 'Andrea Lark',
country: 'SG',
email: 'andrea@example.com',
phone: {calling_code: '65', number: '87654321'}
},
billing_details: {
address: {
city: 'Singapore',
country: 'SG',
line1: '1st Street',
line2: '2nd Avenue',
postal_code: '43004',
state: 'Singapore'
},
label: 'Home',
name: 'Andrea Lark',
phone: {calling_code: '65', number: '87654321'}
},
shipping_details: {
address: {
city: 'Singapore',
country: 'SG',
line1: '1st Street',
line2: '2nd Avenue',
postal_code: '43004',
state: 'Singapore'
},
label: 'Home',
name: 'Andrea Lark',
phone: {calling_code: '65', number: '87654321'}
},
success_url: 'https://mystore.com/success_page',
cancel_url: 'https://mystore.com/try_again',
webhook_url: 'https://mystore.com/internal/webhook',
payment_methods: ['paynow_sgd', 'card'],
transaction_description: '1 x T-shirt',
expires_at: '2024-07-21T14:01:04.576356Z',
reference_id: 'mystore_order_00001'
})
};
fetch('https://service-sandbox.tazapay.com/v3/checkout', 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://service-sandbox.tazapay.com/v3/checkout",
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([
'invoice_currency' => 'USD',
'amount' => 100000,
'customer_details' => [
'name' => 'Andrea Lark',
'country' => 'SG',
'email' => 'andrea@example.com',
'phone' => [
'calling_code' => '65',
'number' => '87654321'
]
],
'billing_details' => [
'address' => [
'city' => 'Singapore',
'country' => 'SG',
'line1' => '1st Street',
'line2' => '2nd Avenue',
'postal_code' => '43004',
'state' => 'Singapore'
],
'label' => 'Home',
'name' => 'Andrea Lark',
'phone' => [
'calling_code' => '65',
'number' => '87654321'
]
],
'shipping_details' => [
'address' => [
'city' => 'Singapore',
'country' => 'SG',
'line1' => '1st Street',
'line2' => '2nd Avenue',
'postal_code' => '43004',
'state' => 'Singapore'
],
'label' => 'Home',
'name' => 'Andrea Lark',
'phone' => [
'calling_code' => '65',
'number' => '87654321'
]
],
'success_url' => 'https://mystore.com/success_page',
'cancel_url' => 'https://mystore.com/try_again',
'webhook_url' => 'https://mystore.com/internal/webhook',
'payment_methods' => [
'paynow_sgd',
'card'
],
'transaction_description' => '1 x T-shirt',
'expires_at' => '2024-07-21T14:01:04.576356Z',
'reference_id' => 'mystore_order_00001'
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://service-sandbox.tazapay.com/v3/checkout"
payload := strings.NewReader("{\n \"invoice_currency\": \"USD\",\n \"amount\": 100000,\n \"customer_details\": {\n \"name\": \"Andrea Lark\",\n \"country\": \"SG\",\n \"email\": \"andrea@example.com\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"billing_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"shipping_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"success_url\": \"https://mystore.com/success_page\",\n \"cancel_url\": \"https://mystore.com/try_again\",\n \"webhook_url\": \"https://mystore.com/internal/webhook\",\n \"payment_methods\": [\n \"paynow_sgd\",\n \"card\"\n ],\n \"transaction_description\": \"1 x T-shirt\",\n \"expires_at\": \"2024-07-21T14:01:04.576356Z\",\n \"reference_id\": \"mystore_order_00001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://service-sandbox.tazapay.com/v3/checkout")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"invoice_currency\": \"USD\",\n \"amount\": 100000,\n \"customer_details\": {\n \"name\": \"Andrea Lark\",\n \"country\": \"SG\",\n \"email\": \"andrea@example.com\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"billing_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"shipping_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"success_url\": \"https://mystore.com/success_page\",\n \"cancel_url\": \"https://mystore.com/try_again\",\n \"webhook_url\": \"https://mystore.com/internal/webhook\",\n \"payment_methods\": [\n \"paynow_sgd\",\n \"card\"\n ],\n \"transaction_description\": \"1 x T-shirt\",\n \"expires_at\": \"2024-07-21T14:01:04.576356Z\",\n \"reference_id\": \"mystore_order_00001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://service-sandbox.tazapay.com/v3/checkout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invoice_currency\": \"USD\",\n \"amount\": 100000,\n \"customer_details\": {\n \"name\": \"Andrea Lark\",\n \"country\": \"SG\",\n \"email\": \"andrea@example.com\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"billing_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"shipping_details\": {\n \"address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"1st Street\",\n \"line2\": \"2nd Avenue\",\n \"postal_code\": \"43004\",\n \"state\": \"Singapore\"\n },\n \"label\": \"Home\",\n \"name\": \"Andrea Lark\",\n \"phone\": {\n \"calling_code\": \"65\",\n \"number\": \"87654321\"\n }\n },\n \"success_url\": \"https://mystore.com/success_page\",\n \"cancel_url\": \"https://mystore.com/try_again\",\n \"webhook_url\": \"https://mystore.com/internal/webhook\",\n \"payment_methods\": [\n \"paynow_sgd\",\n \"card\"\n ],\n \"transaction_description\": \"1 x T-shirt\",\n \"expires_at\": \"2024-07-21T14:01:04.576356Z\",\n \"reference_id\": \"mystore_order_00001\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "checkout session created successfully",
"data": {
"id": "chk_cirsp2sl4ar024j0akj0",
"object": "checkout",
"invoice_currency": "USD",
"amount": 100000,
"amount_paid": 0,
"customer_details": {
"country": "SG",
"email": "andrea@example.com",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"customer": "cus_afobaifawnf",
"billing_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"shipping_details": {
"address": {
"city": "Singapore",
"country": "SG",
"line1": "1st Street",
"line2": "2nd Avenue",
"postal_code": "43004",
"state": "Singapore"
},
"label": "Home",
"name": "Andrea Lark",
"phone": {
"calling_code": "65",
"number": "87654321"
}
},
"success_url": "https://mystore.com/success_page",
"cancel_url": "https://mystore.com/try_again",
"webhook_url": "https://mystore.com/internal/webhook",
"payment_methods": [
"paynow_sgd",
"card"
],
"transaction_description": "1 x trousers",
"expires_at": "2023-07-21T14:01:04.576356Z",
"created_at": "2023-07-19T11:44:11.722049185Z",
"url": "https://checkout.tazapay.com/transaction=ajfuibfainfaonfa",
"payment_status": "unpaid",
"payment_status_description": null,
"status": "active",
"payin": "chk_cirsp2sl4ar024j0akj0",
"payment_attempts": [],
"latest_payment_attempt": "",
"partially_paid": false,
"paid_in_excess": false,
"transaction_documents": [],
"reference_id": "mystore_order_00001",
"metadata": null
}
}Tazapay has a per transaction limit depending on the payment method and currency. To avoid any errors, please refer to our FAQ.
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Invoice currency for the checkout session (in uppercase, iso-4217 standard). By default, the invoice currency is the holding currency for the transaction.
Amount in cents. For example if you want to charge $10.12 pass 1012 as the value. For decimal handling for various currencies, refer to the guide here
Details about the customer
Show child attributes
Show child attributes
URL where the customer is directed to after a successful payment
The URL the customer will be directed to if they decide to cancel payment and return to your website.
A short description to be displayed on the Tazapay hosted checkout screen
ID of the customer for the checkout session
Specify the payment methods you want displayed for the session. If you do not specify, the default payment methods for the country are displayed to the customer
Specify the payment methods you want removed for the session
Shipping details including recipient name, address and phone
Show child attributes
Show child attributes
Billing details including name, address and phone
Show child attributes
Show child attributes
The time at which the checkout session is scheduled to expire. If expired using the expire api, this will contain the time that the checkout session expired at
Supporting documents for the transaction
Set of key-value pairs that can be attached to the object (JSON string format)
Example:
"{\"key1\": \"value1\", \"key2\": \"value2\"}"
Your unique identifier for the session
An integer between 0 and 100. Percentage of processing fee to be paid by the customer. Tazapay will charge the customer an amount inclusive of the processing fee
List of items in the invoice
Show child attributes
Show child attributes
ID of the entity on whose behalf the checkout session is being created. The entity must belong to the merchant account. Format: ent_*
Was this page helpful?
⌘I