Skip to content

Latest commit

 

History

History
85 lines (76 loc) · 5.37 KB

create.md

File metadata and controls

85 lines (76 loc) · 5.37 KB

支払いの作成

メソッド POST
認証 ✅

URL

https://api.coiney.io/api/v1/payments

リクエスト

パラメータ名 説明 型 例 必須 備考
amount 支払い金額 number 100 ✅ 100円以上
currency 通貨 string jpy ✅ 支払いに使う通貨を指定します。ISO 4217に基づいた 3桁の通貨コードを使います。現在はJPYのみ有効です。
locale 表示言語 string ja_JP STORES 請求書決済の表示言語を指定します。言語設定に関して詳しくはこちら。
redirectUrl リダイレクトURL string https://coiney.com/redirect 支払い処理が完了した後に遷移する画面のURLを指定します。指定がない場合は、STORES 請求書決済標準の完了画面に遷移します。
cancelUrl キャンセルURL string https://coiney.com/cancel 支払い処理をキャンセルした際に遷移する画面のURLを指定します。指定がない場合は、支払い画面からキャンセルができません。
webhookUrl Webhook URL string https://coiney.com/webhook Webhook URLを指定します。指定しない場合は、ウェブ管理画面で設定されたURLが使用されます。Webhookに関して、詳しくはこちら。
method 支払い方法 string creditcard ✅ 支払い方法を指定します。現在はcreditcardのみ有効です。
subject 支払いの件名 string スタンダードプラン 支払い画面に表示されます。
description 支払いに関する内部的なメモ string ウェブサイトからの支払い 支払い画面には表示されないので内部的な用途でお使いください。
remarks 支払いの備考 string お支払い期日を過ぎますと自動的にキャンセルとなります。あらかじめご了承ください。 支払い画面に表示されます。
metadata 支払いに関するシステム連携のためのデータ object {"orderId": "1234"} メタデータに関して、詳しくはこちら。
expiredOn 支払い期限 date 2016-08-01 ISO 8601フォーマット。指定がない場合は、デフォルトで3ヶ月が設定されます。

レスポンス

パラメータ名 説明 型 例 備考
id 支払いID string pm_hogehogehogehogehogehogehogehoge
object オブジェクト string payment
mode モード string live 本番環境: live、テスト環境: test
createdAt 支払い作成日 dateTime 2016-08-14T21:57:20+09:00 ISO 8601フォーマット。
amount 支払い金額 number 100
currency 通貨 string jpy
paidAt 支払い日 dateTime 2016-08-14T21:57:20+09:00 ISO 8601フォーマット。
refundedAt 売上取消・返品した日 dateTime 2016-08-14T21:57:20+09:00 ISO 8601フォーマット。
validUntil 支払い期限 dateTime 2016-08-14T21:57:20+09:00 ISO 8601フォーマット。
status 支払いステータス string open 支払いステータスに関して、詳しくはこちら。
subject 支払いの件名 string スタンダードプラン 支払い画面に表示されます。
description 支払いに関する内部的なメモ string ウェブサイトからの支払い 支払い画面には表示されないので内部的な用途でお使いください。
remarks 支払いの備考 string お支払い期日を過ぎますと自動的にキャンセルとなります。あらかじめご了承ください。 支払い画面に表示されます。
metadata 支払いに関するシステム連携のためのデータ object {"orderId": "1234"} メタデータに関して、詳しくはこちら。
links.paymentUrl 支払いページURL string https://payge.co/co_hogehogehogehogehogehogehogehoge
links.redirectUrl リダイレクトURL string https://coiney.com/redirect
links.cancelUrl キャンセルURL string https://coiney.com/cancel
links.webhookUrl Webhook URL string https://coiney.com/webhook
locale 表示言語 string ja_JP STORES 請求書決済の表示言語。言語設定に関して詳しくはこちら。

リクエスト例

curl -X POST https://api.coiney.io/api/v1/payments \
  -H "Authorization: Bearer sk_live_hogehogehogehogehogehogehogehoge" \
  -H "X-CoineyPayge-Version: 2016-10-25" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d $'{
  "amount": 128.00,
  "currency": "jpy",
  "locale": "ja_JP",
  "redirectUrl": "https://coiney.com/redirect",
  "cancelUrl": "https://coiney.com/cancel",
  "webhookUrl": "https://coiney.com/webhook",
  "method": "creditcard",
  "subject": "スタンダードプラン",
  "description": "ウェブサイトからの支払い",
  "remarks": "お支払い期日を過ぎますと自動的にキャンセルとなります。あらかじめご了承ください。",
  "metadata": {
    "orderId": "1234"
  },
  "expiredOn": "2016-09-01"
  }'