Skip to main content
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": "[email protected]",
    "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"
}
'
{
  "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": "[email protected]",
      "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

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
invoice_currency
string
required

Invoice currency for the checkout session (in uppercase, iso-4217 standard). By default, the invoice currency is the holding currency for the transaction.

​
amount
integer<int32>
required

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

​
customer_details
object
required

Details about the customer

​
success_url
string
required

URL where the customer is directed to after a successful payment

​
cancel_url
string
required

The URL the customer will be directed to if they decide to cancel payment and return to your website.

​
transaction_description
string
required

A short description to be displayed on the Tazapay hosted checkout screen

​
customer
string

ID of the customer for the checkout session

​
payment_methods
string[]

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

​
remove_payment_methods
string[]

Specify the payment methods you want removed for the session

​
shipping_details
object

Shipping Details - Address, Recipient Name

​
billing_details
object

Billing Details - Address, Recipient Name

​
expires_at
string<date-time>

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

​
transaction_documents
string<json>

Supporting documents for the transaction

​
metadata
string<json>

Set of key-value pairs that can be attached to the checkout session

​
reference_id
string

Your unique identifier for the session

​
customer_fee_percentage
integer<int32>

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

​
items
object[]

List of items in the invoice

​
session_id
string

Session ID retrieved from the risk SDK

Response

200 - application/json

200

​
status
string

Indicates the status of the API response.

​
message
string

Describes the result of the checkout session creation.

​
data
object

Contains all details related to the created checkout session.