• Help & Support
• Sign up

Sessions

A session represents a single transaction that a customer can complete using a payment method of their choosing.

To create a Session, there are only 3 required parameters:

1. amount How much you are charging your customer
2. currency Currency in which you are charging your customer
3. return_url URL to send the customer when they are done with the session
   • When the customer completes their session, ?action=complete is appended
   • When the customer cancels their session, ?action=cancel is appended

curl -X POST https://komoju.com/api/v1/sessions \
  -u sk_123456: \
  -d "amount=8888" \
  -d "currency=JPY" \
  -d "return_url=https://example.com" 

var querystring = require('querystring');
var https = require('https');
var secret_key = 'sk_123456'
var auth = 'Basic ' + Buffer.from(secret_key + ':').toString('base64');
var post_data = querystring.stringify({
  'amount': '8888',
  'currency': 'JPY',
  'return_url': 'https://example.com'
});

var post_options = {
  host: 'komoju.com',
  port: '443',
  path: '/api/v1/sessions',
  method: 'POST',
  headers: {
    'Authorization': auth,
    'Content-Length': Buffer.byteLength(post_data)
  }
};

var post_req = https.request(post_options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function (chunk) {
        console.log(chunk);
    });
});

post_req.write(post_data);
post_req.end();

require 'uri'
require 'net/https'
require 'json'
require 'base64'
require 'pp'
uri = URI.parse('https://komoju.com/api/v1/sessions')
https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true
secret_key = 'sk_123456'
auth = Base64.encode64("#{secret_key}:")
headers = {
  'Content-Type' => 'application/json',
  'Authorization' => "Basic #{auth}"
}

body = {
  amount: "8888",
  currency: "JPY",
  return_url: "https://example.com"
}

res = https.post(
  uri.path,
  body.to_json,
  headers
)

puts res.body

{
  "id": "e9x5mvx3jkpkofzcg7umfael6",
  "resource": "session",
  "mode": "payment",
  "amount": 8888,
  "currency": "JPY",
  "payment": null,
  "session_url": "https://komoju.com/sessions/e9x5mvx3jkpkofzcg7umfael6",
  "return_url": "https://example.com",
  "default_locale": "ja",
  "payment_methods": [
    {
      "type": "credit_card"
    },
    {
      "type": "konbini",
      "brands": {
        "seven-eleven": "/images/konbini/seven-eleven.svg",
        "lawson": "/images/konbini/lawson.svg",
        "family-mart": "/images/konbini/family-mart.svg",
        "ministop": "/images/konbini/ministop.svg",
        "daily-yamazaki": "/images/konbini/daily-yamazaki.svg",
        "seicomart": "/images/konbini/seicomart.svg"
      }
    }
  ],
  "created_at": "2020-08-17T18:03:53.000+09:00",
  "cancelled_at": null,
  "completed_at": null,
  "status": "pending"
}

There's a lot going on in that session object, but for most cases you only need to worry about the session_url attribute. Send your customer to the session_url, and they'll be provided a secure form for entering their preferred payment details.

Sessions are very flexible. For example, you can limit the number of payment methods available for a session by passing payment_types, and you can retrieve information about a completed or abandoned session's progress by inspecting the status and payment attributes. See the sessions API reference for more.

Session Resource

Payment Resource

The Payment is the heart of KOMOJU. A payment represents a transfer of funds from a customer to you, the merchant. This object will appear on your session when it transfers to 'complete'.