PayLabo API Specification
API docs by Redocly

PayLabo API Reference (2.1.8)

License: PayLabo.net

パラメータの設定

フォーマット

・ボディ部のパラメータはJSON形式で記述してください。
・文字コード（キャラクターセット）はShift-JISを使用してください。
・利用可能な文字はパラメーターにより異なります。
・各APIのリクエストパラメーターの説明を確認してください。

リクエストの必須パラメーター

・requiredがついているパラメーターは必ず設定してください。

・購入者の電話番号など、加盟店様サイトで取得が難しい項目につきましても、できる限り設定するようお願いします。

リクエストの任意パラメーター

・各リクエスト,レスポンスにおいて任意項目の未設定項目がある場合は項目自体を削除してください。未設定項目に空文字（””）の設定をするとエラーとなります。 ・加盟店から当社へ送信するリクエストパラメータは順不同でも問題ありませんが、オブジェクト内の項目はそのオブジェクト外にすることはできません。

使用可能なデータ型の定義

APIで使用可能なデータ型は以下の通りです。

仕様書上の表示 データ型 使用可能文字 備考
string マルチバイト文字列 全角文字・半角文字
JIS第一・第二水準漢字		 項目により使用可能な文字が制限されている場合は、API仕様に従ってください。
integer<int64> 数字文字 0～9の半角数字 ピリオド、ハイフンなどの符号は許可しません。
object 構造体 － 複数の要素を含むオブジェクト項目です。

リクエストのHTTPヘッダー

HTTPヘッダーにはAPIリクエストにおける共通の内容を設定します。
以下のデータを送信してください。

項目 値
Content-type application/json
X-API-KEY 詳細は「APIのKey」の章を参照ください

APIのKEY情報

PayLaboは、加盟店に2種類のAPIキーを提供しています:非公開鍵と公開鍵。これらの鍵はAPIリクエストを行うために必要であり、M-Laboのアカウントの設定ページで確認することができます。

非公開鍵(X-API-KEY)

非公開鍵はすべてのAPIリソースへのアクセスを許可します。この鍵を持った者はアカウント上で様々なアクションを実行する可能性があるため、厳重に保管して外部に漏洩する事が無いようにしてください。非公開鍵はサーバーサイドに保管し、クライアントサイドのアプリケーションには絶対に公開しないようにしてください。

● 検証環境接続用(X-API-KEY)
検証環境のAPI接続に必要なHTTPヘッダーに指定するX-API-KEYは下記の値を設定してください。 下記以外の値を指定された場合は認証エラーとなります。

xxxxxxxx-8794-4658-a894-xxxxxxxxxxxx

● 本番環境接続用(X-API-KEY)
本番環境のAPI接続に必要なHTTPヘッダーに指定するX-API-KEYは、加盟店登録時に発行されます「パスワード発行票」をご確認いただき、記載されたアカウントからM-Laboにログインしていただくことにより、ご確認いただけます。

公開鍵(publishable-key)

非公開鍵とは異なり、公開鍵が対応するAPIリソースが限られています。PayLaboでは埋込型決済画面（ホストフィールド）をご利用頂く際に使用します。公開鍵は加盟店様にてポータルサイトの設定画面から生成し、ECサイト内に記述してください。

● 検証環境接続用(publishable-key)
検証環境のAPI接続に必要なpublishable-keyは下記の値を設定してください。

pk_test_gxpbhtj6CFNheiXjCsxwRlsEEftx

● 本番環境接続用(publishable-key)
本番環境のAPI接続に必要な公開鍵は、M-Laboの設定画面から生成してください。公開鍵は加盟店様での管理となります。定期的にShopサイト内の公開鍵を更新する事を推奨します。

リンク型決済画面（画面遷移）

オンライン決済のリンクタイプは、クレジットカード決済でのマルチデバイスに対応したシングルインターフェースを提供するシステム接続方式です。
決済手続きに必要な画面を当社が提供するため、簡単に導入できる方式です。

API処理の流れ

加盟店様のECサイトの画面遷移と、提供されるAPI機能をCALLする流れは以下の図の通りです。


処理名 流れ 説明
①注文情報登録 加盟店→当社 お客様の注文情報を決済サーバーに連携し、決済サーバーのユニークオーダーIDをレスポンスする。
②決済ページ呼び出し 加盟店→当社 ユニークオーダーIDをパラメータとして、決済画面にリダイレクトする。決済処理完了後、注文情報登録リクエストで指定されたURLに画面をリダイレクトする。
③決済処理結果の取得 加盟店→当社 決済処理結果をレスポンスする。

埋込型決済画面（ホストフィールド）

ホストフィールドは、加盟店のWebサイトの中にチェックアウト機能を埋め込む事で、クレジットカード情報を加盟店のサーバーを経由する事 無く、安全にクレジットカード支払いを行う事ができる、フロントエンドライブラリーです。HTML,VueJS,Reactなどのどの様なフロントエンド 環境でもお使い頂けます。

埋込型の決済画面は3種類用意されています。

■都度クレジット決済画面
■定期課金請求登録画面
■定期課金請求登録カード変更画面

都度クレジット決済画面

HTMLコードサンプル

HTML
<script type="module" src="https://etf.paylabo.net/script/payment-hosted-fields.js"></script>

<form>

  <etf-payment-fields
    uniqueOrderId={your uniqueOrderId}
    publishable-key={your publishable key}
    jpo=true
  ></etf-payment-fields>

  <hr width="400" size="10" noshade="">

  <button type="submit">申し込む</button>

</form>

要素の属性

<etf-payment-fields>
要素がサポートする属性は以下となります。

●uniqueOrderId（必須）

サーバーサイドで発行したユニークな注文IDです。
この属性を利用することで使用可能な支払方法等がわかります。
支払いの金額と通貨はサーバーサイドでハンドリングされるため安全です。

HTML
<etf-payment-fields
    uniqueOrderId=6shdwjnak7m1yb8mdznb8aei2
    publishable-key=pk_ult1lb46dn4qq222a3fkqi54
  ></etf-payment-fields>

●publishable-key（必須）

PayLabo APIを使うための認証キーです。

HTML
<etf-payment-fields
    uniqueOrderId=6shdwjnak7m1yb8mdznb8aei2
    publishable-key=pk_ult1lb46dn4qq222a3fkqi54
  ></etf-payment-fields>

●theme

この属性でホストフィールドのスタイルをカスタマイズできます。
ホストフィールドをより御社のサイトに馴染ませたい場合はCSSを使ってフィールドの見た目を変えることができます。
ホストフィールドをカスタマイズするには、<etf-payment-fields>のtheme属性にCSSファイルのURLを入れます。

HTML
<!-- Set custom CSS -->
<etf-payment-fields
  uniqueOrderId=6shdwjnak7m1yb8mdznb8aei2
  publishable-key=pk_ult1lb46dn4qq222a3fkqi54
  theme="https://example.com/my-fields-theme.css"
></etf-payment-fields>

●jpo

お支払い回数の指定の有無を指定できます。
お支払い回数の内容については、加盟店様の契約内容により異なります。

HTML
<!-- Set custom CSS -->
<etf-payment-fields
  uniqueOrderId=6shdwjnak7m1yb8mdznb8aei2
  publishable-key=pk_ult1lb46dn4qq222a3fkqi54
  theme="https://example.com/my-fields-theme.css"
  jpo=true
></etf-payment-fields>

画面イメージサンプル


定期課金請求登録画面

HTMLコードサンプル

HTML
<script type="module" src="https://etf.paylabo.net/script/recurring-hosted-fields.js"></script>

<form>

  <etf-payment-fields
    uniqueRecurringId={your uniqueRecurringId}
    publishable-key={your publishable key}
  ></etf-payment-fields>

  <hr width="400" size="10" noshade="">

  <button type="submit">申し込む</button>

</form>

要素の属性

<etf-payment-fields>
要素がサポートする属性は以下となります。

●uniqueRecurringId（必須）

サーバーサイドで発行したユニークな定期課金IDです。
この属性を利用することで使用可能な支払方法等がわかります。

HTML
<etf-payment-fields
    uniqueRecurringId=6shdwjnak7m1yb8mdznb8aei2
    publishable-key=pk_ult1lb46dn4qq222a3fkqi54
  ></etf-payment-fields>

●publishable-key（必須）

PayLabo APIを使うための認証キーです。

HTML
<etf-payment-fields
    uniqueRecurringId=6shdwjnak7m1yb8mdznb8aei2
    publishable-key=pk_ult1lb46dn4qq222a3fkqi54
  ></etf-payment-fields>

●theme

この属性でホストフィールドのスタイルをカスタマイズできます。
ホストフィールドをより御社のサイトに馴染ませたい場合はCSSを使ってフィールドの見た目を変えることができます。
ホストフィールドをカスタマイズするには、<etf-payment-fields>のtheme属性にCSSファイルのURLを入れます。

HTML
<!-- Set custom CSS -->
<etf-payment-fields
  uniqueRecurringId=6shdwjnak7m1yb8mdznb8aei2
  publishable-key=pk_ult1lb46dn4qq222a3fkqi54
  theme="https://example.com/my-fields-theme.css"
></etf-payment-fields>

画面イメージサンプル


定期課金請求登録カード変更画面

HTMLコードサンプル

HTML
<script type="module" src="https://etf.paylabo.net/script/card-update.js"></script>

<form>

  <etf-payment-fields
    uniqueRecurringId={your uniqueRecurringId}
    publishable-key={your publishable key}
    return-url={your result screen URL}
  ></etf-payment-fields>

  <hr width="400" size="10" noshade="">

  <button type="submit">申し込む</button>

</form>

要素の属性

<etf-payment-fields>
要素がサポートする属性は以下となります。

●uniqueRecurringId（必須）

サーバーサイドで発行したユニークな定期課金IDです。
この属性を利用することで使用可能な支払方法等がわかります。

HTML
<etf-payment-fields
    uniqueRecurringId=6shdwjnak7m1yb8mdznb8aei2
    publishable-key=pk_ult1lb46dn4qq222a3fkqi54
    return-url=https://shopsite.jp/cardupdate/result
  ></etf-payment-fields>

●publishable-key（必須）

PayLabo APIを使うための認証キーです。

HTML
<etf-payment-fields
    uniqueRecurringId=6shdwjnak7m1yb8mdznb8aei2
    publishable-key=pk_ult1lb46dn4qq222a3fkqi54
    return-url=https://shopsite.jp/cardupdate/result
  ></etf-payment-fields>

●return-url（必須）

カード情報を更新した結果をレスポンスする画面のURLを指定します。

HTML
<etf-payment-fields
    uniqueRecurringId=6shdwjnak7m1yb8mdznb8aei2
    publishable-key=pk_ult1lb46dn4qq222a3fkqi54
    return-url=https://shopsite.jp/cardupdate/result
  ></etf-payment-fields>

●theme

この属性でホストフィールドのスタイルをカスタマイズできます。
ホストフィールドをより御社のサイトに馴染ませたい場合はCSSを使ってフィールドの見た目を変えることができます。
ホストフィールドをカスタマイズするには、<etf-payment-fields>のtheme属性にCSSファイルのURLを入れます。

HTML
<!-- Set custom CSS -->
<etf-payment-fields
  uniqueRecurringId=6shdwjnak7m1yb8mdznb8aei2
  publishable-key=pk_ult1lb46dn4qq222a3fkqi54
  return-url=https://shopsite.jp/cardupdate/result
  theme="https://example.com/my-fields-theme.css"
></etf-payment-fields>

画面イメージサンプル


API処理の流れ

加盟店様のECサイトの画面遷移と、提供されるAPI機能をCALLする流れは以下の図の通りです。


処理名 流れ 説明
①注文情報登録 加盟店→当社 お客様の注文情報を決済サーバーに連携し、決済サーバーより定期課金ユニークIDをレスポンスする。
②決済ページ呼び出し 加盟店→当社 Shopサイトの支払画面内に実装したJavaScriptの要素に定期課金ユニークIDを設定し、JavaScriptをロードすると決済画面が画面内に表示される。クレジット情報を画面から入力し、当社サーバーへSubMitすると、注文情報登録リクエストで指定されたURLに画面をリダイレクトする。
③決済処理結果の取得 加盟店→当社 決済処理結果をレスポンスする。

order

決済登録

新しい注文情報の生成
POST /api/v1/order/register

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

このAPIは、加盟店様のサイトからお客様の注文情報を登録し、レスポンスとしてユニークオーダーIDを返却します。

注文情報の登録に成功したら、加盟店様のサイトはレスポンスされたユニークオーダーIDをパラメータとして、決済画面をCALLします。

orderId
required
string [ 12 .. 23 ] characters

オーダーID

Shop内で一意となるオーダー単位のIDを指定
12桁以上23桁以下で、全て必ず数字としてください

description
string <= 64 characters

商品説明

決済画面に表示される簡易的な商品名や品目など
最大64バイト

itemamount
integer <int64>

商品金額（税込）

商品の単価
小数点、カンマは指定しないでください

shippingfee
integer <int64>

送料（税込）

商品の送料がある場合に指定
小数点、カンマは指定しないでください

amount
required
integer <int64>

取引金額（税込）

商品金額+送料などの決済金額
小数点、カンマは指定しないでください

processes
required
string <= 1 characters

決済処理区分

即時売上か出荷後売上かを指定
'1' : 出荷後売上 '2' : 即時売上

object (Merchant)

加盟店情報

object (Customer)

支払者情報

object (Emv)

EMV情報

Responses

Request samples

Content type
application/json
{
  • "orderId": "12345678901234567890123",
  • "description": "ご購入商品代",
  • "itemamount": 10000,
  • "shippingfee": 800,
  • "amount": 10800,
  • "processes": 1,
  • "merchant": {},
  • "customer": {
    },
  • "emvinfo": {
    }
}

Response samples

Content type
application/json
{
  • "uniqueOrderId": "550e8400e29b41d4a716446655440000",
  • "orderId": "12345678901234567890123"
}

payment

クレジット決済ページ

顧客がECサイトのショッピングカート内容を確認し、'決済ボタン'等を押下する事で、クレジット決済画面に遷移します。
'決済ボタン'の処理としてこのURLをCALLしてください。
このURLのパラメータには、'Order'APIでレスポンスされた'UniqueOrderId'を指定してください。
'Order'APIで登録した注文情報と共に、カード情報を入力する為の決済画面が表示されます。
URL /payment?{UniqueOrderId}

Authorizations:
ApiKeyAuth
query Parameters
uniqueOrderId
required
string
Example: uniqueOrderId=550e8400e29b41d4a716446655440000

'Order'のAPIで取得したユニークオーダーID

Responses

決済処理結果取得

決済処理の結果情報を取得します。
POST /api/v1/payment/confirmation

Authorizations:
ApiKeyAuth
Request Body schema: application/json
uniqueOrderId
required
string

OrderのAPIで取得したユニークオーダーID

Responses

Request samples

Content type
application/json
{
  • "uniqueOrderId": "550e8400e29b41d4a716446655440000"
}

Response samples

Content type
application/json
{
  • "orderId": "12345678901234567890123",
  • "status": "completed",
  • "payment": {
    }
}

決済情報一覧取得

決済処理された取引情報の一覧を取得します。
POST /api/v1/payment/list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
orderId
string [ 12 .. 23 ] characters

オーダーID

Shop内で一意となるオーダー単位のIDを指定
12桁以上23桁以下で、全て必ず数字としてください
部分一致検索も可能です

paymentTypeStatus
string <= 1 characters

取引状態

'1' : オーソリ
'2' : 売上確定
'3' : 精算
'4' : キャンセル

transactionType
string <= 1 characters

取引タイプ

'1' : 都度請求
'2' : 定期課金登録
'3' : 定期課金請求

authDatetimeFrom
string

取引日時の範囲指定の始値

YYYYMMDDHHmm 形式

authDatetimeTo
string

取引日時の範囲指定の終値

YYYYMMDDHHmm 形式

processingDateFrom
string

処理日時の範囲指定の始値

YYYYMMDDHHmm 形式

processingDateTo
string

処理日時の範囲指定の終値

YYYYMMDDHHmm 形式

transactionAmountFrom
integer <int64>

取引金額の範囲指定の始値

小数点、カンマ無し

transactionAmountTo
integer <int64>

取引金額の範囲指定の終値

小数点、カンマ無し

memberId
string <= 64 characters

顧客ID

ショップが発行した購入者のアカウントID
部分一致検索も可能です 最大64バイト

acquirer
string <= 1 characters

アクワイアラ

契約先アクワイアラの種類
'1' : WorldPay
'2' : JCB
'3' : Aeon

paymentBrand
string <= 1 characters

カードブランド

取引に使用されたカードブランド
'1' : Visa
'2' : Mastercard
'3' : JCB
'4' : Diners
'5' : Amex

recurringFlag
string <= 1 characters

定期課金フラグ

定期課金取引の指定
'0' : なし
'1' : あり

errorFlag
string <= 1 characters

エラーフラグ

取引ステータスがエラーになっているものの指定
'0' : なし
'1' : あり

page
integer

ページ番号

取得する一覧のページ番号を指定する。指定無しか、1を指定すると1ページ目を検索する。

Responses

Request samples

Content type
application/json
{
  • "orderId": "12345678901234567890123",
  • "paymentTypeStatus": 1,
  • "transactionType": 1,
  • "authDatetimeFrom": 202406010000,
  • "authDatetimeTo": 202406302359,
  • "processingDateFrom": 202406010000,
  • "processingDateTo": 202406302359,
  • "transactionAmountFrom": 1000,
  • "transactionAmountTo": 100000,
  • "memberId": "member12345",
  • "acquirer": 1,
  • "paymentBrand": 1,
  • "recurringFlag": 1,
  • "errorFlag": 1,
  • "page": 0
}

Response samples

Content type
application/json
{
  • "totalPage": 0,
  • "currentPage": 0,
  • "lists": [
    ]
}

決済情報取得

決済処理された取引情報の明細情報を取得します。
POST /api/v1/payment/show

Authorizations:
ApiKeyAuth
Request Body schema: application/json
orderId
string [ 12 .. 23 ] characters

オーダーID

Shop内で一意となるオーダー単位のIDを指定
12桁以上23桁以下で、全て必ず数字としてください
部分一致検索も可能です

Responses

Request samples

Content type
application/json
{
  • "orderId": "12345678901234567890123"
}

Response samples

Content type
application/json
{
  • "lists": [
    ]
}

売上確定

取引情報の売上確定処理を実行します。
POST /api/v1/payment/capture

Authorizations:
ApiKeyAuth
Request Body schema: application/json
object (PaymentCaptureReqRecords)

Responses

Request samples

Content type
application/json
{
  • "records": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "errorCode": 0,
  • "summary": "string",
  • "errors": [ ]
}

キャンセル

取引情報のキャンセル処理を実行します。
POST /api/v1/payment/cancel

Authorizations:
ApiKeyAuth
Request Body schema: application/json
object (PaymentCancelReqRecords)

Responses

Request samples

Content type
application/json
{
  • "records": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "errorCode": 0,
  • "summary": "string",
  • "errors": [ ]
}

recurring

定期課金登録

定期課金登録
POST /api/v1/recurring/register

Authorizations:
ApiKeyAuth
Request Body schema: application/json
recurringOrderId
required
string = 24 characters

定期課金ID

Shop内で一意となる定期課金オーダー単位のIDを指定
24桁固定
先頭12桁は任意の数字で後ろの12桁は必ずゼロ固定としてください

description
string <= 64 characters

定期課金の商品名や品目など

最大64バイト

processes
required
string <= 1 characters

決済処理区分

即時売上か出荷後売上かを指定
'1' : 出荷後売上
'2' : 即時売上

object (Merchant)

加盟店の情報

object (Customer)

支払者の情報

object (Emv)

EMV情報

Responses

Request samples

Content type
application/json
{
  • "recurringOrderId": "123456789012000000000000",
  • "description": "ご購入商品代",
  • "processes": 1,
  • "merchant": {},
  • "customer": {
    },
  • "emvinfo": {
    }
}

Response samples

Content type
application/json
{
  • "uniqueRecurringId": "550e8400e29b41d4a716446655440000",
  • "RecurringOrderId": "123456789012000000000000"
}

定期課金登録ページ

顧客がECサイトの定期請求内容を確認し、'決済ボタン'等を押下する事で、クレジットカードの登録画面に遷移します。
'決済ボタン'の処理として、このAPIをCALLしてください。
このAPIのパラメータには、'recurring/register'APIでレスポンスされた'uniqueRecurringId'を指定してください。
'recurring/register'APIで登録した注文情報と共に、カード情報を入力する為の決済画面が表示されます。
URL /recurring?{uniqueRecurringId}

Authorizations:
ApiKeyAuth
query Parameters
uniqueReccuringId
required
string
Example: uniqueReccuringId=550e8400e29b41d4a716446655440000

'recurring/register'のAPIで取得した定期課金ID

Responses

定期課金カード情報更新ページ

顧客がECサイト内の手続き内容を確認し、'変更するボタン'等を押下する事で、クレジットカードの変更画面に遷移します。
'変更するボタン'の処理として、このAPIをCALLしてください。
このAPIのパラメータには、'recurring/register'APIでレスポンスされた'uniqueRecurringId'を指定してください。
'recurring'APIで登録した元のカード情報と共に、新しいカード情報を入力する為の決済画面が表示されます。
URL /cardupdate?{uniqueRecurringId}

Authorizations:
ApiKeyAuth
query Parameters
uniqueReccuringId
required
string
Example: uniqueReccuringId=550e8400e29b41d4a716446655440000

'recurring/register'のAPIで取得した定期課金ID

Responses

定期課金取引一覧

決済処理された定期課金取引情報の一覧を取得します。
URL /api/v1/recurring/list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
recurringOrderId
string = 24 characters

定期課金ID

Shop内で一意となるオーダー単位の定期課金IDを指定
部分一致検索も可能です

recurringItemNumber
string <= 255 characters

ショップが発行する定期課金請求商品の商品番号など

最大255バイト

memberId
string <= 64 characters

顧客ID

ショップが発行した購入者の顧客ID
部分一致検索も可能です
最大64バイト

paymentTypeStatus
string <= 1 characters

取引状態

'1' : オーソリ
'2' : 売上確定
'3' : 精算
'4' : キャンセル

authorizationResult
string <= 1 characters

オーソリ結果

'1' : OK '2' : NG '3' : 保留

transactionDateFrom
string

取引日時の範囲指定の始値

YYYYMMDDHHMM 形式

transactionDateTo
string

取引日時の範囲指定の終値

YYYYMMDDHHMM 形式

processingDateFrom
string

処理日時の範囲指定の始値

YYYYMMDDHHMM 形式

processingDateTo
string

処理日時の範囲指定の終値

YYYYMMDDHHMM 形式

errorFlag
string <= 1 characters

エラーの有無指定 '0:なし 1:あり 3:指定なし'

page
integer

ページ番号

取得する一覧のページ番号を指定する。指定無しか、1を指定すると1ページ目を検索する。

Responses

Request samples

Content type
application/json
{
  • "recurringOrderId": "123456789012000000000000",
  • "recurringItemNumber": "R-SPL-12345",
  • "memberId": "member12345",
  • "paymentTypeStatus": 1,
  • "authorizationResult": 1,
  • "transactionDateFrom": 202401011200,
  • "transactionDateTo": 202401312359,
  • "processingDateFrom": 202401011200,
  • "processingDateTo": 202401312359,
  • "errorFlag": 1,
  • "page": 0
}

Response samples

Content type
application/json
{
  • "totalPage": 0,
  • "currentPage": 0,
  • "lists": [
    ]
}

定期課金請求

定期課金請求取引データのオーソリ処理を実行します。
URL /api/v1/recurring/auth

Authorizations:
ApiKeyAuth
Request Body schema: application/json
orderId
string [ 12 .. 23 ] characters

オーダーID

Shop内で一意となるオーダー単位のIDを指定
12桁以上23桁以下で、全て必ず数字としてください

recurringOrderId
string = 24 characters

定期課金ID

Shop内で一意となる定期課金オーダー単位のIDを指定
24桁固定
先頭12桁は任意の数字で後ろの12桁は必ずゼロ固定としてください

transactionAmount
integer

取引金額

売上確定する取引の金額
小数点、カンマは指定しないでください

Responses

Request samples

Content type
application/json
{
  • "orderId": "12345678901234567890123",
  • "recurringOrderId": "123456789012000000000000",
  • "transactionAmount": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "errorCode": 0,
  • "summary": "string",
  • "errors": [ ]
}

定期課金請求キャンセル

定期課金請求取引で登録されたカード情報を削除します。
URL /api/v1/recurring/destroy

Authorizations:
ApiKeyAuth
Request Body schema: application/json
recurringOrderId
string = 24 characters

定期課金ID

Shop内で一意となる定期課金オーダー単位のIDを指定
24桁固定
先頭12桁は任意の数字で後ろの12桁は必ずゼロ固定としてください

Responses

Request samples

Content type
application/json
{
  • "recurringOrderId": "123456789012000000000000"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "errorCode": 0,
  • "summary": "string",
  • "errors": [ ]
}

変更履歴

APIリファレンスバージョン

日付 変更の内容 バージョン
2024/2/21 初版 2.0.1
2024/6/21 ・Hosted Fields型決済画面仕様を追加
・定期課金API仕様追加
・決済情報API仕様追加
・売上確定/キャンセル/再オーソリAPI仕様追加		 2.1.1
2024/6/28 ・EMV-3Dセキュアに対応する項目の追加
・定期課金請求登録カード変更画面のJavaScriptに、戻り先URLの要素を追加		 2.1.2
2024/7/11 ・一部の日付項目のサンプルデータについて表記を修正
・一部のパラメータ名修正		 2.1.3
2024/8/14 ・定期課金登録の404レスポンスを削除
・定期課金取引一覧の404レスポンスを削除
・決済情報一覧取得の検索条件のorderIdとmemberIdを部分一致指定に変更
・定期課金取引一覧の検索条件のrecurringOrderIdとmemberIdを部分一致指定に変更		 2.1.4
2024/8/15 ・定期課金請求のリクエストパラメータを変更 2.1.5
2024/9/24 ・再オーソリリクエストAPIを削除 2.1.6
2024/10/1 ・APIのKEYを公開鍵と非公開鍵の2種類に分割
・埋込型決済画面のJavaScript内に設定する鍵を秘密鍵から公開鍵に変更
 2.1.7
2024/10/12 ・テスト環境URLを追加
・レスポンスのエラーメッセージをnumber型からstring型に変更
 2.1.8