サブスクリプション作成API

サブスクリプション支払いを処理

curl --request POST \
  --url https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": "1000",
  "currency": "JPY",
  "card": {
    "cvc": "112",
    "expiry_month": "12",
    "expiry_year": "29",
    "name": "John Doe",
    "number": "4000000000001091"
  },
  "payment_method": {
    "type": "scheme",
    "store_payment_method": false
  },
  "merchant_id": "< Merchant ID >",
  "billing_address": {
    "country": "JP",
    "email": "billing@testemail.com",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "postal_code": "1600022",
    "state": "Tokyo"
  },
  "subscription": {
    "plan_name": "Three weeks plan",
    "plan_desc": "Billed every two days",
    "cycle_type": "DAYS",
    "subscription_end_type": "CYCLE",
    "cycle_interval": 2,
    "max_cycle_count": 10,
    "has_trial_period": false,
    "has_discount": true,
    "discount_percentage": 10,
    "discount_duration": 2,
    "trial_period_duration_type": "DAYS",
    "trial_period_duration": 14
  },
  "merchant_txn_ref": "qwe",
  "customer_ip": "127.0.0.1",
  "return_url": {
    "webhook_url": "< Webhook url >",
    "success_url": "http://www.successurl.com/",
    "decline_url": "http://www.declineurl.com/"
  },
  "shipping_address": {
    "country": "JP",
    "email": "billing@testemail.com",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "state": "Tokyo",
    "postal_code": "1600022"
  },
  "time_zone": "Asia/Kuala_Lumpur"
}
'

import requests

url = "https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment"

payload = {
    "amount": "1000",
    "currency": "JPY",
    "card": {
        "cvc": "112",
        "expiry_month": "12",
        "expiry_year": "29",
        "name": "John Doe",
        "number": "4000000000001091"
    },
    "payment_method": {
        "type": "scheme",
        "store_payment_method": False
    },
    "merchant_id": "< Merchant ID >",
    "billing_address": {
        "country": "JP",
        "email": "billing@testemail.com",
        "phone_number": "8112345678",
        "address1": "1-2-3 Shinjuku",
        "city": "Shinjuku-ku",
        "postal_code": "1600022",
        "state": "Tokyo"
    },
    "subscription": {
        "plan_name": "Three weeks plan",
        "plan_desc": "Billed every two days",
        "cycle_type": "DAYS",
        "subscription_end_type": "CYCLE",
        "cycle_interval": 2,
        "max_cycle_count": 10,
        "has_trial_period": False,
        "has_discount": True,
        "discount_percentage": 10,
        "discount_duration": 2,
        "trial_period_duration_type": "DAYS",
        "trial_period_duration": 14
    },
    "merchant_txn_ref": "qwe",
    "customer_ip": "127.0.0.1",
    "return_url": {
        "webhook_url": "< Webhook url >",
        "success_url": "http://www.successurl.com/",
        "decline_url": "http://www.declineurl.com/"
    },
    "shipping_address": {
        "country": "JP",
        "email": "billing@testemail.com",
        "phone_number": "8112345678",
        "address1": "1-2-3 Shinjuku",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
    },
    "time_zone": "Asia/Kuala_Lumpur"
}
headers = {
    "Authorization": "<api-key>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '1000',
    currency: 'JPY',
    card: {
      cvc: '112',
      expiry_month: '12',
      expiry_year: '29',
      name: 'John Doe',
      number: '4000000000001091'
    },
    payment_method: {type: 'scheme', store_payment_method: false},
    merchant_id: '< Merchant ID >',
    billing_address: {
      country: 'JP',
      email: 'billing@testemail.com',
      phone_number: '8112345678',
      address1: '1-2-3 Shinjuku',
      city: 'Shinjuku-ku',
      postal_code: '1600022',
      state: 'Tokyo'
    },
    subscription: {
      plan_name: 'Three weeks plan',
      plan_desc: 'Billed every two days',
      cycle_type: 'DAYS',
      subscription_end_type: 'CYCLE',
      cycle_interval: 2,
      max_cycle_count: 10,
      has_trial_period: false,
      has_discount: true,
      discount_percentage: 10,
      discount_duration: 2,
      trial_period_duration_type: 'DAYS',
      trial_period_duration: 14
    },
    merchant_txn_ref: 'qwe',
    customer_ip: '127.0.0.1',
    return_url: {
      webhook_url: '< Webhook url >',
      success_url: 'http://www.successurl.com/',
      decline_url: 'http://www.declineurl.com/'
    },
    shipping_address: {
      country: 'JP',
      email: 'billing@testemail.com',
      phone_number: '8112345678',
      address1: '1-2-3 Shinjuku',
      city: 'Shinjuku-ku',
      state: 'Tokyo',
      postal_code: '1600022'
    },
    time_zone: 'Asia/Kuala_Lumpur'
  })
};

fetch('https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment', 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://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment",
  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([
    'amount' => '1000',
    'currency' => 'JPY',
    'card' => [
        'cvc' => '112',
        'expiry_month' => '12',
        'expiry_year' => '29',
        'name' => 'John Doe',
        'number' => '4000000000001091'
    ],
    'payment_method' => [
        'type' => 'scheme',
        'store_payment_method' => false
    ],
    'merchant_id' => '< Merchant ID >',
    'billing_address' => [
        'country' => 'JP',
        'email' => 'billing@testemail.com',
        'phone_number' => '8112345678',
        'address1' => '1-2-3 Shinjuku',
        'city' => 'Shinjuku-ku',
        'postal_code' => '1600022',
        'state' => 'Tokyo'
    ],
    'subscription' => [
        'plan_name' => 'Three weeks plan',
        'plan_desc' => 'Billed every two days',
        'cycle_type' => 'DAYS',
        'subscription_end_type' => 'CYCLE',
        'cycle_interval' => 2,
        'max_cycle_count' => 10,
        'has_trial_period' => false,
        'has_discount' => true,
        'discount_percentage' => 10,
        'discount_duration' => 2,
        'trial_period_duration_type' => 'DAYS',
        'trial_period_duration' => 14
    ],
    'merchant_txn_ref' => 'qwe',
    'customer_ip' => '127.0.0.1',
    'return_url' => [
        'webhook_url' => '< Webhook url >',
        'success_url' => 'http://www.successurl.com/',
        'decline_url' => 'http://www.declineurl.com/'
    ],
    'shipping_address' => [
        'country' => 'JP',
        'email' => 'billing@testemail.com',
        'phone_number' => '8112345678',
        'address1' => '1-2-3 Shinjuku',
        'city' => 'Shinjuku-ku',
        'state' => 'Tokyo',
        'postal_code' => '1600022'
    ],
    'time_zone' => 'Asia/Kuala_Lumpur'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment"

	payload := strings.NewReader("{\n  \"amount\": \"1000\",\n  \"currency\": \"JPY\",\n  \"card\": {\n    \"cvc\": \"112\",\n    \"expiry_month\": \"12\",\n    \"expiry_year\": \"29\",\n    \"name\": \"John Doe\",\n    \"number\": \"4000000000001091\"\n  },\n  \"payment_method\": {\n    \"type\": \"scheme\",\n    \"store_payment_method\": false\n  },\n  \"merchant_id\": \"< Merchant ID >\",\n  \"billing_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"postal_code\": \"1600022\",\n    \"state\": \"Tokyo\"\n  },\n  \"subscription\": {\n    \"plan_name\": \"Three weeks plan\",\n    \"plan_desc\": \"Billed every two days\",\n    \"cycle_type\": \"DAYS\",\n    \"subscription_end_type\": \"CYCLE\",\n    \"cycle_interval\": 2,\n    \"max_cycle_count\": 10,\n    \"has_trial_period\": false,\n    \"has_discount\": true,\n    \"discount_percentage\": 10,\n    \"discount_duration\": 2,\n    \"trial_period_duration_type\": \"DAYS\",\n    \"trial_period_duration\": 14\n  },\n  \"merchant_txn_ref\": \"qwe\",\n  \"customer_ip\": \"127.0.0.1\",\n  \"return_url\": {\n    \"webhook_url\": \"< Webhook url >\",\n    \"success_url\": \"http://www.successurl.com/\",\n    \"decline_url\": \"http://www.declineurl.com/\"\n  },\n  \"shipping_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"state\": \"Tokyo\",\n    \"postal_code\": \"1600022\"\n  },\n  \"time_zone\": \"Asia/Kuala_Lumpur\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("x-api-key", "<api-key>")
	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://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment")
  .header("Authorization", "<api-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"1000\",\n  \"currency\": \"JPY\",\n  \"card\": {\n    \"cvc\": \"112\",\n    \"expiry_month\": \"12\",\n    \"expiry_year\": \"29\",\n    \"name\": \"John Doe\",\n    \"number\": \"4000000000001091\"\n  },\n  \"payment_method\": {\n    \"type\": \"scheme\",\n    \"store_payment_method\": false\n  },\n  \"merchant_id\": \"< Merchant ID >\",\n  \"billing_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"postal_code\": \"1600022\",\n    \"state\": \"Tokyo\"\n  },\n  \"subscription\": {\n    \"plan_name\": \"Three weeks plan\",\n    \"plan_desc\": \"Billed every two days\",\n    \"cycle_type\": \"DAYS\",\n    \"subscription_end_type\": \"CYCLE\",\n    \"cycle_interval\": 2,\n    \"max_cycle_count\": 10,\n    \"has_trial_period\": false,\n    \"has_discount\": true,\n    \"discount_percentage\": 10,\n    \"discount_duration\": 2,\n    \"trial_period_duration_type\": \"DAYS\",\n    \"trial_period_duration\": 14\n  },\n  \"merchant_txn_ref\": \"qwe\",\n  \"customer_ip\": \"127.0.0.1\",\n  \"return_url\": {\n    \"webhook_url\": \"< Webhook url >\",\n    \"success_url\": \"http://www.successurl.com/\",\n    \"decline_url\": \"http://www.declineurl.com/\"\n  },\n  \"shipping_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"state\": \"Tokyo\",\n    \"postal_code\": \"1600022\"\n  },\n  \"time_zone\": \"Asia/Kuala_Lumpur\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"1000\",\n  \"currency\": \"JPY\",\n  \"card\": {\n    \"cvc\": \"112\",\n    \"expiry_month\": \"12\",\n    \"expiry_year\": \"29\",\n    \"name\": \"John Doe\",\n    \"number\": \"4000000000001091\"\n  },\n  \"payment_method\": {\n    \"type\": \"scheme\",\n    \"store_payment_method\": false\n  },\n  \"merchant_id\": \"< Merchant ID >\",\n  \"billing_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"postal_code\": \"1600022\",\n    \"state\": \"Tokyo\"\n  },\n  \"subscription\": {\n    \"plan_name\": \"Three weeks plan\",\n    \"plan_desc\": \"Billed every two days\",\n    \"cycle_type\": \"DAYS\",\n    \"subscription_end_type\": \"CYCLE\",\n    \"cycle_interval\": 2,\n    \"max_cycle_count\": 10,\n    \"has_trial_period\": false,\n    \"has_discount\": true,\n    \"discount_percentage\": 10,\n    \"discount_duration\": 2,\n    \"trial_period_duration_type\": \"DAYS\",\n    \"trial_period_duration\": 14\n  },\n  \"merchant_txn_ref\": \"qwe\",\n  \"customer_ip\": \"127.0.0.1\",\n  \"return_url\": {\n    \"webhook_url\": \"< Webhook url >\",\n    \"success_url\": \"http://www.successurl.com/\",\n    \"decline_url\": \"http://www.declineurl.com/\"\n  },\n  \"shipping_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"state\": \"Tokyo\",\n    \"postal_code\": \"1600022\"\n  },\n  \"time_zone\": \"Asia/Kuala_Lumpur\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "status_code": 201,
  "is_live": false,
  "transaction_type": "CAPTURE",
  "gateway_response": {
    "version": "1",
    "type": "INFO",
    "message": "Payment Successful.",
    "code": "INFO0000"
  },
  "merchant_details": {
    "legal_name": "Beck's Coffee Shop Pvt. Ltd.",
    "mid": "JP00000472",
    "merchant_txn_ref": "qwe",
    "billing_details": {
      "billing_address": {
        "country": "JP",
        "email": "billing@testemail.com",
        "phone_number": "8112345678",
        "address1": "1-2-3 Shinjuku",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
      },
      "shipping_address": {
        "country": "JP",
        "email": "billing@testemail.com",
        "phone_number": "8112345678",
        "address1": "1-2-3 Shinjuku",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
      }
    },
    "device_details": {
      "visited_ip": "127.0.0.1",
      "merchant_ip": "127.0.0.1",
      "customer_ip": "127.0.0.1"
    }
  },
  "payment_details": {
    "amount": 900,
    "response_code": 0,
    "auth_code": "175438",
    "currency": "JPY",
    "payment_method": "VISA_DEBIT-SSL",
    "scheme": "VISA",
    "card": {
      "name": "John Doe",
      "number": "4000000000001091",
      "exp_month": "12",
      "exp_year": "29"
    },
    "additional_data": {
      "payment_data_source": {
        "type": "card"
      }
    }
  },
  "transaction_details": {
    "id": "359f39bd-673a-47b3-b9ec-cbd6cd313b8e",
    "ref": 74860,
    "timestamp": "2024-11-26T01:31:29.000Z",
    "merchant_txn_ref": "qwe",
    "stored_payment_method_id": null
  },
  "risk-details": {
    "risk_score": null
  },
  "subscription_details": {
    "id": "664dc930-88bd-4696-8807-5e0f1fedba0b",
    "type": "CYCLE",
    "max_cycle_count": 10,
    "status": "ACTIVE",
    "completed_payment_cycle": 1,
    "next_payment_date": "2024-11-28T01:31:29.154Z",
    "next_payment_cycle": 2,
    "subscription_plan_details": {
      "name": "Three weeks plan",
      "desc": "Billed every two days",
      "billing_cycle_type": "DAYS",
      "billing_cycle_interval": 2,
      "amount": 1000,
      "ccy": "JPY",
      "trial_period_duration": "",
      "trial_period_duration_type": "NONE",
      "plan_discount_percentage": 10,
      "plan_discount_duration": 2
    }
  }
}

POST

api

server-to-server-interface

subscription

payment

サブスクリプション支払いを処理

curl --request POST \
  --url https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": "1000",
  "currency": "JPY",
  "card": {
    "cvc": "112",
    "expiry_month": "12",
    "expiry_year": "29",
    "name": "John Doe",
    "number": "4000000000001091"
  },
  "payment_method": {
    "type": "scheme",
    "store_payment_method": false
  },
  "merchant_id": "< Merchant ID >",
  "billing_address": {
    "country": "JP",
    "email": "billing@testemail.com",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "postal_code": "1600022",
    "state": "Tokyo"
  },
  "subscription": {
    "plan_name": "Three weeks plan",
    "plan_desc": "Billed every two days",
    "cycle_type": "DAYS",
    "subscription_end_type": "CYCLE",
    "cycle_interval": 2,
    "max_cycle_count": 10,
    "has_trial_period": false,
    "has_discount": true,
    "discount_percentage": 10,
    "discount_duration": 2,
    "trial_period_duration_type": "DAYS",
    "trial_period_duration": 14
  },
  "merchant_txn_ref": "qwe",
  "customer_ip": "127.0.0.1",
  "return_url": {
    "webhook_url": "< Webhook url >",
    "success_url": "http://www.successurl.com/",
    "decline_url": "http://www.declineurl.com/"
  },
  "shipping_address": {
    "country": "JP",
    "email": "billing@testemail.com",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "state": "Tokyo",
    "postal_code": "1600022"
  },
  "time_zone": "Asia/Kuala_Lumpur"
}
'

import requests

url = "https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment"

payload = {
    "amount": "1000",
    "currency": "JPY",
    "card": {
        "cvc": "112",
        "expiry_month": "12",
        "expiry_year": "29",
        "name": "John Doe",
        "number": "4000000000001091"
    },
    "payment_method": {
        "type": "scheme",
        "store_payment_method": False
    },
    "merchant_id": "< Merchant ID >",
    "billing_address": {
        "country": "JP",
        "email": "billing@testemail.com",
        "phone_number": "8112345678",
        "address1": "1-2-3 Shinjuku",
        "city": "Shinjuku-ku",
        "postal_code": "1600022",
        "state": "Tokyo"
    },
    "subscription": {
        "plan_name": "Three weeks plan",
        "plan_desc": "Billed every two days",
        "cycle_type": "DAYS",
        "subscription_end_type": "CYCLE",
        "cycle_interval": 2,
        "max_cycle_count": 10,
        "has_trial_period": False,
        "has_discount": True,
        "discount_percentage": 10,
        "discount_duration": 2,
        "trial_period_duration_type": "DAYS",
        "trial_period_duration": 14
    },
    "merchant_txn_ref": "qwe",
    "customer_ip": "127.0.0.1",
    "return_url": {
        "webhook_url": "< Webhook url >",
        "success_url": "http://www.successurl.com/",
        "decline_url": "http://www.declineurl.com/"
    },
    "shipping_address": {
        "country": "JP",
        "email": "billing@testemail.com",
        "phone_number": "8112345678",
        "address1": "1-2-3 Shinjuku",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
    },
    "time_zone": "Asia/Kuala_Lumpur"
}
headers = {
    "Authorization": "<api-key>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '1000',
    currency: 'JPY',
    card: {
      cvc: '112',
      expiry_month: '12',
      expiry_year: '29',
      name: 'John Doe',
      number: '4000000000001091'
    },
    payment_method: {type: 'scheme', store_payment_method: false},
    merchant_id: '< Merchant ID >',
    billing_address: {
      country: 'JP',
      email: 'billing@testemail.com',
      phone_number: '8112345678',
      address1: '1-2-3 Shinjuku',
      city: 'Shinjuku-ku',
      postal_code: '1600022',
      state: 'Tokyo'
    },
    subscription: {
      plan_name: 'Three weeks plan',
      plan_desc: 'Billed every two days',
      cycle_type: 'DAYS',
      subscription_end_type: 'CYCLE',
      cycle_interval: 2,
      max_cycle_count: 10,
      has_trial_period: false,
      has_discount: true,
      discount_percentage: 10,
      discount_duration: 2,
      trial_period_duration_type: 'DAYS',
      trial_period_duration: 14
    },
    merchant_txn_ref: 'qwe',
    customer_ip: '127.0.0.1',
    return_url: {
      webhook_url: '< Webhook url >',
      success_url: 'http://www.successurl.com/',
      decline_url: 'http://www.declineurl.com/'
    },
    shipping_address: {
      country: 'JP',
      email: 'billing@testemail.com',
      phone_number: '8112345678',
      address1: '1-2-3 Shinjuku',
      city: 'Shinjuku-ku',
      state: 'Tokyo',
      postal_code: '1600022'
    },
    time_zone: 'Asia/Kuala_Lumpur'
  })
};

fetch('https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment', 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://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment",
  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([
    'amount' => '1000',
    'currency' => 'JPY',
    'card' => [
        'cvc' => '112',
        'expiry_month' => '12',
        'expiry_year' => '29',
        'name' => 'John Doe',
        'number' => '4000000000001091'
    ],
    'payment_method' => [
        'type' => 'scheme',
        'store_payment_method' => false
    ],
    'merchant_id' => '< Merchant ID >',
    'billing_address' => [
        'country' => 'JP',
        'email' => 'billing@testemail.com',
        'phone_number' => '8112345678',
        'address1' => '1-2-3 Shinjuku',
        'city' => 'Shinjuku-ku',
        'postal_code' => '1600022',
        'state' => 'Tokyo'
    ],
    'subscription' => [
        'plan_name' => 'Three weeks plan',
        'plan_desc' => 'Billed every two days',
        'cycle_type' => 'DAYS',
        'subscription_end_type' => 'CYCLE',
        'cycle_interval' => 2,
        'max_cycle_count' => 10,
        'has_trial_period' => false,
        'has_discount' => true,
        'discount_percentage' => 10,
        'discount_duration' => 2,
        'trial_period_duration_type' => 'DAYS',
        'trial_period_duration' => 14
    ],
    'merchant_txn_ref' => 'qwe',
    'customer_ip' => '127.0.0.1',
    'return_url' => [
        'webhook_url' => '< Webhook url >',
        'success_url' => 'http://www.successurl.com/',
        'decline_url' => 'http://www.declineurl.com/'
    ],
    'shipping_address' => [
        'country' => 'JP',
        'email' => 'billing@testemail.com',
        'phone_number' => '8112345678',
        'address1' => '1-2-3 Shinjuku',
        'city' => 'Shinjuku-ku',
        'state' => 'Tokyo',
        'postal_code' => '1600022'
    ],
    'time_zone' => 'Asia/Kuala_Lumpur'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment"

	payload := strings.NewReader("{\n  \"amount\": \"1000\",\n  \"currency\": \"JPY\",\n  \"card\": {\n    \"cvc\": \"112\",\n    \"expiry_month\": \"12\",\n    \"expiry_year\": \"29\",\n    \"name\": \"John Doe\",\n    \"number\": \"4000000000001091\"\n  },\n  \"payment_method\": {\n    \"type\": \"scheme\",\n    \"store_payment_method\": false\n  },\n  \"merchant_id\": \"< Merchant ID >\",\n  \"billing_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"postal_code\": \"1600022\",\n    \"state\": \"Tokyo\"\n  },\n  \"subscription\": {\n    \"plan_name\": \"Three weeks plan\",\n    \"plan_desc\": \"Billed every two days\",\n    \"cycle_type\": \"DAYS\",\n    \"subscription_end_type\": \"CYCLE\",\n    \"cycle_interval\": 2,\n    \"max_cycle_count\": 10,\n    \"has_trial_period\": false,\n    \"has_discount\": true,\n    \"discount_percentage\": 10,\n    \"discount_duration\": 2,\n    \"trial_period_duration_type\": \"DAYS\",\n    \"trial_period_duration\": 14\n  },\n  \"merchant_txn_ref\": \"qwe\",\n  \"customer_ip\": \"127.0.0.1\",\n  \"return_url\": {\n    \"webhook_url\": \"< Webhook url >\",\n    \"success_url\": \"http://www.successurl.com/\",\n    \"decline_url\": \"http://www.declineurl.com/\"\n  },\n  \"shipping_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"state\": \"Tokyo\",\n    \"postal_code\": \"1600022\"\n  },\n  \"time_zone\": \"Asia/Kuala_Lumpur\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("x-api-key", "<api-key>")
	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://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment")
  .header("Authorization", "<api-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"1000\",\n  \"currency\": \"JPY\",\n  \"card\": {\n    \"cvc\": \"112\",\n    \"expiry_month\": \"12\",\n    \"expiry_year\": \"29\",\n    \"name\": \"John Doe\",\n    \"number\": \"4000000000001091\"\n  },\n  \"payment_method\": {\n    \"type\": \"scheme\",\n    \"store_payment_method\": false\n  },\n  \"merchant_id\": \"< Merchant ID >\",\n  \"billing_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"postal_code\": \"1600022\",\n    \"state\": \"Tokyo\"\n  },\n  \"subscription\": {\n    \"plan_name\": \"Three weeks plan\",\n    \"plan_desc\": \"Billed every two days\",\n    \"cycle_type\": \"DAYS\",\n    \"subscription_end_type\": \"CYCLE\",\n    \"cycle_interval\": 2,\n    \"max_cycle_count\": 10,\n    \"has_trial_period\": false,\n    \"has_discount\": true,\n    \"discount_percentage\": 10,\n    \"discount_duration\": 2,\n    \"trial_period_duration_type\": \"DAYS\",\n    \"trial_period_duration\": 14\n  },\n  \"merchant_txn_ref\": \"qwe\",\n  \"customer_ip\": \"127.0.0.1\",\n  \"return_url\": {\n    \"webhook_url\": \"< Webhook url >\",\n    \"success_url\": \"http://www.successurl.com/\",\n    \"decline_url\": \"http://www.declineurl.com/\"\n  },\n  \"shipping_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"state\": \"Tokyo\",\n    \"postal_code\": \"1600022\"\n  },\n  \"time_zone\": \"Asia/Kuala_Lumpur\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/payment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"1000\",\n  \"currency\": \"JPY\",\n  \"card\": {\n    \"cvc\": \"112\",\n    \"expiry_month\": \"12\",\n    \"expiry_year\": \"29\",\n    \"name\": \"John Doe\",\n    \"number\": \"4000000000001091\"\n  },\n  \"payment_method\": {\n    \"type\": \"scheme\",\n    \"store_payment_method\": false\n  },\n  \"merchant_id\": \"< Merchant ID >\",\n  \"billing_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"postal_code\": \"1600022\",\n    \"state\": \"Tokyo\"\n  },\n  \"subscription\": {\n    \"plan_name\": \"Three weeks plan\",\n    \"plan_desc\": \"Billed every two days\",\n    \"cycle_type\": \"DAYS\",\n    \"subscription_end_type\": \"CYCLE\",\n    \"cycle_interval\": 2,\n    \"max_cycle_count\": 10,\n    \"has_trial_period\": false,\n    \"has_discount\": true,\n    \"discount_percentage\": 10,\n    \"discount_duration\": 2,\n    \"trial_period_duration_type\": \"DAYS\",\n    \"trial_period_duration\": 14\n  },\n  \"merchant_txn_ref\": \"qwe\",\n  \"customer_ip\": \"127.0.0.1\",\n  \"return_url\": {\n    \"webhook_url\": \"< Webhook url >\",\n    \"success_url\": \"http://www.successurl.com/\",\n    \"decline_url\": \"http://www.declineurl.com/\"\n  },\n  \"shipping_address\": {\n    \"country\": \"JP\",\n    \"email\": \"billing@testemail.com\",\n    \"phone_number\": \"8112345678\",\n    \"address1\": \"1-2-3 Shinjuku\",\n    \"city\": \"Shinjuku-ku\",\n    \"state\": \"Tokyo\",\n    \"postal_code\": \"1600022\"\n  },\n  \"time_zone\": \"Asia/Kuala_Lumpur\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "status_code": 201,
  "is_live": false,
  "transaction_type": "CAPTURE",
  "gateway_response": {
    "version": "1",
    "type": "INFO",
    "message": "Payment Successful.",
    "code": "INFO0000"
  },
  "merchant_details": {
    "legal_name": "Beck's Coffee Shop Pvt. Ltd.",
    "mid": "JP00000472",
    "merchant_txn_ref": "qwe",
    "billing_details": {
      "billing_address": {
        "country": "JP",
        "email": "billing@testemail.com",
        "phone_number": "8112345678",
        "address1": "1-2-3 Shinjuku",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
      },
      "shipping_address": {
        "country": "JP",
        "email": "billing@testemail.com",
        "phone_number": "8112345678",
        "address1": "1-2-3 Shinjuku",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
      }
    },
    "device_details": {
      "visited_ip": "127.0.0.1",
      "merchant_ip": "127.0.0.1",
      "customer_ip": "127.0.0.1"
    }
  },
  "payment_details": {
    "amount": 900,
    "response_code": 0,
    "auth_code": "175438",
    "currency": "JPY",
    "payment_method": "VISA_DEBIT-SSL",
    "scheme": "VISA",
    "card": {
      "name": "John Doe",
      "number": "4000000000001091",
      "exp_month": "12",
      "exp_year": "29"
    },
    "additional_data": {
      "payment_data_source": {
        "type": "card"
      }
    }
  },
  "transaction_details": {
    "id": "359f39bd-673a-47b3-b9ec-cbd6cd313b8e",
    "ref": 74860,
    "timestamp": "2024-11-26T01:31:29.000Z",
    "merchant_txn_ref": "qwe",
    "stored_payment_method_id": null
  },
  "risk-details": {
    "risk_score": null
  },
  "subscription_details": {
    "id": "664dc930-88bd-4696-8807-5e0f1fedba0b",
    "type": "CYCLE",
    "max_cycle_count": 10,
    "status": "ACTIVE",
    "completed_payment_cycle": 1,
    "next_payment_date": "2024-11-28T01:31:29.154Z",
    "next_payment_cycle": 2,
    "subscription_plan_details": {
      "name": "Three weeks plan",
      "desc": "Billed every two days",
      "billing_cycle_type": "DAYS",
      "billing_cycle_interval": 2,
      "amount": 1000,
      "ccy": "JPY",
      "trial_period_duration": "",
      "trial_period_duration_type": "NONE",
      "plan_discount_percentage": 10,
      "plan_discount_duration": 2
    }
  }
}

サブスクリプション作成のリクエスト例

"subscription": {
        "plan_name": "<string>",
        "plan_desc": "<string>",
        "cycle_type": "<DAYS/WEEKLY/MONTHLY>",
        "subscription_end_type": "CYCLE",
        "cycle_interval": <int>,
        "max_cycle_count": <int>,
        "has_trial_period": <boolean>,
        "trial_period_duration_type": "DAYS",
        "trial_period_duration": <int>,
        "has_discount": <boolean>,
        "discount_percentage": <int>,
        "discount_duration": <int>
    }

重要なポイント

サブスクリプション作成

このAPIは、サブスクリプションプランの設定を可能にし、自動的な定期支払いを提供します。さまざまな請求サイクルや割引、試用期間などの柔軟な設定をサポートしています。

サブスクリプション設定

加盟店は、カスタムプランを定義できます。これには、プラン名と説明が含まれます。
サイクルタイプ：請求は日、週、月などに基づいて行えます。
サイクル間隔：請求の頻度を定義します（例：2日ごと、毎月）。
最大サイクル数：請求サイクルの最大数を設定します。
試用期間：サブスクリプション開始前に試用期間を提供するオプション。
割引：定められた請求サイクル数に対して割引を適用する機能。

フローダイアグラム

APIパラメータ

承認

Authorization

string

header

必須

認証用のAPIキー。フォーマット：「Basic YOUR_API_KEY_HERE」

x-api-key

string

header

必須

x-api-key専用のAPIキー。

ボディ

application/json

サブスクリプション支払いを処理するためのペイロード。

amount

string

必須

取引金額。

Maximum string length: 15

例:

"1000"

currency

string

必須

取引のISO通貨コード（例：JPY）。

Maximum string length: 3

例:

"JPY"

card

object

必須

支払いに使用するカードの詳細。

Show child attributes

payment_method

object

必須

決済方法の詳細。

Show child attributes

merchant_id

string

必須

加盟店の一意識別子。

Maximum string length: 128

例:

"< Merchant ID >"

billing_address

object

必須

カード所有者の請求先住所の詳細。

Show child attributes

subscription

object

必須

処理されるサブスクリプションの詳細。

Show child attributes

merchant_txn_ref

string

一意の決済取引参照ID。

Maximum string length: 45

例:

"qwe"

customer_ip

string

取引を開始した顧客のIPアドレス。

Maximum string length: 45

例:

"127.0.0.1"

return_url

object

リターンURLを含むJSONオブジェクト。（3DS取引では必須）

Show child attributes

shipping_address

object

カード所有者の配送先住所の詳細。

Show child attributes

time_zone

string

取引のタイムゾーン。

Maximum string length: 128

例:

"Asia/Kuala_Lumpur"

レスポンス

201 - application/json

サブスクリプション支払いが正常に処理されました。

success

boolean

取引が成功したかどうかを示します。

例:

true

status_code

integer

取引のHTTPステータスコード。

例:

201

is_live

boolean

取引が本番環境のものかテスト環境のものかを示します。

例:

false

transaction_type

string

実行された取引の種類（例：CAPTURE）。

例:

"CAPTURE"

gateway_response

object

決済ゲートウェイからの応答。

Show child attributes

merchant_details

object

加盟店に関する詳細情報。

Show child attributes

payment_details

object

決済取引の詳細。

Show child attributes

transaction_details

object

取引の詳細。

Show child attributes

risk-details

object

リスク評価の詳細。

Show child attributes

subscription_details

object

サブスクリプションの詳細。

Show child attributes

トークン使用API サブスクリプションキャンセルAPI

⌘I

入門

APIエンドポイント

エラーとレスポンス

ウェブフック

サブスクリプション作成のリクエスト例

重要なポイント

サブスクリプション作成

サブスクリプション設定

フローダイアグラム

APIパラメータ

承認

ボディ

レスポンス

​サブスクリプション作成のリクエスト例

​重要なポイント

​サブスクリプション作成

​サブスクリプション設定

​フローダイアグラム

​APIパラメータ

承認

ボディ

レスポンス

サブスクリプション作成のリクエスト例

重要なポイント

サブスクリプション作成

サブスクリプション設定

フローダイアグラム

APIパラメータ